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

This session manages state sequences.

MethodgetProcessId
Description

Gets the Process Id associated with this session.

Returnosid.id.Idthe Process Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetProcess
Description

Gets the Process associated with this session.

Returnosid.process.Processthe Process associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceStates
Description

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.

Returnboolean false if State sequencing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddValidNextState
Description

Adds a valid next state.

Parametersosid.id.IdstateIdthe Id of the State
osid.id.IdnextStateIdthe Id of the next State
ErrorsNOT_FOUND stateId or nextStateId is not found
NULL_ARGUMENT stateId or nextStateId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveValidNextState
Description

Removes a valid next state.

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