OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.StateAssignmentSession
Implementsosid.OsidSession
Description

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.

MethodcanAssignStates
Description

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.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetNextStateIds
Description

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

Parametersosid.id.IdreferenceIda reference Id
osid.id.IdprocessId Id of the Process
Returnosid.id.IdListthe Ids of the next valid states
ErrorsNOT_FOUND referenceId or processId is not found
NULL_ARGUMENT referenceId or processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetNextStates
Description

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

Parametersosid.id.IdreferenceIda reference Id
osid.id.IdprocessId Id of the Process
Returnosid.process.StateListthe next valid states
ErrorsNOT_FOUND referenceId or processId is not found
NULL_ARGUMENT referenceId or processId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodassignReferenceToState
Description

Adds a reference Id to a State.

Parametersosid.id.IdreferenceIda reference Id
osid.id.IdstateIdthe Id of the State
ErrorsALREADY_EXISTSthis Id is already assigned to the state
NOT_FOUND stateId not found
NULL_ARGUMENT id or stateId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignReferenceFromState
Description

Removes a reference Id from a State.

Parametersosid.id.IdreferenceIda reference Id
osid.id.IdstateIdthe Id of the State
ErrorsNOT_FOUND stateId not found
NULL_ARGUMENT referenceId or stateId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.