Interface StateSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StateSession
extends OsidSession

This session provides methods to retrieve State to reference Id mappings. A reference Id may map to only one State while a State may map to multiple reference Ids .

This lookup session defines several views

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupStateMappings()	Tests if this user can perform lookups of state/Id mappings.
ProcessList	getProcessesByReference(Id referenceId)	Gets the processes to which the reference Id belongs.
IdList	getProcessIdsByReference(Id referenceId)	Gets the processes to which the reference Id belongs.
IdList	getReferencesByState(Id stateId)	Gets the list of reference Ids mapped to a State .
State	getStateByReferenceAndProcess(Id referenceId, Id processId)	Gets the State associated with the given reference and process.
Id	getStateIdByReferenceAndProcess(Id referenceId, Id processId)	Gets the State Id associated with the given reference Id and process.
IdList	getStateIdsByReference(Id referenceId)	Gets the State Id associated with the given reference Id .
IdList	getStateIdsByReferencesAndProcess(IdList referenceIds, Id processId)	Gets the State Ids associated with the given reference Id list and process.
StateList	getStatesByReference(Id referenceId)	Gets the State associated with the given Id .
StateList	getStatesByReferencesAndProcess(IdList referenceIds, Id processId)	Gets the States associated with the given references and process.
void	useComparativeStateView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryStateView()	A complete view of the State returns is desired.

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

canLookupStateMappings

boolean canLookupStateMappings()

Tests if this user can perform lookups of state/Id mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeStateView

void useComparativeStateView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryStateView

void usePlenaryStateView()

A complete view of the State returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getProcessIdsByReference

IdList getProcessIdsByReference(Id referenceId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the processes to which the reference Id belongs.

Parameters:

referenceId - a reference Id

Returns:

the processes to which the agent belongs

Throws:

NotFoundException - referenceId is not found

NullArgumentException - referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcessesByReference

ProcessList getProcessesByReference(Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the processes to which the reference Id belongs.

Parameters:

referenceId - a reference Id

Returns:

the processes to which the agent belongs

Throws:

NotFoundException - referenceId is not found

NullArgumentException - referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStateIdsByReference

IdList getStateIdsByReference(Id referenceId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the State Id associated with the given reference Id .

Parameters:

referenceId - a reference Id

Returns:

associated states

Throws:

NotFoundException - referenceId is not found

NullArgumentException - referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStatesByReference

StateList getStatesByReference(Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the State associated with the given Id .

Parameters:

referenceId - a reference Id

Returns:

associated states

Throws:

NotFoundException - referenceId is not found

NullArgumentException - referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStateIdByReferenceAndProcess

Id getStateIdByReferenceAndProcess(Id referenceId,
 Id processId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the State Id associated with the given reference Id and process.

Parameters:

referenceId - a reference Id

processId - Id of a Process

Returns:

associated state

Throws:

NotFoundException - referenceId is not found in process

NullArgumentException - referenceId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStateIdsByReferencesAndProcess

IdList getStateIdsByReferencesAndProcess(IdList referenceIds,
 Id processId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the State Ids associated with the given reference Id list and process. The returned state Ids are in the order they are supplied.

Parameters:

referenceIds - a reference Id

processId - Id of a Process

Returns:

associated states

Throws:

NotFoundException - referenceId is not found in process

NullArgumentException - referenceIds or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStateByReferenceAndProcess

State getStateByReferenceAndProcess(Id referenceId,
 Id processId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the State associated with the given reference and process.

Parameters:

referenceId - a reference Id

processId - Id of a Process

Returns:

associated state

Throws:

NotFoundException - a referenceId is not found in process

NullArgumentException - referenceId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStatesByReferencesAndProcess

StateList getStatesByReferencesAndProcess(IdList referenceIds,
 Id processId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the States associated with the given references and process. The returned states are in the order they are supplied.

Parameters:

referenceIds - a reference Ids

processId - Id of a Process

Returns:

associated state

Throws:

NotFoundException - a referenceId is not found in process

NullArgumentException - referenceIds or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getReferencesByState

IdList getReferencesByState(Id stateId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of reference Ids mapped to a State .

Parameters:

stateId - Id of a State

Returns:

list of reference Ids

Throws:

NotFoundException - stateId is not found

NullArgumentException - stateId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.