OSID - osid.dictionary.DictionaryProfile Service Interface Definition

Interface	osid.dictionary.DictionaryProfile
Implements	`osid.OsidProfile`
Description	The `DictionaryProfile` describes the interoperability among dictionary services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if federation is visible `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryRetrieval
Description	Tests if retrieving dictionary entries are supported.
Return	`boolean`		`true` if entry retrieval is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryLookup
Description	Tests if looking up dictionary entries are supported.
Return	`boolean`		`true` if entry lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryQuery
Description	Tests if querying dictionary entries are supported.
Return	`boolean`		`true` if entry query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntrySearch
Description	Tests if searching dictionary entries are supported.
Return	`boolean`		`true` if entry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryAdmin
Description	Tests if a dictionary entry administrative service is supported.
Return	`boolean`		`true` if dictionary entry administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryNotification
Description	Tests if a dictionary entry notification service is supported.
Return	`boolean`		`true` if dictionary entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryDictionary
Description	Tests if retrieving mappings of entry and dictionarys is supported.
Return	`boolean`		`true` if entry dictionary mapping retrieval is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryDictionaryAssignment
Description	Tests if managing mappings of entry and dictionarys is supported.
Return	`boolean`		`true` if entry dictionary assignment is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntrySmartDictionary
Description	Tests if entry smart dictionarys are available.
Return	`boolean`		`true` if entry smart dictionarys are supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionaryLookup
Description	Tests if a dictionary lookup service is supported.
Return	`boolean`		`true` if dictionary lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionaryQuery
Description	Tests if a dictionary query service is supported.
Return	`boolean`		`true` if dictionary query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionarySearch
Description	Tests if a dictionary search service is supported.
Return	`boolean`		`true` if dictionary search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionaryAdmin
Description	Tests if a dictionary administrative service is supported.
Return	`boolean`		`true` if dictionary administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionaryNotification
Description	Tests if a dictionary notification service is supported.
Return	`boolean`		`true` if dictionary notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionaryHierachyTraversal
Description	Tests if a dictionary hierarchy traversal service is supported.
Return	`boolean`		`true` if dictionary hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionaryHierachyDesign
Description	Tests if a dictionary hierarchy design service is supported.
Return	`boolean`		`true` if dictionary hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionaryBatch
Description	Tests if a dictionary batch service is supported.
Return	`boolean`		`true` if dictionary batch service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntryKeyTypes
Description	Gets the supported `Entry` key types.
Return	`osid.type.TypeList`		a list containing the supported `Entry` key types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryKeyType
Description	Tests if the given `Entry` key type is supported.
Parameters	`osid.type.Type`	`entryKeyType`	a `Type` indicating an `Entry` key type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`entryKeyType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntryValueTypes
Description	Gets the supported `Entry` value types.
Return	`osid.type.TypeList`		a list containing the supported `Entry` value types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryValueType
Description	Tests if the given `Entry` value type is supported.
Parameters	`osid.type.Type`	`entryValueType`	a `Type` indicating an `Entry` value type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntryValueTypesForKeyType
Description	Gets the list of value types supported for the given key type.
Parameters	`osid.type.Type`	`entryKeyType`	a `Type` indicating an `Entry` key type
Return	`osid.type.TypeList`		a list of value types
Errors	NULL_ARGUMENT		`entryKeyType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryTypes
Description	Tests if the given `Entry` key and value types are supported.
Parameters	`osid.type.Type`	`entryKeyType`	a `Type` indicating an `Entry` key type
Parameters	`osid.type.Type`	`entryValueType`	a `Type` indicating an `Entry` value type
Return	`boolean`		`true` if the given Types are supported, `false` otherwise
Errors	NULL_ARGUMENT		`entryKeyType` or `entryValueType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntryRecordTypes
Description	Gets the supported `Entry` record types.
Return	`osid.type.TypeList`		a list containing the supported `Entry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryRecordType
Description	Tests if the given `Entry` record type is supported.
Parameters	`osid.type.Type`	`entryRecordType`	a `Type` indicating an `Entry` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntrySearchRecordTypes
Description	Gets the supported `Entry` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Entry` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntrySearchRecordType
Description	Tests if the given `Entry` search record type is supported.
Parameters	`osid.type.Type`	`entrySearchRecordType`	a `Type` indicating an `Entry` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`entrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDictionaryRecordTypes
Description	Gets the supported `Dictionary` record types.
Return	`osid.type.TypeList`		a list containing the supported `Dictionary` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionaryRecordType
Description	Tests if the given `Dictionary` record type is supported.
Parameters	`osid.type.Type`	`dictionaryRecordType`	a `Type` indicating a `Dictionary` record type
Return	`boolean`		`true` if the given record Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`dictionaryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDictionarySearchRecordTypes
Description	Gets the supported `Dictionary` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Dictionary` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsDictionarySearchRecordType
Description	Tests if the given `Dictionary` search record type is supported.
Parameters	`osid.type.Type`	`dictionarySearchRecordType`	a `Type` indicating a `Dictionary` search record type
Return	`boolean`		`true` if the given record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`dictionarySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.