org.apache.james.imapserver
Interface RecordRepository

All Known Implementing Classes:
DefaultRecordRepository

public interface RecordRepository

Interface for objects representing a Repository of FolderRecords. There should be a RecordRepository for every Host.

Note that there is no method for removing Records: an IMAP host is meant to retain information about deleted folders.

Version:
0.1 on 14 Dec 2000
Author:
Charles Benett
See Also:
FolderRecord

Field Summary
static java.lang.String RECORD
           
 
Method Summary
 boolean containsRecord(java.lang.String folderAbsoluteName)
          Tests if there is a folder record for the given folder name.
 java.util.Iterator getAbsoluteNames()
          Returns Iterator over names of folders in repository
 FolderRecord retrieve(java.lang.String folderAbsoluteName)
          Retrieves a folder record given the folder's full name.
 void setPath(java.lang.String rootPath)
          Sets the location of this repository.
 void store(FolderRecord fr)
          Stores a folder record in this repository.
 

Field Detail

RECORD

public static final java.lang.String RECORD
Method Detail

setPath

public void setPath(java.lang.String rootPath)
Sets the location of this repository.
Parameters:
rootPath - String location of this repository

store

public void store(FolderRecord fr)
Stores a folder record in this repository.
Parameters:
fr - FolderRecord to be stored

getAbsoluteNames

public java.util.Iterator getAbsoluteNames()
Returns Iterator over names of folders in repository

retrieve

public FolderRecord retrieve(java.lang.String folderAbsoluteName)
Retrieves a folder record given the folder's full name.
Parameters:
folderAbsoluteName - String name of a folder

containsRecord

public boolean containsRecord(java.lang.String folderAbsoluteName)
Tests if there is a folder record for the given folder name.
Parameters:
folderAbsoluteName - String name of a folder


Copyright © 2001 Apache Jakarta Project. All Rights Reserved.