Interface FilingManager

All Superinterfaces:

AutoCloseable, Closeable, FilingProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface FilingManager
extends OsidManager, FilingProfile

The filing manager provides access sessions to retrieve and manage files and directories. Some of the federated access methods support pathnames in addition to directory Ids . The sessions included in this manager are:

• FileSystemSession : a session for traversing file systems
• FileSystemManagementSession : a session for performing operations across directories
• FileContentSession : a basic session for reading and writing a file
• FileLookupSession: a session for looking up files
• FileQuerySession : a session for searching for files
• FileSearchSession : a session for searching for files
• FileNotificationSession : a session for subscribing to changes in files
• FileSmartDirectorySession : a session for managing smart directories of files
• DirectoryLookupSession : a session for looking up a directories
• DirectorQuerySession : a session for searching for directories
• DirectorySearchSession : a session for searching for directories
• DirectoryNotificationSession : a session for subscribing to changes in directories

Method Summary

Modifier and Type	Method	Description
DirectoryAdminSession	getDirectoryAdminSession()	Gets the session for creating and removing files.
DirectoryAdminSession	getDirectoryAdminSessionForDirectory(Id directoryId)	Gets the session for searching for creating and removing files in the given directory.
DirectoryLookupSession	getDirectoryLookupSession()	Gets the session for examining directories.
DirectoryLookupSession	getDirectoryLookupSessionForDirectory(Id directoryId)	Gets the session for examining a given directory.
DirectoryNotificationSession	getDirectoryNotificationSession(DirectoryReceiver directoryReceiver)	Gets the session for receiving messages about changes to directories.
DirectoryNotificationSession	getDirectoryNotificationSessionForDirectory(DirectoryReceiver directoryReceiver, Id directoryId)	Gets the session for receiving messages about changes to directories in the given directory.
DirectoryQuerySession	getDirectoryQuerySession()	Gets the session for querying directories.
DirectoryQuerySession	getDirectoryQuerySessionForDirectory(Id directoryId)	Gets the session for querying directories within a given directory.
DirectorySearchSession	getDirectorySearchSession()	Gets the session for searching for directories.
DirectorySearchSession	getDirectorySearchSessionForDirectory(Id directoryId)	Gets the session for searching for directories within a given directory.
FileContentSession	getFileContentSession()	Gets the session for reading and writing files.
FileContentSession	getFileContentSessionForDirectory(Id directoryId)	Gets the session for reading and writing files for the given path.
FileContentSession	getFileContentSessionForPath(String path)	Gets the session for reading and writing files for the given path.
FileLookupSession	getFileLookupSession()	Gets the session for looking up files.
FileLookupSession	getFileLookupSessionForDirectory(Id directoryId)	Gets the session for manipulating files for the given path.
FileNotificationSession	getFileNotificationSession(FileReceiver fileReceiver)	Gets the session for receiving messages about changes to files.
FileNotificationSession	getFileNotificationSessionForDirectory(FileReceiver fileReceiver, Id directoryId)	Gets a file notification session for the specified directory.
FileQuerySession	getFileQuerySession()	Gets the session for querying files.
FileQuerySession	getFileQuerySessionForDirectory(Id directoryId)	Gets a file query session for the specified directory.
FileSearchSession	getFileSearchSession()	Gets the session for searching for files.
FileSearchSession	getFileSearchSessionForDirectory(Id directoryId)	Gets a file search session for the specified directory.
FileSmartDirectorySession	getFileSmartDirectorySession(Id directoryId)	Gets the session for managing dynamic directories.
FileSystemManagementSession	getFileSystemManagementSession()	Gets the session for manipulating file systems.
FileSystemManagementSession	getFileSystemManagementSessionForDirectory(Id directoryId)	Gets the session for manipulating files for the given path.
FileSystemManagementSession	getFileSystemManagementSessionForPath(String path)	Gets the session for manipulating files for the given path.
FileSystemSession	getFileSystemSession()	Gets the session for examining file systems.
FileSystemSession	getFileSystemSessionForDirectory(Id directoryId)	Gets the session for exmaning file systems for the given directory.
FileSystemSession	getFileSystemSessionForPath(String path)	Gets the session for exmaning file systems for the given path.
FilingAllocationManager	getFilingAllocationManager()	Gets the FilingAllocationManager .

Methods inherited from interface Closeable

close

Methods inherited from interface FilingProfile

getDirectoryRecordTypes, getDirectorySearchRecordTypes, getFileRecordTypes, getFileSearchRecordTypes, supportsDirectoryAdmin, supportsDirectoryLookup, supportsDirectoryNotification, supportsDirectoryQuery, supportsDirectoryRecordType, supportsDirectorySearch, supportsDirectorySearchRecordType, supportsFileContent, supportsFileLookup, supportsFileNotification, supportsFileQuery, supportsFileRecordType, supportsFileSearch, supportsFileSearchRecordType, supportsFileSmartDirectory, supportsFileSystem, supportsFileSystemManagement, supportsFilingAllocation, supportsFilingManagement, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getDirectoryRecordTypes()	Gets the supported directory record types.
TypeList	getDirectorySearchRecordTypes()	Gets the supported directory search record types.
TypeList	getFileRecordTypes()	Gets the supported file record types.
TypeList	getFileSearchRecordTypes()	Gets the supported file search record types.
boolean	supportsDirectoryAdmin()	Tests if directory administration is supported.
boolean	supportsDirectoryLookup()	Tests if a DirectoryLookupSession is supported.
boolean	supportsDirectoryNotification()	Tests if a directory notification service is supported.
boolean	supportsDirectoryQuery()	Tests if directory querying is supported.
boolean	supportsDirectoryRecordType(Type directoryRecordType)	Tests if the given directory record type is supported.
boolean	supportsDirectorySearch()	Tests if directory searching is supported.
boolean	supportsDirectorySearchRecordType(Type directorySearchRecordType)	Tests if the given directory search record type is supported.
boolean	supportsFileContent()	Tests if a FileContentSession is supported.
boolean	supportsFileLookup()	Tests if file lookup is supported.
boolean	supportsFileNotification()	Tests if file notification is supported.
boolean	supportsFileQuery()	Tests if file querying is supported.
boolean	supportsFileRecordType(Type fileRecordType)	Tests if the given file record type is supported.
boolean	supportsFileSearch()	Tests if file searching is supported.
boolean	supportsFileSearchRecordType(Type fileSearchRecordType)	Tests if the given file search record type is supported.
boolean	supportsFileSmartDirectory()	Tests if managing smart directories is supported.
boolean	supportsFileSystem()	Tests if a FileSystemSession is supported.
boolean	supportsFileSystemManagement()	Tests if a FileSystemManagementSession is supported.
boolean	supportsFilingAllocation()	Tests if a filing allocation service is supported.
boolean	supportsFilingManagement()	Tests if a file management service is supported.
boolean	supportsVisibleFederation()	Tests if directory federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getFileSystemSession

FileSystemSession getFileSystemSession()
                                throws OperationFailedException

Gets the session for examining file systems.

Returns:

a FileSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsFileSystem()} is {@code true} .

getFileSystemSessionForPath

FileSystemSession getFileSystemSessionForPath(String path)
                                       throws NotFoundException,
OperationFailedException

Gets the session for exmaning file systems for the given path.

Parameters:

path - the path to a directory

Returns:

a FileSystemSession

Throws:

NotFoundException - path is not found or is not a directory

NullArgumentException - path is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsFileSystem()} and {@code supportsVisibleFederation()} are {@code true} .

getFileSystemSessionForDirectory

FileSystemSession getFileSystemSessionForDirectory(Id directoryId)
                                            throws NotFoundException,
OperationFailedException

Gets the session for exmaning file systems for the given directory.

Parameters:

directoryId - the Id of a directory

Returns:

a FileSystemSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystem() is false

Compliance:

optional - This method must be implemented if {@code supportsFileSystem()} and {@code supportsVisibleFederation()} are {@code true} .

getFileSystemManagementSession

FileSystemManagementSession getFileSystemManagementSession()
                                                    throws OperationFailedException

Gets the session for manipulating file systems.

Returns:

a FileSystemManagementSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystemManagement() is false

Compliance:

optional - This method must be implemented if {@code supportsFileSystemManagement()} is {@code true} .

getFileSystemManagementSessionForPath

