OSID - osid.personnel.PersonSmartRealmSession Service Interface Definition

Interface	osid.personnel.PersonSmartRealmSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `PersonQuery` can be retrieved from this session and mapped to this `Realm` to create a virtual collection of `Persons.` The persons may be sequenced using the `PersonSearchOrder` from this session. This `Realm` has a default query that matches any person and a default search order that specifies no sequencing. The queries may be examined using a `PersonQueryInspector.` The query may be modified by converting the inspector back to a `PersonQuery.`
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	getPersonQuery
Description	Gets a person query.
Return	`osid.personnel.PersonQuery`		the person query
Compliance	`mandatory`		This method must be implemented.
Method	getPersonSearchOrder
Description	Gets a person search order.
Return	`osid.personnel.PersonSearchOrder`		the person search order
Compliance	`mandatory`		This method must be implemented.
Method	applyPersonQuery
Description	Applies a person query to this realm.
Parameters	`osid.personnel.PersonQuery`	`personQuery`	the person query
Errors	NULL_ARGUMENT		`personQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`personQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectPersonQuery
Description	Gets a person query inspector for this realm.
Return	`osid.personnel.PersonQueryInspector`		the person query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyPersonSequencing
Description	Applies a person search order to this realm.
Parameters	`osid.personnel.PersonSearchOrder`	`personSearchOrder`	the person search order
Errors	NULL_ARGUMENT		`personSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`personSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPersonQueryFromInspector
Description	Gets a person query from an inspector.
Parameters	`osid.personnel.PersonQueryInspector`	`personQueryInspector`	a query inspector
Return	`osid.personnel.PersonQuery`		the person query
Errors	NULL_ARGUMENT		`personQueryInspector` is `null`
Errors	UNSUPPORTED		`personQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.