OSID - osid.authentication.AuthenticationProxyManager Service Interface Definition

Interface	osid.authentication.AuthenticationProxyManager
Implements	`osid.OsidProxyManager`
Implements	`osid.authentication.AuthenticationProfile`
Description	The authentication proxy manager provides access to authentication sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a `Proxy` object. The sessions included in this manager are: `AgentLookupSession:` session to look up `Agents` `AgentQuerySession` : a session to query `Agents` `AgentSearchSession:` session to search `Agents` `AgentAdminSession:` session to create, modify and delete `Agents` Agent `NotificationSession:` session to receive messages pertaining to `Agent` changes `AgentAgencySession:` a session to retrieve `Agent` to `Agency` mappings `AgentAgencyAssignmentSession:` a session to manage `Agent` to `Agency` mappings `AgentSmartAgencySession:` a session to create dynamic agencies `AgencyLookupSession:` a session to lookup agencies `AgencyQuerySession:` a session to query agencies `AgencySearchSession` : a session to search agencies `AgencyAdminSession` : a session to create, modify and delete agencies `AgencyNotificationSession` : a session to receive messages pertaining to `Agency` changes `AgencyHierarchySession` : a session to traverse the `Agency` hierarchy `AgencyHierarchyDesignSession` : a session to manage the `Agency` hierarchy
Method	getAgentLookupSession
Description	Gets the `OsidSession` associated with the agent lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentLookupSession`		an `AgentLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgentLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentLookup()` is `true.`
Method	getAgentLookupSessionForAgency
Description	Gets the `OsidSession` associated with the agent lookup service for the given agency.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentLookupSession`		`an AgentLookupSession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` or `proxy` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsAgentLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentLookup()` and `supportsVisibleFederation()` are `true.`
Method	getAgentQuerySession
Description	Gets the `OsidSession` associated with the agent query service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentQuerySession`		an `AgentQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentQuery()` is `true.`
Method	getAgentQuerySessionForAgency
Description	Gets the `OsidSession` associated with the agent query service for the given agency.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentQuerySession`		an `AgentQuerySession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` or `proxy` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsAgentQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentQuery()` and `supportsVisibleFederation()` are `true.`
Method	getAgentSearchSession
Description	Gets the `OsidSession` associated with the agent search service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentSearchSession`		an `AgentSearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgentSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentSearch()` is `true.`
Method	getAgentSearchSessionForAgency
Description	Gets the `OsidSession` associated with the agent search service for the given agency.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentSearchSession`		`an AgentSearchSession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` or `proxy` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsAgentSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentSearch()` and `supportsVisibleFederation()` are `true.`
Method	getAgentAdminSession
Description	Gets the `OsidSession` associated with the agent administration service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentAdminSession`		an `AgentAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgentAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentAdmin()` is `true.`
Method	getAgentAdminSessionForAgency
Description	Gets the `OsidSession` associated with the agent admin service for the given agency.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentAdminSession`		`an AgentAdminSession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` or `proxy` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsAgentAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentAdmin()` and `supportsVisibleFederation()` are `true.`
Method	getAgentNotificationSession
Description	Gets the messaging receiver session for notifications pertaining to agent changes.
Parameters	`osid.authentication.AgentReceiver`	`agentReceiver`	the agent receiver
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentNotificationSession`		an `AgentNotificationSession`
Errors	NULL_ARGUMENT		`proxy` or `agentReceiver` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgentNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentNotification()` is `true.`
Method	getAgentNotificationSessionForAgency
Description	Gets the `OsidSession` associated with the agent notification service for the given agency.
Parameters	`osid.authentication.AgentReceiver`	`agentReceiver`	the agent receiver
	`osid.id.Id`	`agencyId`	the `Id` of the agency
	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentNotificationSession`		`an AgentNotificationSession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agentReceiver, agencyId` or `proxy` is `null`
	OPERATION_FAILED		`unable to complete request`
	UNIMPLEMENTED		`supportsAgentNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentNotification()` and `supportsVisibleFederation()` are `true.`
Method	getAgentAgencySession
Description	Gets the session for retrieving agent to agency mappings.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentAgencySession`		an `AgentAgencySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgentAgency()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentAgency()` is `true.`
Method	getAgentAgencyAssignmentSession
Description	Gets the session for assigning agent to agency mappings.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentAgencyAssignmentSession`		an `AgentAgencyAssignmentSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgentAgencyAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentAgencyAssignment()` is `true.`
Method	getAgentSmartAgencySession
Description	Gets the `OsidSession` associated with the agent smart agency service for the given agency.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the bank
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgentSmartAgencySession`		an `AgentSmartAgencySession`
Errors	NOT_FOUND		`agencyId` not found
	NULL_ARGUMENT		`agencyId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgentSmartAgency()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgentSmartAgency()` and `supportsVisibeFederation()` is `true.`
Method	getAgencyLookupSession
Description	Gets the `OsidSession` associated with the agency lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgencyLookupSession`		an `AgencyLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgencyLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgencyLookup()` is `true.`
Method	getAgencySearchSession
Description	Gets the `OsidSession` associated with the agency search service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgencySearchSession`		an `AgencySearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgencySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgencySearch()` is `true.`
Method	getAgencyAdminSession
Description	Gets the `OsidSession` associated with the agency administration service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgencyAdminSession`		an `AgencyAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgencyAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgencyAdmin()` is `true.`
Method	getAgencyNotificationSession
Description	Gets the messaging receiver session for notifications pertaining to agency changes.
Parameters	`osid.authentication.AgencyReceiver`	`agencyReceiver`	the agency receiver
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgencyNotificationSession`		an `AgencyNotificationSession`
Errors	NULL_ARGUMENT		`agencyReceiver` or `proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgencyNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgencyNotification()` is `true.`
Method	getAgencyHierarchySession
Description	Gets the session traversing agency hierarchies.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgencyHierarchySession`		an `AgencyHierarchySession`
Errors	NULL_ARGUMENT		`proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgencyHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgencyHierarchy()` is `true.`
Method	getAgencyHierarchyDesignSession
Description	Gets the session designing agency hierarchies.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.authentication.AgencyHierarchyDesignSession`		an `AgencyHierarchyDesignSession`
Errors	NULL_ARGUMENT		`proxy` is null
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsAgencyHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgencyHierarchyDesign()` is `true.`
Method	getAuthenticationBatchProxyManager
Description	Gets an `AuthenticationBatchProxyManager.`
Return	`osid.authentication.batch.AuthenticationBatchProxyManager`		an `AuthenticationBatchProxyManager.`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthenticationBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthenticationBatch()` is `true.`
Method	getAuthenticationKeysProxyManager
Description	Gets an `AuthenticationKeysProxyManager.`
Return	`osid.authentication.keys.AuthenticationKeysProxyManager`		an `AuthenticationKeysProxyManager.`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthenticationKeys()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthenticationKeys()` is `true.`
Method	getAuthenticationProcessProxyManager
Description	Gets an `AuthenticationProcessProxyManager.`
Return	`osid.authentication.process.AuthenticationProcessProxyManager`		an `AuthenticationProcessproxyManager.`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAuthenticationProcess()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAuthenticationProcess()` is `true.`