public interface DictionaryHierarchyDesignSession extends OsidSession
This session manages a hierarchy of dictionaries. Dictionary
objects may be organized into a hierarchy for organizing or
federating. A parent Dictionary
includes all of the entries
of its children such that a single root node contains all of the entries
of the federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildDictionary(Id dictionaryId,
Id childId)
Adds a child to a dictionary.
|
void |
addRootDictionary(Id dictionaryId)
Adds a root dictionary.
|
boolean |
canModifyDictionaryHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getDictionaryHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getDictionaryHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildDictionaries(Id dictionaryId)
Removes all children from a dictionary.
|
void |
removeChildDictionary(Id dictionaryId,
Id childId)
Removes a child from a dictionary.
|
void |
removeRootDictionary(Id dictionaryId)
Removes a root dictionary.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDictionaryHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getDictionaryHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyDictionaryHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootDictionary(Id dictionaryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
dictionaryId
- the Id
of a dicrtionaryAlreadyExistsException
- dictionaryId
is
already in hierarchyNotFoundException
- dictionaryId
not
foundNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootDictionary(Id dictionaryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
dictionaryId
- the Id
of a dicrtionaryNotFoundException
- dictionaryId
is not
a rootNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildDictionary(Id dictionaryId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
dictionaryId
- the Id
of a dictionarychildId
- the Id
of the new childAlreadyExistsException
- dictionaryId
is
already a parent of childId
NotFoundException
- dictionaryId
or
childId
not foundNullArgumentException
- dictionaryId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildDictionary(Id dictionaryId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
dictionaryId
- the Id
of a dictionarychildId
- the Id
of the new childNotFoundException
- dictionaryId
not a
parent of childId
NullArgumentException
- dictionaryId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildDictionaries(Id dictionaryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
dictionaryId
- the Id
of a dictionaryNotFoundException
- dictionaryId
is not
in hierarchyNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.