Interface ObjectiveSequencingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ObjectiveSequencingSession
extends OsidSession

This session provides methods to sequence the objectives in the objective hierarchy.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getObjectiveHierarchyId

Id getObjectiveHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getObjectiveHierarchy

Hierarchy getObjectiveHierarchy()
                         throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceObjectives

boolean canSequenceObjectives()

Tests if this user can sequence objectives. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if sequencing objectives is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveObjectiveAhead

void moveObjectiveAhead(Id parentObjectiveId,
 Id referenceObjectiveId,
 Id objectiveId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an objective ahead of a refrence objective under the given parent.

Parameters:

parentObjectiveId - the Id of the parent objective

referenceObjectiveId - the Id of the objective

objectiveId - the Id of the objective to move ahead of referenceObjectiveId

Throws:

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 request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveObjectiveBehind

void moveObjectiveBehind(Id parentObjectiveId,
 Id referenceObjectiveId,
 Id objectiveId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an objective behind a refrence objective under the given parent.

Parameters:

parentObjectiveId - the Id of the parent objective

referenceObjectiveId - the Id of the objective

objectiveId - the Id of the objective to move behind referenceObjectiveId

Throws:

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 request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

sequenceObjectives

void sequenceObjectives(Id parentObjectiveId,
 Id[] objectiveIds)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Sequences a set of objectives under a parent.

Parameters:

parentObjectiveId - the Id of the parent objective

objectiveIds - the Id of the objectives

Throws:

NotFoundException - 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 request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.