public interface DictionaryProfile extends OsidProfile
The DictionaryProfile
describes the interoperability
among dictionary services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getDictionaryRecordTypes()
Gets the supported
Dictionary record types. |
TypeList |
getDictionarySearchRecordTypes()
Gets the supported
Dictionary search record types. |
TypeList |
getEntryKeyTypes()
Gets the supported
Entry key types. |
TypeList |
getEntryRecordTypes()
Gets the supported
Entry record types. |
TypeList |
getEntrySearchRecordTypes()
Gets the supported
Entry search record types. |
TypeList |
getEntryValueTypes()
Gets the supported
Entry value types. |
TypeList |
getEntryValueTypesForKeyType(Type entryKeyType)
Gets the list of value types supported for the given key type.
|
boolean |
supportsDictionaryAdmin()
Tests if a dictionary administrative service is supported.
|
boolean |
supportsDictionaryBatch()
Tests if a dictionary batch service is supported.
|
boolean |
supportsDictionaryHierachyDesign()
Tests if a dictionary hierarchy design service is supported.
|
boolean |
supportsDictionaryHierachyTraversal()
Tests if a dictionary hierarchy traversal service is supported.
|
boolean |
supportsDictionaryLookup()
Tests if a dictionary lookup service is supported.
|
boolean |
supportsDictionaryNotification()
Tests if a dictionary notification service is supported.
|
boolean |
supportsDictionaryQuery()
Tests if a dictionary query service is supported.
|
boolean |
supportsDictionaryRecordType(Type dictionaryRecordType)
Tests if the given
Dictionary record type is supported. |
boolean |
supportsDictionarySearch()
Tests if a dictionary search service is supported.
|
boolean |
supportsDictionarySearchRecordType(Type dictionarySearchRecordType)
Tests if the given
Dictionary search record type is
supported. |
boolean |
supportsEntryAdmin()
Tests if a dictionary entry administrative service is supported.
|
boolean |
supportsEntryDictionary()
Tests if retrieving mappings of entry and dictionarys is supported.
|
boolean |
supportsEntryDictionaryAssignment()
Tests if managing mappings of entry and dictionarys is supported.
|
boolean |
supportsEntryKeyType(Type entryKeyType)
Tests if the given
Entry key type is supported. |
boolean |
supportsEntryLookup()
Tests if looking up dictionary entries are supported.
|
boolean |
supportsEntryNotification()
Tests if a dictionary entry notification service is supported.
|
boolean |
supportsEntryQuery()
Tests if querying dictionary entries are supported.
|
boolean |
supportsEntryRecordType(Type entryRecordType)
Tests if the given
Entry record type is supported. |
boolean |
supportsEntryRetrieval()
Tests if retrieving dictionary entries are supported.
|
boolean |
supportsEntrySearch()
Tests if searching dictionary entries are supported.
|
boolean |
supportsEntrySearchRecordType(Type entrySearchRecordType)
Tests if the given
Entry search record type is
supported. |
boolean |
supportsEntrySmartDictionary()
Tests if entry smart dictionarys are available.
|
boolean |
supportsEntryTypes(Type entryKeyType,
Type entryValueType)
Tests if the given
Entry key and value types are
supported. |
boolean |
supportsEntryValueType(Type entryValueType)
Tests if the given
Entry value type is supported. |
boolean |
supportsVisibleFederation()
Tests if any dictionary federation is exposed.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if federation is visible false
otherwisemandatory
- This method must be implemented. boolean supportsEntryRetrieval()
true
if entry retrieval is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsEntryLookup()
true
if entry lookup is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsEntryQuery()
true
if entry query is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsEntrySearch()
true
if entry search is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsEntryAdmin()
true
if dictionary entry administration is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsEntryNotification()
true
if dictionary entry notification is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsEntryDictionary()
true
if entry dictionary mapping retrieval is
supported ,
false
otherwisemandatory
- This method must be implemented. boolean supportsEntryDictionaryAssignment()
true
if entry dictionary assignment is
supported ,
false
otherwisemandatory
- This method must be implemented. boolean supportsEntrySmartDictionary()
true
if entry smart dictionarys are supported
,
false
otherwisemandatory
- This method must be implemented. boolean supportsDictionaryLookup()
true
if dictionary lookup is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsDictionaryQuery()
true
if dictionary query is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsDictionarySearch()
true
if dictionary search is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsDictionaryAdmin()
true
if dictionary administration is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsDictionaryNotification()
true
if dictionary notification is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsDictionaryHierachyTraversal()
true
if dictionary hierarchy traversal is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsDictionaryHierachyDesign()
true
if dictionary hierarchy design is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsDictionaryBatch()
true
if dictionary batch service is supported,
false
otherwisemandatory
- This method must be implemented. TypeList getEntryKeyTypes()
Entry
key types. Entry
key typesmandatory
- This method must be implemented. boolean supportsEntryKeyType(Type entryKeyType)
Entry
key type is supported.entryKeyType
- a Type
indicating an Entry
key type true
if the given Type is supported,
false
otherwiseNullArgumentException
- entryKeyType
is
null
mandatory
- This method must be implemented. TypeList getEntryValueTypes()
Entry
value types. Entry
value
typesmandatory
- This method must be implemented. boolean supportsEntryValueType(Type entryValueType)
Entry
value type is supported.entryValueType
- a Type
indicating an
Entry
value type true
if the given Type is supported,
false
otherwiseNullArgumentException
- entryRecordType
is null
mandatory
- This method must be implemented. TypeList getEntryValueTypesForKeyType(Type entryKeyType)
entryKeyType
- a Type
indicating an Entry
key typeNullArgumentException
- entryKeyType
is
null
mandatory
- This method must be implemented. boolean supportsEntryTypes(Type entryKeyType, Type entryValueType)
Entry
key and value types are
supported.entryKeyType
- a Type
indicating an Entry
key typeentryValueType
- a Type
indicating an
Entry
value type true
if the given Types are supported,
false
otherwiseNullArgumentException
- entryKeyType
or
entryValueType
is null
mandatory
- This method must be implemented. TypeList getEntryRecordTypes()
Entry
record types. Entry
record
typesmandatory
- This method must be implemented. boolean supportsEntryRecordType(Type entryRecordType)
Entry
record type is supported.entryRecordType
- a Type
indicating an
Entry
record type true
if the given Type is supported,
false
otherwiseNullArgumentException
- entryRecordType
is null
mandatory
- This method must be implemented. TypeList getEntrySearchRecordTypes()
Entry
search record types. Entry
search
record typesmandatory
- This method must be implemented. boolean supportsEntrySearchRecordType(Type entrySearchRecordType)
Entry
search record type is
supported.entrySearchRecordType
- a Type
indicating an
Entry
search record type true
if the given Type is supported,
false
otherwiseNullArgumentException
- entrySearchRecordType
is null
mandatory
- This method must be implemented. TypeList getDictionaryRecordTypes()
Dictionary
record types. Dictionary
record typesmandatory
- This method must be implemented. boolean supportsDictionaryRecordType(Type dictionaryRecordType)
Dictionary
record type is supported.dictionaryRecordType
- a Type
indicating a
Dictionary
record type true
if the given record Type is supported,
false
otherwiseNullArgumentException
- dictionaryRecordType
is null
mandatory
- This method must be implemented. TypeList getDictionarySearchRecordTypes()
Dictionary
search record types. Dictionary
search record typesmandatory
- This method must be implemented. boolean supportsDictionarySearchRecordType(Type dictionarySearchRecordType)
Dictionary
search record type is
supported.dictionarySearchRecordType
- a Type
indicating a
Dictionary
search record type true
if the given record Type
is
supported, false
otherwiseNullArgumentException
-
dictionarySearchRecordType
is null
mandatory
- This method must be implemented.