OSID - osid.process.StateSession Service Interface Definition

Interface	osid.process.StateSession
Implements	`osid.OsidSession`
Description	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	canLookupStateMappings
Description	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.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeStateView
Description	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.
Method	usePlenaryStateView
Description	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.
Method	getProcessIdsByReference
Description	Gets the processes to which the reference `Id` belongs.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Return	`osid.id.IdList`		the processes to which the agent belongs
Errors	NOT_FOUND		`referenceId` is not found
	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProcessesByReference
Description	Gets the processes to which the reference `Id` belongs.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Return	`osid.process.ProcessList`		the processes to which the agent belongs
Errors	NOT_FOUND		`referenceId` is not found
	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStateIdsByReference
Description	Gets the `State` `Id` associated with the given reference `Id.`
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Return	`osid.id.IdList`		associated states
Errors	NOT_FOUND		`referenceId` is not found
	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStatesByReference
Description	Gets the `State` associated with the given `Id.`
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Return	`osid.process.StateList`		associated states
Errors	NOT_FOUND		`referenceId` is not found
	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStateIdByReferenceAndProcess
Description	Gets the `State` `Id` associated with the given reference `Id` and process.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Parameters	`osid.id.Id`	`processId`	`Id` of a `Process`
Return	`osid.id.Id`		associated state
Errors	NOT_FOUND		`referenceId` is not found in process
	NULL_ARGUMENT		`referenceId` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStateIdsByReferencesAndProcess
Description	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	`osid.id.IdList`	`referenceIds`	a reference `Id`
Parameters	`osid.id.Id`	`processId`	`Id` of a `Process`
Return	`osid.id.IdList`		associated states
Errors	NOT_FOUND		`referenceId` is not found in process
	NULL_ARGUMENT		`referenceIds` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStateByReferenceAndProcess
Description	Gets the `State` associated with the given reference and process.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Parameters	`osid.id.Id`	`processId`	`Id` of a `Process`
Return	`osid.process.State`		associated state
Errors	NOT_FOUND		a `referenceId` is not found in process
	NULL_ARGUMENT		`referenceId` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStatesByReferencesAndProcess
Description	Gets the `States` associated with the given references and process. The returned states are in the order they are supplied.
Parameters	`osid.id.IdList`	`referenceIds`	a reference `Ids`
Parameters	`osid.id.Id`	`processId`	`Id` of a `Process`
Return	`osid.process.StateList`		associated state
Errors	NOT_FOUND		a `referenceId` is not found in process
	NULL_ARGUMENT		`referenceIds` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getReferencesByState
Description	Gets the list of reference `Ids` mapped to a `State.`
Parameters	`osid.id.Id`	`stateId`	`Id` of a `State`
Return	`osid.id.IdList`		list of reference `Ids`
Errors	NOT_FOUND		`stateId` is not found
	NULL_ARGUMENT		`stateId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.