OSID - osid.personnel.OrganizationSmartRealmSession Service Interface Definition

Interface	osid.personnel.OrganizationSmartRealmSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `OrganizationQuery` can be retrieved from this session and mapped to this `Realm` to create a virtual collection of `Organizations.` The organizations may be sequenced using the `OrganizationSearchOrder` from this session. This `Realm` has a default query that matches any organization and a default search order that specifies no sequencing. The queries may be examined using an `OrganizationQueryInspector.` The query may be modified by converting the inspector back to a n `OrganizationQuery.`
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	getOrganizationQuery
Description	Gets an organization query.
Return	`osid.personnel.OrganizationQuery`		the organization query
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationSearchOrder
Description	Gets an organization search order.
Return	`osid.personnel.OrganizationSearchOrder`		the organization search order
Compliance	`mandatory`		This method must be implemented.
Method	applyOrganizationQuery
Description	Applies an organization query to this realm.
Parameters	`osid.personnel.OrganizationQuery`	`organizationQuery`	the organization query
Errors	NULL_ARGUMENT		`organizationQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`organizationQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectOrganizationQuery
Description	Gets an organization query inspector for this realm.
Return	`osid.personnel.OrganizationQueryInspector`		the organization query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyOrganizationSequencing
Description	Applies an organization search order to this realm.
Parameters	`osid.personnel.OrganizationSearchOrder`	`organizationSearchOrder`	the organization search order
Errors	NULL_ARGUMENT		`organizationSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`organizationSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationQueryFromInspector
Description	Gets an organization query from an inspector.
Parameters	`osid.personnel.OrganizationQueryInspector`	`organizationQueryInspector`	a query inspector
Return	`osid.personnel.OrganizationQuery`		the organization query
Errors	NULL_ARGUMENT		`organizationQueryInspector` is `null`
Errors	UNSUPPORTED		`organizationQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.