public interface ObjectiveSequencingSession extends OsidSession
This session provides methods to sequence the objectives in the objective hierarchy.
Modifier and Type | Method and Description |
---|---|
boolean |
canSequenceObjectives()
Tests if this user can sequence objectives.
|
Hierarchy |
getObjectiveHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getObjectiveHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
moveObjectiveAhead(Id parentObjectiveId,
Id referenceObjectiveId,
Id objectiveId)
Moves an objective ahead of a refrence objective under the given
parent.
|
void |
moveObjectiveBehind(Id parentObjectiveId,
Id referenceObjectiveId,
Id objectiveId)
Moves an objective behind a refrence objective under the given parent.
|
void |
sequenceObjectives(Id parentObjectiveId,
Id[] objectiveIds)
Sequences a set of objectives under a parent.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getObjectiveHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getObjectiveHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceObjectives()
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 objectives is not
authorized, true
otherwisemandatory
- This method must be implemented. void moveObjectiveAhead(Id parentObjectiveId, Id referenceObjectiveId, Id objectiveId) throws NotFoundException, OperationFailedException, PermissionDeniedException
parentObjectiveId
- the Id
of the parent
objectivereferenceObjectiveId
- the Id
of the objectiveobjectiveId
- the Id
of the objective to move
ahead of referenceObjectiveId
NotFoundException
- parentObjectiveId,
referenceObjectiveId,
or objectiveId
not found, or referenceObjectiveId
or
objectiveId
is not a child of parentObjectiveId
NullArgumentException
- parentObjectiveId,
referenceObjectiveId,
or id
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveObjectiveBehind(Id parentObjectiveId, Id referenceObjectiveId, Id objectiveId) throws NotFoundException, OperationFailedException, PermissionDeniedException
parentObjectiveId
- the Id
of the parent
objectivereferenceObjectiveId
- the Id
of the objectiveobjectiveId
- the Id
of the objective to move
behind referenceObjectiveId
NotFoundException
- parentObjectiveId,
referenceObjectiveId,
or objectiveId
not found, or referenceObjectiveId
or
objectiveId
is not a child of parentObjectiveId
NullArgumentException
- parentObjectiveId,
referenceObjectiveId,
or id
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void sequenceObjectives(Id parentObjectiveId, Id[] objectiveIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
parentObjectiveId
- the Id
of the parent
objectiveobjectiveIds
- the Id
of the objectivesNotFoundException
- parentId
or an
objectiveId
not found, or an objectiveId
is not a child of parentObjectiveId
NullArgumentException
- parenObjectivetId
or objectiveIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.