org.osid.process

Interface StateAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

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

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.