OSID Logo
OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.FilingProfile
Implementsosid.OsidProfile
Description

The filing profile describes the interoperability among filing services.

MethodsupportsVisibleFederation
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.

Returnboolean true if federation is visible false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFileSystem
Description

Tests if a FileSystemSession is supported.

Returnboolean true if a FileSystemSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFileSystemManagement
Description

Tests if a FileSystemManagementSession is supported.

Returnboolean true if a FileSystemManagementSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFileContent
Description

Tests if a FileContentSession is supported.

Returnboolean true if a FileContentSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFileLookup
Description

Tests if file lookup is supported.

Returnboolean true if a FileLookupSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFileQuery
Description

Tests if file querying is supported.

Returnboolean true if a FileQuerySession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFileSearch
Description

Tests if file searching is supported.

Returnboolean true if a FileSearchSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFileNotification
Description

Tests if file notification is supported.

Returnboolean true if a FileNotificationSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFileSmartDirectory
Description

Tests if managing smart directories is supported.

Returnboolean true if a FileSmartDirectorySession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectoryLookup
Description

Tests if a DirectoryLookupSession is supported.

Returnboolean true if a DirectoryLookupSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectoryQuery
Description

Tests if directory querying is supported.

Returnboolean true if a DirectoryQuerySession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectorySearch
Description

Tests if directory searching is supported.

Returnboolean true if a DirectorySearchSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectoryAdmin
Description

Tests if directory administration is supported.

Returnboolean true if a DirectoryAdminSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectoryNotification
Description

Tests if a directory notification service is supported.

Returnboolean true if a DirectoryNotificationSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFilingManagement
Description

Tests if a file management service is supported.

Returnboolean true if a FileManagementSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFilingAllocation
Description

Tests if a filing allocation service is supported.

Returnboolean true if a FilingAllocationManager is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFileRecordTypes
Description

Gets the supported file record types.

Returnosid.type.TypeLista list containing the supported File record types
CompliancemandatoryThis method must be implemented.
MethodsupportsFileRecordType
Description

Tests if the given file record type is supported.

Parametersosid.type.TypefileRecordTypea Type indicating a file record type
Returnboolean true if the given record Type is supported, false otherwise
ErrorsNULL_ARGUMENT fileRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetFileSearchRecordTypes
Description

Gets the supported file search record types.

Returnosid.type.TypeLista list containing the supported File search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsFileSearchRecordType
Description

Tests if the given file search record type is supported.

Parametersosid.type.TypefileSearchRecordTypea Type indicating a file search record type
Returnboolean true if the given search record Type is supported, false otherwise
ErrorsNULL_ARGUMENT fileSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetDirectoryRecordTypes
Description

Gets the supported directory record types.

Returnosid.type.TypeLista list containing the supported Directory record types
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectoryRecordType
Description

Tests if the given directory record type is supported.

Parametersosid.type.TypedirectoryRecordTypea Type indicating a directory record type
Returnboolean true if the given record Type is supported, false otherwise
ErrorsNULL_ARGUMENT directoryRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetDirectorySearchRecordTypes
Description

Gets the supported directory search record types.

Returnosid.type.TypeLista list containing the supported Directory search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsDirectorySearchRecordType
Description

Tests if the given directory search record type is supported.

Parametersosid.type.TypedirectorySearchRecordTypea Type indicating a directory search record type
Returnboolean true if the given search record Type is supported, false otherwise
ErrorsNULL_ARGUMENT directorySearchRecordType is null
CompliancemandatoryThis method must be implemented.