OSID - osid.process.StateLookupSession Service Interface Definition

Interface	osid.process.StateLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving states. A `State` is an arbitrary entity that may represent a person, place or thing used to identify an object used in various services. 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 isolated process view: All state methods in this session operate, retrieve and pertain to states defined explicitly in the current process. Using an isolated view is useful for managing `States` with the `StateAdminSession.` federated process view: All state methods in this session operate, retrieve and pertain to all states defined in this process and any other states implicitly available in this process through process inheritence. The methods `useFederatedProcessView()` and `useIsolatedProcessView()` behave as a radio group and one should be selected before invoking any lookup methods. States may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `State.`
Method	getProcessId
Description	Gets the `Process` `Id` associated with this session.
Return	`osid.id.Id`		the `Process Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getProcess
Description	Gets the `Process` associated with this session.
Return	`osid.process.Process`		the `Process` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupStates
Description	Tests if this user can perform `State` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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.
Return	`boolean`		`false` if lookup methods are 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	useFederatedProcessView
Description	Federates the view for methods in this session. A federated view will include states in processes which are children of this process in the process hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedProcessView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this process only.
Compliance	`mandatory`		This method is must be implemented.
Method	getState
Description	Gets the `State` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `State` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `State` and retained for compatibility.
Parameters	`osid.id.Id`	`stateId`	the `Id` of the `State` to retrieve
Return	`osid.process.State`		the returned `State`
Errors	NOT_FOUND		no `State` found with the given `Id`
	NULL_ARGUMENT		`stateId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStatesByIds
Description	Gets a `StateList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the states specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `States` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`stateIds`	the list of `Ids` to retrieve
Return	`osid.process.StateList`		the returned `State list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`stateIdLs` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStatesByGenusType
Description	Gets a `StateList` corresponding to the given state genus `Type` which does not include states of types derived from the specified `Type.` In plenary mode, the returned list contains all known states or an error results. Otherwise, the returned list may contain only those states that are accessible through this session.
Parameters	`osid.type.Type`	`stateGenusType`	a state genus type
Return	`osid.process.StateList`		the returned `State` list
Errors	NULL_ARGUMENT		`stateGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStatesByParentGenusType
Description	Gets a `StateList` corresponding to the given state genus `Type` and include any additional states with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known states or an error results. Otherwise, the returned list may contain only those states that are accessible through this session.
Parameters	`osid.type.Type`	`stateGenusType`	a state genus type
Return	`osid.process.StateList`		the returned `State` list
Errors	NULL_ARGUMENT		`stateGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStatesByRecordType
Description	Gets a `StateList` containing the given state record `Type.` In plenary mode, the returned list contains all known states or an error results. Otherwise, the returned list may contain only those states that are accessible through this session.
Parameters	`osid.type.Type`	`stateRecordType`	a state record type
Return	`osid.process.StateList`		the returned `State` list
Errors	NULL_ARGUMENT		`stateRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStates
Description	Gets all `States.` In plenary mode, the returned list contains all known states or an error results. Otherwise, the returned list may contain only those states that are accessible through this session.
Return	`osid.process.StateList`		a list of `States`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValidNextStates
Description	Gets the next valid states for the given state.
Parameters	`osid.id.Id`	`stateId`	a state `Id`
Return	`osid.process.StateList`		the valid next `States`
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.