FileSystemManagementSession getFileSystemManagementSessionForPath(String path)
                                                           throws NotFoundException,
OperationFailedException

Gets the session for manipulating files for the given path.

Parameters:

path - the path to a directory

Returns:

a FileSystemManagementSession

Throws:

NotFoundException - path is not found or is not a directory

NullArgumentException - path is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystemManagement() is false

Compliance:

optional - This method must be implemented if {@code supportsFileSystemManagement()} and {@code supportsVisibleFederation()} are {@code true} .

getFileSystemManagementSessionForDirectory

FileSystemManagementSession getFileSystemManagementSessionForDirectory(Id directoryId)
                                                                throws NotFoundException,
OperationFailedException

Gets the session for manipulating files for the given path.

Parameters:

directoryId - the Id of a directory

Returns:

a FileSystemManagementSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSystemManagement() is false

Compliance:

optional - This method must be implemented if {@code supportsFileSystemManagement()} and {@code supportsVisibleFederation()} are {@code true} .

getFileContentSession

FileContentSession getFileContentSession()
                                  throws OperationFailedException

Gets the session for reading and writing files.

Returns:

a FileContentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFileContent() is false

Compliance:

optional - This method must be implemented if {@code supportsFileContent()} is {@code true} .

getFileContentSessionForPath

FileContentSession getFileContentSessionForPath(String path)
                                         throws NotFoundException,
OperationFailedException

Gets the session for reading and writing files for the given path.

Parameters:

path - the path to a directory

Returns:

a FileContentSession

Throws:

NotFoundException - path is not found or is not a directory

NullArgumentException - path is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileContent() is false

Compliance:

optional - This method must be implemented if {@code supportsFileContent()} and {@code supportsVisibleFederation()} are {@code true} .

getFileContentSessionForDirectory

FileContentSession getFileContentSessionForDirectory(Id directoryId)
                                              throws NotFoundException,
OperationFailedException

Gets the session for reading and writing files for the given path.

Parameters:

directoryId - the Id of a directory

Returns:

a FileContentSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileContent() is false

Compliance:

optional - This method must be implemented if {@code supportsFileContent()} and {@code supportsVisibleFederation()} are {@code true} .

getFileLookupSession

FileLookupSession getFileLookupSession()
                                throws OperationFailedException

Gets the session for looking up files.

Returns:

the FileLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFileLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsFileLookup()} is {@code true} .

getFileLookupSessionForDirectory

FileLookupSession getFileLookupSessionForDirectory(Id directoryId)
                                            throws NotFoundException,
OperationFailedException

Gets the session for manipulating files for the given path.

Parameters:

directoryId - the Id of the directory

Returns:

a FileLookupSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsFileLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getFileQuerySession

FileQuerySession getFileQuerySession()
                              throws OperationFailedException

Gets the session for querying files.

Returns:

the FileQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFileQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsFileQuery()} is {@code true} .

getFileQuerySessionForDirectory

FileQuerySession getFileQuerySessionForDirectory(Id directoryId)
                                          throws NotFoundException,
OperationFailedException

Gets a file query session for the specified directory.

Parameters:

directoryId - the Id of the directory

Returns:

a FileQuerySession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsFileQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getFileSearchSession

FileSearchSession getFileSearchSession()
                                throws OperationFailedException

Gets the session for searching for files.

Returns:

the FileSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsFileSearch()} is {@code true} .

getFileSearchSessionForDirectory

FileSearchSession getFileSearchSessionForDirectory(Id directoryId)
                                            throws NotFoundException,
OperationFailedException

Gets a file search session for the specified directory.

Parameters:

directoryId - the Id of the directory

Returns:

a FileSearchSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsFileSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getFileNotificationSession

FileNotificationSession getFileNotificationSession(FileReceiver fileReceiver)
                                            throws OperationFailedException

Gets the session for receiving messages about changes to files.

Parameters:

fileReceiver - the notification callback

Returns:

a FileNotificationSession

Throws:

NullArgumentException - fileReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsFileNotification()} is {@code true} .

getFileNotificationSessionForDirectory

FileNotificationSession getFileNotificationSessionForDirectory(FileReceiver fileReceiver,
 Id directoryId)
                                                        throws NotFoundException,
OperationFailedException

