OSID - osid.authentication.AgentAdminSession Service Interface Definition

Interface	osid.authentication.AgentAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Agents.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create an `Agent,` an `AgentForm` is requested using `getAgentFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AgentForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `AgentForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AgentForm` corresponds to an attempted transaction. For updates, `AgentForms` are requested to the `Agent` `Id` that is to be updated using `getAgentFormForUpdate().` Similarly, the `AgentForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AgentForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Agents.` To unmap an `Agent` from the current `Agency,` the `AgentAgencyAssignmentSession` should be used. These delete operations attempt to remove the `Agent` itself thus removing it from all known `Agency` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	canCreateAgents
Description	Tests if this user can create `Agents.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Agent` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Agent` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAgentWithRecordTypes
Description	Tests if this user can create a single `Agent` using the desired record types. While `AuthenticationManager.getAgentRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Agent.` Providing an empty array tests if an `Agent` can be created with no records.
Parameters	`osid.type.Type[]`	`agentRecordTypes`	array of agent record types
Return	`boolean`		`true` if `Agent` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`agentRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAgentFormForCreate
Description	Gets the agent form for creating new agents. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`agentRecordTypes`	array of agent record types
Return	`osid.authentication.AgentForm`		the agent form
Errors	NULL_ARGUMENT		`agentRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createAgent
Description	Creates a new `Agent.`
Parameters	`osid.authentication.AgentForm`	`agentForm`	the form for this `Agent`
Return	`osid.authentication.Agent`		the new `Agent`
Errors	ILLEGAL_STATE		`agentForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`agentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`agentForm` did not originate from `getAgentFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAgents
Description	Tests if this user can update `Agents.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Agent` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if agent modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAgent
Description	Tests if this user can update a specified agent. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating the agent will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer an update operation to an unauthorized user for this agent.
Parameters	`osid.id.Id`	`agentId`	the `Id` of the `Agent`
Return	`boolean`		`false` if agent modification is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If the `agentId` is not found, then it is acceptable to return false to indicate the lack of an update available.
Method	getAgentFormForUpdate
Description	Gets the agent form for updating an existing agent. A new agent form should be requested for each update transaction.
Parameters	`osid.id.Id`	`agentId`	the `Id` of the `Agent`
Return	`osid.authentication.AgentForm`		the agent form
Errors	NOT_FOUND		`agentId` is not found
	NULL_ARGUMENT		`agentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAgent
Description	Updates an existing agent.
Parameters	`osid.authentication.AgentForm`	`agentForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`agentForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`agentId` or `agentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`agentForm` did not originate from `getAgentFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAgents
Description	Tests if this user can delete `Agents.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Agent` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Agent` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAgent
Description	Tests if this user can delete a specified `Agent.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the `Agent` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user for this agent.
Parameters	`osid.id.Id`	`agentId`	the `Id` of the `Agent`
Return	`boolean`		`false` if `Agent` deletion is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If the `agentId` is not found, then it is acceptable to return false to indicate the lack of a delete available.
Method	deleteAgent
Description	Deletes the `Agent` identified by the given `Id` removing it from all other `Agencies` to which this `Agent` is associated.
Parameters	`osid.id.Id`	`agentId`	the `Id` of the `Agent` to delete
Errors	NOT_FOUND		an `Agent` was not found identified by the given `Id`
	NULL_ARGUMENT		`agentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAgentAliases
Description	Tests if this user can manage `Id` aliases for `Agents.` A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Agent` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAgent
Description	Adds an `Id` to an `Agent` for the purpose of creating compatibility. The primary `Id` of the `Agent` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another engine, it is reassigned to the given engine `Id.`
Parameters	`osid.id.Id`	`agentId`	the `Id` of an `Agent`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`agentId` not found
	NULL_ARGUMENT		`agentId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.