Interface StateAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StateAssignmentSession
extends OsidSession

This session provides methods to re-assign State to reference Ids. A State may be associated with multiple reference ids. A reference id may map to only one State.

Method Summary

Modifier and Type	Method	Description
void	assignReferenceToState(Id referenceId, Id stateId)	Adds a reference Id to a State.
boolean	canAssignStates()	Tests if this user can alter state/id mappings.
IdList	getNextStateIds(Id referenceId, Id processId)	Gets the valid states that can be assigned to the reference id in the given process.
StateList	getNextStates(Id referenceId, Id processId)	Gets the valid states that can be assigned to a reference Id in the given process.
void	unassignReferenceFromState(Id referenceId, Id stateId)	Removes a reference Id from a 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

canAssignStates

boolean canAssignStates()

Tests if this user can alter state/id mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getNextStateIds

IdList getNextStateIds(Id referenceId,
 Id processId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the valid states that can be assigned to the reference id in the given process.

Parameters:

referenceId - a reference Id

processId - Id of the Process

Returns:

the Ids of the next valid states

Throws:

NotFoundException - referenceId or processId is not found

NullArgumentException - referenceId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getNextStates

StateList getNextStates(Id referenceId,
 Id processId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the valid states that can be assigned to a reference Id in the given process.

Parameters:

referenceId - a reference Id

processId - Id of the Process

Returns:

the next valid states

Throws:

NotFoundException - referenceId or processId is not found

NullArgumentException - referenceId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

assignReferenceToState

void assignReferenceToState(Id referenceId,
 Id stateId)
                     throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a reference Id to a State.

Parameters:

referenceId - a reference Id

stateId - the Id of the State

Throws:

AlreadyExistsException - this Id is already assigned to the state

NotFoundException - stateId not found

NullArgumentException - id or stateId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignReferenceFromState

void unassignReferenceFromState(Id referenceId,
 Id stateId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a reference Id from a State.

Parameters:

referenceId - a reference Id

stateId - the Id of the State

Throws:

NotFoundException - stateId not found

NullArgumentException - referenceId or stateId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.