Interface | osid.authentication.batch.AgentBatchAdminSession | ||
---|---|---|---|
Implements | osid.authentication.AgentAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getAgentFormsForCreate | ||
Description |
Gets the agent forms for creating a bunch of new agents. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | agentRecordTypes | array of agent record types to be included in each create operation or an empty list if none | |
Return | osid.authentication.batch.AgentBatchFormList | the agent forms | |
Errors | NULL_ARGUMENT | agentRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createAgents | ||
Description |
Creates a new set of | ||
Parameters | osid.authentication.batch.AgentBatchFormList | agentForms | the agent forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | agentForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAgentFormsForUpdate | ||
Description |
Gets the agent forms for updating an existing set of agents. A new agent form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | agentIds | the Ids of the Agent |
Return | osid.authentication.batch.AgentBatchFormList | the agent form | |
Errors | NOT_FOUND | an agentId is not found | |
NULL_ARGUMENT | agentIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAgents | ||
Description |
Updates existing agents. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.authentication.batch.AgentBatchFormList | agentForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | agentForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllAgents | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAgents | ||
Description |
Deletes agents for the given | ||
Parameters | osid.id.IdList | agentIds | the Ids of the agents to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | agentIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasAgents | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |