OSID - osid.authentication.keys.KeySmartAgencySession Service Interface Definition

Interface	osid.authentication.keys.KeySmartAgencySession
Implements	`osid.OsidSession`
Used By	`osid.authentication.keys.AuthenticationKeysManager`
Used By	`osid.authentication.keys.AuthenticationKeysProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `KeyQuery` can be retrieved from this session and mapped to this `Agency` to create a virtual collection of `Keys`. The keys may be sequenced using the `KeySearchOrder` from this session. This `Agency` has a default query that matches any key and a default search order that specifies no sequencing. The queries may be examined using an `KeyQueryInspector`. The query may be modified by converting the inspector back to an `KeyQuery`.
Method	getAgencyId
Description	Gets the `Agency` `Id` associated with this session.
Return	`osid.id.Id`		the `Agency Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAgency
Description	Gets the `Agency` associated with this session.
Return	`osid.authentication.Agency`		the `Agency` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartAgencies
Description	Tests if this user can manage smart agencies. 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 agency management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getKeyQuery
Description	Gets a key query.
Return	`osid.authentication.keys.KeyQuery`		the key query
Compliance	`mandatory`		This method must be implemented.
Method	getKeySearchOrder
Description	Gets a key search order.
Return	`osid.authentication.keys.KeySearchOrder`		the key search order
Compliance	`mandatory`		This method must be implemented.
Method	applyKeyQuery
Description	Applies a key query to this agency.
Parameters	`osid.authentication.keys.KeyQuery`	`keyQuery`	the key query
Errors	NULL_ARGUMENT		`keyQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`keyQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectKeyQuery
Description	Gets a key query inspector for this agency.
Return	`osid.authentication.keys.KeyQueryInspector`		the key query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyKeySequencing
Description	Applies a key search order to this agency.
Parameters	`osid.authentication.keys.KeySearchOrder`	`keySearchOrder`	the key search order
Errors	NULL_ARGUMENT		`keySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`keySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getKeyQueryFromInspector
Description	Gets a key query from an inspector.
Parameters	`osid.authentication.keys.KeyQueryInspector`	`keyQueryInspector`	a query inspector
Return	`osid.authentication.keys.KeyQuery`		the key query
Errors	NULL_ARGUMENT		`keyQueryInspector` is `null`
Errors	UNSUPPORTED		`keyQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.