OSID - osid.personnel.PositionSmartRealmSession Service Interface Definition

Interface	osid.personnel.PositionSmartRealmSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `PositionQuery` can be retrieved from this session and mapped to this `Realm` to create a virtual collection of `Positions.` The positions may be sequenced using the `PositionSearchOrder` from this session. This `Realm` has a default query that matches any position and a default search order that specifies no sequencing. The queries may be examined using a `PositionQueryInspector.` The query may be modified by converting the inspector back to a `PositionQuery.`
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartRealms
Description	Tests if this user can manage smart realms. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart realm management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPositionQuery
Description	Gets a position query.
Return	`osid.personnel.PositionQuery`		the position query
Compliance	`mandatory`		This method must be implemented.
Method	getPositionSearchOrder
Description	Gets a position search order.
Return	`osid.personnel.PositionSearchOrder`		the position search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPositionQuery
Description	Applies a position query to this realm.
Parameters	`osid.personnel.PositionQuery`	`positionQuery`	the position query
Errors	NULL_ARGUMENT		`positionQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`positionQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPositionQuery
Description	Gets a position query inspector for this realm.
Return	`osid.personnel.PositionQueryInspector`		the position query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPositionSequencing
Description	Applies a position search order to this realm.
Parameters	`osid.personnel.PositionSearchOrder`	`positionSearchOrder`	the position search order
Errors	NULL_ARGUMENT		`positionSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`positionSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPositionQueryFromInspector
Description	Gets a position query from an inspector.
Parameters	`osid.personnel.PositionQueryInspector`	`positionQueryInspector`	a query inspector
Return	`osid.personnel.PositionQuery`		the position query
Errors	NULL_ARGUMENT		`positionQueryInspector` is `null`
Errors	UNSUPPORTED		`positionQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.