Interface SequencingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SequencingSession
extends OsidSession

This session provides methods to sequence the elements in a Chain .

Method Summary

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

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

getAntimatroidId

Id getAntimatroidId()

Gets the Antimatroid Id associated with this session.

Returns:

the Antimatroid Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAntimatroid

Antimatroid getAntimatroid()
                    throws OperationFailedException,
PermissionDeniedException

Gets the Antimatroid associated with this session.

Returns:

the antimatroid

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequence

boolean canSequence()

Tests if this user can sequence things. 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 is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveElementAhead

void moveElementAhead(Id chainId,
 Id referenceId,
 Id id)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an element ahead of a reference element in a chain.

Parameters:

chainId - the Id of the chain

referenceId - the Id of the reference element

id - the Id of the element to move ahead of referenceId

Throws:

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 request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveElementBehind

void moveElementBehind(Id chainId,
 Id referenceId,
 Id id)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an element beind a reference element in a chain.

Parameters:

chainId - the Id of the chain

referenceId - the Id of the reference element

id - the Id of the element to move behind of referenceId

Throws:

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 request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

sequenceElements

void sequenceElements(Id chainId,
 Id[] ids)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Sequences a set of elements in a chain.

Parameters:

chainId - the Id of the chain

ids - the Id of the elements

Throws:

NotFoundException - chainId or an id not found, or an id is not related to chainId

NullArgumentException - chainId or ids is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.