org.osid.filing

Interface FilingManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, FilingProfile, 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

Methods

Modifier and Type	Method and 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(java.lang.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(java.lang.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(java.lang.String path) Gets the session for exmaning file systems for the given path.
FilingAllocationManager	getFilingAllocationManager() Gets the FilingAllocationManager.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.filing.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsFileSystem() is true.

getFileSystemSessionForPath

FileSystemSession getFileSystemSessionForPath(java.lang.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 supportsFileSystem() and supportsVisibleFederation() are 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 supportsFileSystem() and supportsVisibleFederation() are 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 supportsFileSystemManagement() is true.

getFileSystemManagementSessionForPath

FileSystemManagementSession getFileSystemManagementSessionForPath(java.lang.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 supportsFileSystemManagement() and supportsVisibleFederation() are 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 supportsFileSystemManagement() and supportsVisibleFederation() are 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 supportsFileContent() is true.

getFileContentSessionForPath

FileContentSession getFileContentSessionForPath(java.lang.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 supportsFileContent() and supportsVisibleFederation() are 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 supportsFileContent() and supportsVisibleFederation() are 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 supportsFileLookup() is 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 supportsFileLookup() and supportsVisibleFederation() are 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 supportsFileQuery() is 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 supportsFileQuery() and supportsVisibleFederation() are 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 supportsFileSearch() is 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 supportsFileSearch() and supportsVisibleFederation() are 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 supportsFileNotification() is 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 supportsFileNotification() and supportsVisibleFederation() are 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 supportsFileSmartDirectory() and supportsVisibleFederation() are 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 supportsDirectoryLookup() is 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 supportsDirectoryLookup() and supportsVisibleFederation() are 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 supportsDirectoryQuery() is 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 supportsDirectoryQuery() and supportsVisibleFederation() are 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 supportsDirectorySearch() is 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 supportsDirectorySearch() and supportsVisibleFederation() are 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 supportsDirectoryAdmin() is 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 supportsDirectoryAdmin() and supportsVisibleFederation() are 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 supportsDirectoryNotification() is 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 supportsDirectoryNotification() and supportsVisibleFederation() are 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 supportsFilingAllocation() is true.