Interface FilingProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
FilingManager, FilingProxyManager
public interface FilingProfile extends OsidProfile

The filing profile describes the interoperability among filing services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      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.
      Returns:
      true if federation is visible false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFileSystem

      boolean supportsFileSystem()
      Tests if a FileSystemSession is supported.
      Returns:
      true if a FileSystemSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFileSystemManagement

      boolean supportsFileSystemManagement()
      Tests if a FileSystemManagementSession is supported.
      Returns:
      true if a FileSystemManagementSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFileContent

      boolean supportsFileContent()
      Tests if a FileContentSession is supported.
      Returns:
      true if a FileContentSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFileLookup

      boolean supportsFileLookup()
      Tests if file lookup is supported.
      Returns:
      true if a FileLookupSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFileQuery

      boolean supportsFileQuery()
      Tests if file querying is supported.
      Returns:
      true if a FileQuerySession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFileSearch

      boolean supportsFileSearch()
      Tests if file searching is supported.
      Returns:
      true if a FileSearchSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFileNotification

      boolean supportsFileNotification()
      Tests if file notification is supported.
      Returns:
      true if a FileNotificationSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFileSmartDirectory

      boolean supportsFileSmartDirectory()
      Tests if managing smart directories is supported.
      Returns:
      true if a FileSmartDirectorySession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectoryLookup

      boolean supportsDirectoryLookup()
      Tests if a DirectoryLookupSession is supported.
      Returns:
      true if a DirectoryLookupSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectoryQuery

      boolean supportsDirectoryQuery()
      Tests if directory querying is supported.
      Returns:
      true if a DirectoryQuerySession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectorySearch

      boolean supportsDirectorySearch()
      Tests if directory searching is supported.
      Returns:
      true if a DirectorySearchSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectoryAdmin

      boolean supportsDirectoryAdmin()
      Tests if directory administration is supported.
      Returns:
      true if a DirectoryAdminSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectoryNotification

      boolean supportsDirectoryNotification()
      Tests if a directory notification service is supported.
      Returns:
      true if a DirectoryNotificationSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFilingManagement

      boolean supportsFilingManagement()
      Tests if a file management service is supported.
      Returns:
      true if a FileManagementSession is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFilingAllocation

      boolean supportsFilingAllocation()
      Tests if a filing allocation service is supported.
      Returns:
      true if a FilingAllocationManager is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getFileRecordTypes

      TypeList getFileRecordTypes()
      Gets the supported file record types.
      Returns:
      a list containing the supported File record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsFileRecordType

      boolean supportsFileRecordType(Type fileRecordType)
      Tests if the given file record type is supported.
      Parameters:
      fileRecordType - a Type indicating a file record type
      Returns:
      true if the given record Type is supported, false otherwise
      Throws:
      NullArgumentException - fileRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getFileSearchRecordTypes

      TypeList getFileSearchRecordTypes()
      Gets the supported file search record types.
      Returns:
      a list containing the supported File search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsFileSearchRecordType

      boolean supportsFileSearchRecordType(Type fileSearchRecordType)
      Tests if the given file search record type is supported.
      Parameters:
      fileSearchRecordType - a Type indicating a file search record type
      Returns:
      true if the given search record Type is supported, false otherwise
      Throws:
      NullArgumentException - fileSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getDirectoryRecordTypes

      TypeList getDirectoryRecordTypes()
      Gets the supported directory record types.
      Returns:
      a list containing the supported Directory record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectoryRecordType

      boolean supportsDirectoryRecordType(Type directoryRecordType)
      Tests if the given directory record type is supported.
      Parameters:
      directoryRecordType - a Type indicating a directory record type
      Returns:
      true if the given record Type is supported, false otherwise
      Throws:
      NullArgumentException - directoryRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getDirectorySearchRecordTypes

      TypeList getDirectorySearchRecordTypes()
      Gets the supported directory search record types.
      Returns:
      a list containing the supported Directory search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsDirectorySearchRecordType

      boolean supportsDirectorySearchRecordType(Type directorySearchRecordType)
      Tests if the given directory search record type is supported.
      Parameters:
      directorySearchRecordType - a Type indicating a directory search record type
      Returns:
      true if the given search record Type is supported, false otherwise
      Throws:
      NullArgumentException - directorySearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.