public interface HierarchySequencingSession extends OsidSession
This session provides methods to sequence the nodes in a hierarchy.
Modifier and Type | Method and Description |
---|---|
boolean |
canSequenceHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
moveNodeAhead(Id parentId,
Id referenceId,
Id id)
Moves a node ahead of a refrence node under the given parent.
|
void |
moveNodeBehind(Id parentId,
Id referenceId,
Id id)
Moves a node behind a refrence node under the given parent.
|
void |
sequenceNodes(Id parentId,
Id[] ids)
Sequences a set of nodes under a parent.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceHierarchy()
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 moveNodeAhead(Id parentId, Id referenceId, Id id) throws NotFoundException, OperationFailedException, PermissionDeniedException
parentId
- the Id
of the parent nodereferenceId
- the Id
of the nodeid
- the Id
of the node to move ahead of
referenceId
NotFoundException
- parentId, referenceId,
or id
not found, or referenceId
or id
is not a child of parentId
NullArgumentException
- parentId, referenceId,
or id
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveNodeBehind(Id parentId, Id referenceId, Id id) throws NotFoundException, OperationFailedException, PermissionDeniedException
parentId
- the Id
of the parent nodereferenceId
- the Id
of the nodeid
- the Id
of the node to move behind
referenceId
NotFoundException
- parentId, referenceId,
or id
not found, or referenceId
or id
is not a child of parentId
NullArgumentException
- parentId, referenceId,
or id
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void sequenceNodes(Id parentId, Id[] ids) throws NotFoundException, OperationFailedException, PermissionDeniedException
parentId
- the Id
of the parent nodeids
- the Id
of the nodesNotFoundException
- parentId
or an
id
not found, or an id
is not a
child of parentId
NullArgumentException
- parentId
or
ids
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.