Interface DictionaryProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
DictionaryManager, DictionaryProxyManager
public interface DictionaryProfile extends OsidProfile

The DictionaryProfile describes the interoperability among dictionary services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any dictionary federation is exposed. Federation is exposed when a specific dictionary may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of dictionaries appears as a single dictionary.
      Returns:
      true if federation is visible false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryRetrieval

      boolean supportsEntryRetrieval()
      Tests if retrieving dictionary entries are supported.
      Returns:
      true if entry retrieval is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryLookup

      boolean supportsEntryLookup()
      Tests if looking up dictionary entries are supported.
      Returns:
      true if entry lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryQuery

      boolean supportsEntryQuery()
      Tests if querying dictionary entries are supported.
      Returns:
      true if entry query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntrySearch

      boolean supportsEntrySearch()
      Tests if searching dictionary entries are supported.
      Returns:
      true if entry search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryAdmin

      boolean supportsEntryAdmin()
      Tests if a dictionary entry administrative service is supported.
      Returns:
      true if dictionary entry administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryNotification

      boolean supportsEntryNotification()
      Tests if a dictionary entry notification service is supported.
      Returns:
      true if dictionary entry notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryDictionary

      boolean supportsEntryDictionary()
      Tests if retrieving mappings of entry and dictionarys is supported.
      Returns:
      true if entry dictionary mapping retrieval is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryDictionaryAssignment

      boolean supportsEntryDictionaryAssignment()
      Tests if managing mappings of entry and dictionarys is supported.
      Returns:
      true if entry dictionary assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntrySmartDictionary

      boolean supportsEntrySmartDictionary()
      Tests if entry smart dictionarys are available.
      Returns:
      true if entry smart dictionarys are supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDictionaryLookup

      boolean supportsDictionaryLookup()
      Tests if a dictionary lookup service is supported.
      Returns:
      true if dictionary lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDictionaryQuery

      boolean supportsDictionaryQuery()
      Tests if a dictionary query service is supported.
      Returns:
      true if dictionary query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDictionarySearch

      boolean supportsDictionarySearch()
      Tests if a dictionary search service is supported.
      Returns:
      true if dictionary search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDictionaryAdmin

      boolean supportsDictionaryAdmin()
      Tests if a dictionary administrative service is supported.
      Returns:
      true if dictionary administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDictionaryNotification

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

    • supportsDictionaryHierachyTraversal

      boolean supportsDictionaryHierachyTraversal()
      Tests if a dictionary hierarchy traversal service is supported.
      Returns:
      true if dictionary hierarchy traversal is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDictionaryHierachyDesign

      boolean supportsDictionaryHierachyDesign()
      Tests if a dictionary hierarchy design service is supported.
      Returns:
      true if dictionary hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsDictionaryBatch

      boolean supportsDictionaryBatch()
      Tests if a dictionary batch service is supported.
      Returns:
      true if dictionary batch service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEntryKeyTypes

      TypeList getEntryKeyTypes()
      Gets the supported Entry key types.
      Returns:
      a list containing the supported Entry key types
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryKeyType

      boolean supportsEntryKeyType(Type entryKeyType)
      Tests if the given Entry key type is supported.
      Parameters:
      entryKeyType - a Type indicating an Entry key type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - entryKeyType is null
      Compliance:
      mandatory - This method must be implemented.

    • getEntryValueTypes

      TypeList getEntryValueTypes()
      Gets the supported Entry value types.
      Returns:
      a list containing the supported Entry value types
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryValueType

      boolean supportsEntryValueType(Type entryValueType)
      Tests if the given Entry value type is supported.
      Parameters:
      entryValueType - a Type indicating an Entry value type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - entryRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getEntryValueTypesForKeyType

      TypeList getEntryValueTypesForKeyType(Type entryKeyType)
      Gets the list of value types supported for the given key type.
      Parameters:
      entryKeyType - a Type indicating an Entry key type
      Returns:
      a list of value types
      Throws:
      NullArgumentException - entryKeyType is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsEntryTypes

      boolean supportsEntryTypes(Type entryKeyType, Type entryValueType)
      Tests if the given Entry key and value types are supported.
      Parameters:
      entryKeyType - a Type indicating an Entry key type
      entryValueType - a Type indicating an Entry value type
      Returns:
      true if the given Types are supported, false otherwise
      Throws:
      NullArgumentException - entryKeyType or entryValueType is null
      Compliance:
      mandatory - This method must be implemented.

    • getEntryRecordTypes

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

    • supportsEntryRecordType

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

    • getEntrySearchRecordTypes

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

    • supportsEntrySearchRecordType

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

    • getDictionaryRecordTypes

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

    • supportsDictionaryRecordType

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

    • getDictionarySearchRecordTypes

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

    • supportsDictionarySearchRecordType

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