Interface | osid.authorization.batch.FunctionBatchAdminSession | ||
---|---|---|---|
Implements | osid.authorization.FunctionAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getFunctionFormsForCreate | ||
Description |
Gets the function forms for creating a bunch of new functions. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | functionRecordTypes | array of function record types to be included in each create operation or an empty list if none | |
Return | osid.authorization.batch.FunctionBatchFormList | the function forms | |
Errors | NULL_ARGUMENT | functionRecordTypes 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 | createFunctions | ||
Description |
Creates a new set of | ||
Parameters | osid.authorization.batch.FunctionBatchFormList | functionForms | the function forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | functionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFunctionFormsForUpdate | ||
Description |
Gets the function forms for updating an existing set of functions. A new function form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | functionIds | the Ids of the Function |
Return | osid.authorization.batch.FunctionBatchFormList | the function form | |
Errors | NOT_FOUND | a functionId is not found | |
NULL_ARGUMENT | functionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateFunctions | ||
Description |
Updates existing functions. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.authorization.batch.FunctionBatchFormList | functionForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | functionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllFunctions | ||
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 | deleteFunctions | ||
Description |
Deletes functions for the given | ||
Parameters | osid.id.IdList | functionIds | the Ids of the functions to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | functionIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasFunctions | ||
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. |