OSID - osid.personnel.PositionLookupSession Service Interface Definition

Interface	osid.personnel.PositionLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving positions. 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 realm view: All position methods in this session operate, retrieve and pertain to positions defined explicitly in the current realm. Using an isolated view is useful for managing positions with the `PositionAdminSession.` federated realm view: All position lookup methods in this session operate, retrieve and pertain to all positions defined in this realm and any other realms implicitly available in this realm through realm inheritence. effective position view: All position lookup methods return positions where the current date falls in between the effective dates inclusive. any effective position view: Positions of any effective date are returned from methods. The methods `useFederatedRealmView()` and `useIsolatedRealmView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getRealmId
Description	Gets the `Realm` `Id` associated with this session.
Return	`osid.id.Id`		the `Realm Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRealm
Description	Gets the `Realm` associated with this session.
Return	`osid.personnel.Realm`		the realm
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupPositions
Description	Tests if this user can examine this realm. 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 these operations.
Return	`boolean`		`false` if realm reading methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativePositionView
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	usePlenaryPositionView
Description	A complete view of the `Position` 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	useFederatedRealmView
Description	Federates the view for methods in this session. A federated view will include positions in realms which are children of this realm in the realm hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedRealmView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this realm only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectivePositionView
Description	Only positions whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectivePositionView
Description	All positions of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getPosition
Description	Gets the `Position` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Position` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Position` and retained for compatibility. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
Parameters	`osid.id.Id`	`positionId`	the `Id` of the `Position` to retrieve
Return	`osid.personnel.Position`		the returned `Position`
Errors	NOT_FOUND		no `Position` found with the given `Id`
	NULL_ARGUMENT		`positionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPositionsByIds
Description	Gets a `PositionList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the positions 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 positions may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
Parameters	`osid.id.IdList`	`positionIds`	the list of `Ids` to retrieve
Return	`osid.personnel.PositionList`		the returned `Position list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`positionIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPositionsByGenusType
Description	Gets a `PositionList` corresponding to the given position genus `Type` which does not include positions of types derived from the specified `Type.` In plenary mode, the returned list contains all known positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
Parameters	`osid.type.Type`	`positionGenusType`	a positions genus type
Return	`osid.personnel.PositionList`		the returned `Position list`
Errors	NULL_ARGUMENT		`positionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPositionsByParentGenusType
Description	Gets a `PositionList` corresponding to the given position genus `Type` and include any additional positions with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In active mode, positions are returned that are currently active. In any status mode, active and inactive positions are returned.
Parameters	`osid.type.Type`	`positionGenusType`	a position genus type
Return	`osid.personnel.PositionList`		the returned `Position list`
Errors	NULL_ARGUMENT		`positionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPositionsByRecordType
Description	Gets a `PositionList` containing the given position record `Type.` In plenary mode, the returned list contains all known positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
Parameters	`osid.type.Type`	`positionRecordType`	a position record type
Return	`osid.personnel.PositionList`		the returned `PositionList`
Errors	NULL_ARGUMENT		`positionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPositionsOnDate
Description	Gets a `PositionList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.personnel.PositionList`		the returned `PositionList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPositionsForOrganization
Description	Gets a `PositionList` for the given organization `.` In plenary mode, the returned list contains all known positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
Parameters	`osid.id.Id`	`organizationId`	an organization `Id`
Return	`osid.personnel.PositionList`		the returned `PositionList`
Errors	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPositionsForOrganizationOnDate
Description	Gets a `PositionList` for an organizatoon and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
Parameters	`osid.id.Id`	`organizationId`	an organization `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.personnel.PositionList`		a list of positions
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`organization, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPositions
Description	Gets all positions. In plenary mode, the returned list contains all known positions or an error results. Otherwise, the returned list may contain only those positions that are accessible through this session. In effective mode, positions are returned that are currently effective. In any effective mode, effective positions and those currently expired are returned.
Return	`osid.personnel.PositionList`		a list of positions
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.