Gets a file notification session for the specified directory.

Parameters:

fileReceiver - the notification callback

directoryId - the Id of the directory

Returns:

a FileNotificationSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - fileReceiver or directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsFileNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getFileSmartDirectorySession

FileSmartDirectorySession getFileSmartDirectorySession(Id directoryId)
                                                throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic directories.

Parameters:

directoryId - the Id of the directory

Returns:

a FileSmartDirectorySession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFileSmartDirectory() is false

Compliance:

optional - This method must be implemented if {@code supportsFileSmartDirectory()} and {@code supportsVisibleFederation()} are {@code true} .

getDirectoryLookupSession

DirectoryLookupSession getDirectoryLookupSession()
                                          throws OperationFailedException

Gets the session for examining directories.

Returns:

a DirectoryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectoryLookup()} is {@code true} .

getDirectoryLookupSessionForDirectory

DirectoryLookupSession getDirectoryLookupSessionForDirectory(Id directoryId)
                                                      throws NotFoundException,
OperationFailedException

Gets the session for examining a given directory.

Parameters:

directoryId - the Id of the directory

Returns:

a DirectoryLookupSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectoryLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getDirectoryQuerySession

DirectoryQuerySession getDirectoryQuerySession()
                                        throws OperationFailedException

Gets the session for querying directories.

Returns:

a DirectoryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectoryQuery()} is {@code true} .

getDirectoryQuerySessionForDirectory

DirectoryQuerySession getDirectoryQuerySessionForDirectory(Id directoryId)
                                                    throws NotFoundException,
OperationFailedException

Gets the session for querying directories within a given directory.

Parameters:

directoryId - the Id of the directory

Returns:

a DirectoryQuerySession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectoryQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getDirectorySearchSession

DirectorySearchSession getDirectorySearchSession()
                                          throws OperationFailedException

Gets the session for searching for directories.

Returns:

a DirectorySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectorySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectorySearch()} is {@code true} .

getDirectorySearchSessionForDirectory

DirectorySearchSession getDirectorySearchSessionForDirectory(Id directoryId)
                                                      throws NotFoundException,
OperationFailedException

Gets the session for searching for directories within a given directory.

Parameters:

directoryId - the Id of the directory

Returns:

a DirectorySearchSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectorySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectorySearch()} and {@code supportsVisibleFederation()} are {@code true} .

getDirectoryAdminSession

DirectoryAdminSession getDirectoryAdminSession()
                                        throws OperationFailedException

Gets the session for creating and removing files.

Returns:

a DirectoryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectoryAdmin()} is {@code true} .

getDirectoryAdminSessionForDirectory

DirectoryAdminSession getDirectoryAdminSessionForDirectory(Id directoryId)
                                                    throws NotFoundException,
OperationFailedException

Gets the session for searching for creating and removing files in the given directory.

Parameters:

directoryId - the Id of the directory

Returns:

a DirectoryAdminSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectoryAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getDirectoryNotificationSession

DirectoryNotificationSession getDirectoryNotificationSession(DirectoryReceiver directoryReceiver)
                                                      throws OperationFailedException

Gets the session for receiving messages about changes to directories.

Parameters:

directoryReceiver - the notification callback

Returns:

a DirectoryNotificationSession

Throws:

NullArgumentException - directoryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectoryNotification()} is {@code true} .

getDirectoryNotificationSessionForDirectory

DirectoryNotificationSession getDirectoryNotificationSessionForDirectory(DirectoryReceiver directoryReceiver,
 Id directoryId)
                                                                  throws NotFoundException,
OperationFailedException

Gets the session for receiving messages about changes to directories in the given directory.

Parameters:

directoryReceiver - the notification callback

directoryId - the Id of the directory

Returns:

a DirectoryNotificationSession

Throws:

NotFoundException - directoryId is not found

NullArgumentException - directoryReceiver or directoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDirectoryNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectoryNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getFilingAllocationManager

FilingAllocationManager getFilingAllocationManager()
                                            throws OperationFailedException

Gets the FilingAllocationManager .

Returns:

a FilingAllocationManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFilingAllocation() is false

Compliance:

optional - This method must be implemented if {@code supportsFilingAllocation()} is {@code true} .