Interface | osid.filing.FilingProfile | ||
---|---|---|---|
Implements | osid.OsidProfile | ||
Description |
The filing profile describes the interoperability among filing services. | ||
Method | supportsVisibleFederation | ||
Description |
Tests if directory federation is exposed. Federation is exposed when a specific directory may be identified, selected and used to access a session. Federation is not exposed when a set of directories appears as a single directory. | ||
Return | boolean | true if federation is visible false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFileSystem | ||
Description |
Tests if a | ||
Return | boolean | true if a FileSystemSession is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFileSystemManagement | ||
Description |
Tests if a | ||
Return | boolean | true if a FileSystemManagementSession is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFileContent | ||
Description |
Tests if a | ||
Return | boolean | true if a FileContentSession is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFileLookup | ||
Description |
Tests if file lookup is supported. | ||
Return | boolean | true if a FileLookupSession is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFileQuery | ||
Description |
Tests if file querying is supported. | ||
Return | boolean | true if a FileQuerySession is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFileSearch | ||
Description |
Tests if file searching is supported. | ||
Return | boolean | true if a FileSearchSession is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFileNotification | ||
Description |
Tests if file notification is supported. | ||
Return | boolean | true if a FileNotificationSession is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFileSmartDirectory | ||
Description |
Tests if managing smart directories is supported. | ||
Return | boolean | true if a FileSmartDirectorySession is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectoryLookup | ||
Description |
Tests if a | ||
Return | boolean | true if a DirectoryLookupSession is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectoryQuery | ||
Description |
Tests if directory querying is supported. | ||
Return | boolean | true if a DirectoryQuerySession is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectorySearch | ||
Description |
Tests if directory searching is supported. | ||
Return | boolean | true if a DirectorySearchSession is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectoryAdmin | ||
Description |
Tests if directory administration is supported. | ||
Return | boolean | true if a DirectoryAdminSession is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectoryNotification | ||
Description |
Tests if a directory | ||
Return | boolean | true if a DirectoryNotificationSession is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFilingManagement | ||
Description |
Tests if a file management service is supported. | ||
Return | boolean | true if a FileManagementSession is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFilingAllocation | ||
Description |
Tests if a filing allocation service is supported. | ||
Return | boolean | true if a FilingAllocationManager is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFileRecordTypes | ||
Description |
Gets the supported file record types. | ||
Return | osid.type.TypeList | a list containing the supported File record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFileRecordType | ||
Description |
Tests if the given file record type is supported. | ||
Parameters | osid.type.Type | fileRecordType | a Type indicating a file record type |
Return | boolean | true if the given record Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | fileRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getFileSearchRecordTypes | ||
Description |
Gets the supported file search record types. | ||
Return | osid.type.TypeList | a list containing the supported File search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsFileSearchRecordType | ||
Description |
Tests if the given file search record type is supported. | ||
Parameters | osid.type.Type | fileSearchRecordType | a Type indicating a file search record type |
Return | boolean | true if the given search record Type is
supported, false otherwise | |
Errors | NULL_ARGUMENT | fileSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectoryRecordTypes | ||
Description |
Gets the supported directory record types. | ||
Return | osid.type.TypeList | a list containing the supported Directory record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectoryRecordType | ||
Description |
Tests if the given directory record type is supported. | ||
Parameters | osid.type.Type | directoryRecordType | a Type indicating a directory record type |
Return | boolean | true if the given record Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | directoryRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectorySearchRecordTypes | ||
Description |
Gets the supported directory search record types. | ||
Return | osid.type.TypeList | a list containing the supported Directory search record
types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsDirectorySearchRecordType | ||
Description |
Tests if the given directory search record type is supported. | ||
Parameters | osid.type.Type | directorySearchRecordType | a Type indicating a directory search record type |
Return | boolean | true if the given search record Type is
supported, false otherwise | |
Errors | NULL_ARGUMENT | directorySearchRecordType is null | |
Compliance | mandatory | This method must be implemented. |