public interface SequencingSession extends OsidSession
This session provides methods to sequence the elements in a
Chain.
Modifier and Type | Method and Description |
---|---|
boolean |
canSequence()
Tests if this user can sequence things.
|
Antimatroid |
getAntimatroid()
Gets the
Antimatroid associated with this session. |
Id |
getAntimatroidId()
Gets the
Antimatroid Id associated with
this session. |
void |
moveElementAhead(Id chainId,
Id referenceId,
Id id)
Moves an element ahead of a reference element in a chain.
|
void |
moveElementBehind(Id chainId,
Id referenceId,
Id id)
Moves an element beind a reference element in a chain.
|
void |
sequenceElements(Id chainId,
Id[] ids)
Sequences a set of elements in a chain.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAntimatroidId()
Antimatroid
Id
associated with
this session. Antimatroid Id
associated with this sessionmandatory
- This method must be implemented. Antimatroid getAntimatroid() throws OperationFailedException, PermissionDeniedException
Antimatroid
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequence()
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 sequencing is not authorized,
true
otherwisemandatory
- This method must be implemented. void moveElementAhead(Id chainId, Id referenceId, Id id) throws NotFoundException, OperationFailedException, PermissionDeniedException
chainId
- the Id
of the chainreferenceId
- the Id
of the reference elementid
- the Id
of the element to move ahead of
referenceId
NotFoundException
- chainId, referenceId,
or id
not found, or referenceId
or id
is not related to chainId
NullArgumentException
- chainId, referenceId,
or id
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveElementBehind(Id chainId, Id referenceId, Id id) throws NotFoundException, OperationFailedException, PermissionDeniedException
chainId
- the Id
of the chainreferenceId
- the Id
of the reference elementid
- the Id
of the element to move behind of
referenceId
NotFoundException
- parentId, referenceId,
or id
not found, or referenceId
or id
is not a child of parentId
NullArgumentException
- chainId, referenceId,
or id
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void sequenceElements(Id chainId, Id[] ids) throws NotFoundException, OperationFailedException, PermissionDeniedException
chainId
- the Id
of the chainids
- the Id
of the elementsNotFoundException
- chainId
or an
id
not found, or an id
is not related
to chainId
NullArgumentException
- chainId
or
ids
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.