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

Interface	osid.authentication.keys.AuthenticationKeysManager
Implements	`osid.OsidManager`
Implements	`osid.authentication.keys.AuthenticationKeysProfile`
Description	The authentication keys manager provides access to authenticationkeys sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `KeyLookupSession:` a session to access the keys of `Agents` `KeyQuerySession:` a session to query keys `KeySearchSession` : a session to search for keys `KeyAdminSession:` a session to update the keys of `Agents` `KeyNotificationSession:` a session to receive messages pertaining to `Key` changes `KeyAgencySession:` a session to retrieve `Key` to `Agency` mappings `KeyAgencyAssignmentSession:` a session to manage `Key` to `Agency` mappings `KeySmartAgencySession:` a session to create dynamic agencies of keys
Method	getKeyLookupSession
Description	Gets the `OsidSession` associated with the key lookup service.
Return	`osid.authentication.keys.KeyLookupSession`		a `KeyLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsKeyLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeyLookup()` is `true.`
Method	getKeyLookupSessionForAgency
Description	Gets the `OsidSession` associated with the key lookup service for the given agency.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency
Return	`osid.authentication.keys.KeyLookupSession`		`a KeyLookupSession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsKeyLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeyLookup()` and `supportsVisibleFederation()` are `true.`
Method	getKeySearchSession
Description	Gets the `OsidSession` associated with the key search service.
Return	`osid.authentication.keys.KeySearchSession`		a `KeySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsKeySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeySearch()` is `true.`
Method	getKeySearchSessionForAgency
Description	Gets the `OsidSession` associated with the key search service for the given agency.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency
Return	`osid.authentication.keys.KeySearchSession`		`a KeySearchSession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsKeySearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeySearch()` and `supportsVisibleFederation()` are `true.`
Method	getKeyAdminSession
Description	Gets the `OsidSession` associated with the key administration service.
Return	`osid.authentication.keys.KeyAdminSession`		a `KeyAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsKeyAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeyAdmin()` is `true.`
Method	getKeyAdminSessionForAgency
Description	Gets the `OsidSession` associated with the key admin service for the given agency.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency
Return	`osid.authentication.keys.KeyAdminSession`		`a KeyAdminSession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsKeyAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeyAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getKeyNotificationSession
Description	Gets the notification session for notifications pertaining to service changes.
Parameters	`osid.authentication.keys.KeyReceiver`	`keyReceiver`	the key receiver
Return	`osid.authentication.keys.KeyNotificationSession`		an `KeyNotificationSession`
Errors	NULL_ARGUMENT		`keyReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsKeyNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeyNotification()` is `true.`
Method	getKeyNotificationSessionForAgency
Description	Gets the `OsidSession` associated with the key notification service for the given agency.
Parameters	`osid.authentication.keys.KeyReceiver`	`keyReceiver`	the key receiver
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency
Return	`osid.authentication.keys.KeyNotificationSession`		`an KeyNotificationSession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`keyReceiver` or `agencyId` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsKeyNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeyNotification()` and `supportsVisibleFederation()` are `true.`
Method	getKeyAgencySession
Description	Gets the session for retrieving key to agency mappings.
Return	`osid.authentication.keys.KeyAgencySession`		an `KeyAgencySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsKeyAgency()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeyAgency()` is `true.`
Method	getKeyAgencyAssignmentSession
Description	Gets the session for assigning key to agency mappings.
Return	`osid.authentication.keys.KeyAgencyAssignmentSession`		a `KeyAgencyAsignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsKeyAgencyAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeyAgencyAssignment()` is `true.`
Method	getKeySmartAgencySession
Description	Gets the `OsidSession` associated with the key smart agency service for the given agency.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency
Return	`osid.authentication.keys.KeySmartAgencySession`		an `KeySmartAgencySession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsKeySmartAgency()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeySmartAgency()` and `supportsVisibeFederation()` is `true.`