public interface EntryDictionaryAssignmentSession extends OsidSession
This session provides methods to re-assign enrties to dictionaries. A
Entry
may map to multiple Dictionary
objects
and removing the last reference to a Entry
is the
equivalent of deleting it. Each Dictionary
may have its own
authorizations governing who is allowed to operate on it.
Moving or adding a reference of a Entry
to another
Dictionary
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignEntryToDictionary(Id entryId,
Id dictionaryId)
Adds an existing
Entry to a Dictionary. |
boolean |
canAssignEntries()
Tests if this user can alter entry/dictionary mappings.
|
boolean |
canAssignEntriesToDictionary(Id dictionaryId)
Tests if this user can alter entry/dictionary mappings.
|
IdList |
getAssignableDictionaryIds(Id dictionaryId)
Gets a list of dictionaries including and under the given dictionary
node in which any entry can be assigned.
|
IdList |
getAssignableDictionaryIdsForEntry(Id dictionaryId,
Id entryId)
Gets a list of dictionaries including and under the given dictionary
node in which a specific entry can be assigned.
|
void |
reassignEntryToDictionary(Id entryId,
Id fromDictionaryId,
Id toDictionaryId)
Moves an
Entry from one Dictionary to
another. |
void |
unassignEntryFromDictionary(Id entryId,
Id dictionaryId)
Removes a
Entry from a Dictionary. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignEntries()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignEntriesToDictionary(Id dictionaryId)
PERMISSION_DENIED
. This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.dictionaryId
- the Id
of the Dictionary
false
if mapping is not authorized, true
otherwiseNullArgumentException
- dictionaryId
is
null
mandatory
- This method must be implemented. IdList getAssignableDictionaryIds(Id dictionaryId) throws OperationFailedException
dictionaryId
- the Id
of the Dictionary
Ids
NullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableDictionaryIdsForEntry(Id dictionaryId, Id entryId) throws OperationFailedException
dictionaryId
- the Id
of the Dictionary
entryId
- the Id
of the Entry
Ids
NullArgumentException
- dictionaryId
or
entryId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignEntryToDictionary(Id entryId, Id dictionaryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Entry
to a Dictionary.
entryId
- the Id
of the Entry
dictionaryId
- the Id
of the Dictionary
AlreadyExistsException
- entryId
is
already assigned to dictionaryId
NotFoundException
- entryId
or
dictionaryId
not foundNullArgumentException
- entryId
or
dictionaryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignEntryFromDictionary(Id entryId, Id dictionaryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Entry
from a Dictionary.
entryId
- the Id
of the Entry
dictionaryId
- the Id
of the Dictionary
NotFoundException
- entryId
or
dictionaryId
not found or entryId
not
assigned to dictionaryId
NullArgumentException
- entryId
or
dictionaryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignEntryToDictionary(Id entryId, Id fromDictionaryId, Id toDictionaryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Entry
from one Dictionary
to
another. Mappings to other Dictionaries
are unaffected.entryId
- the Id
of the Entry
fromDictionaryId
- the Id
of the current
Dictionary
toDictionaryId
- the Id
of the destination
Dictionary
NotFoundException
- entryId, fromDictionaryId,
or toDictionaryId
not found or
entryId
not mapped to fromDictionaryId
NullArgumentException
- entryId
fromDictionaryId,
or toDictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.