Interface StateSequencingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StateSequencingSession
extends OsidSession

This session manages state sequences.

Method Summary

Modifier and Type	Method	Description
void	addValidNextState(Id stateId, Id nextStateId)	Adds a valid next state.
boolean	canSequenceStates()	Tests if this user can sequence States .
Process	getProcess()	Gets the Process associated with this session.
Id	getProcessId()	Gets the Process Id associated with this session.
void	removeValidNextState(Id stateId, Id nextStateId)	Removes a valid next state.

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

getProcessId

Id getProcessId()

Gets the Process Id associated with this session.

Returns:

the Process Id associated with this session

Compliance:

mandatory - This method must be implemented.

getProcess

Process getProcess()
            throws OperationFailedException,
PermissionDeniedException

Gets the Process associated with this session.

Returns:

the Process associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceStates

boolean canSequenceStates()

Tests if this user can sequence States . A return of true does not guarantee successful authorization. A return of false indicates that it is known these methods PERMISSION_DENIED . This is intended as a hint to an application that may opts not to offer these operations to unauthorized users.

Returns:

false if State sequencing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addValidNextState

void addValidNextState(Id stateId,
 Id nextStateId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a valid next state.

Parameters:

stateId - the Id of the State

nextStateId - the Id of the next State

Throws:

NotFoundException - stateId or nextStateId is not found

NullArgumentException - stateId or nextStateId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeValidNextState

void removeValidNextState(Id stateId,
 Id nextStateId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a valid next state.

Parameters:

stateId - the Id of the State

nextStateId - the Id of the next State

Throws:

NotFoundException - stateId or nextStateId is not found

NullArgumentException - stateId or nextStateId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.