Interface | osid.mapping.path.batch.PathBatchAdminSession | ||
---|---|---|---|
Implements | osid.mapping.path.PathAdminSession | ||
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 | getPathFormsForCreate | ||
Description |
Gets the path forms for creating a bunch of new paths. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | pathRecordTypes | array of path record types to be included in each create operation or an empty list if none | |
Return | osid.mapping.path.batch.PathBatchFormList | the path forms | |
Errors | NULL_ARGUMENT | pathRecordTypes 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 | createPaths | ||
Description |
Creates a new set of | ||
Parameters | osid.mapping.path.batch.PathBatchFormList | pathForms | the path forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | pathForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPathFormsForUpdate | ||
Description |
Gets the path forms for updating an existing set of paths. A new path form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | pathIds | the Ids of the Path |
Return | osid.mapping.path.batch.PathBatchFormList | the path forms | |
Errors | NOT_FOUND | a pathId is not found | |
NULL_ARGUMENT | pathIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePaths | ||
Description |
Updates existing paths. This method returns an error if
the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.mapping.path.batch.PathBatchFormList | pathForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | pathForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllPaths | ||
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 | deletePaths | ||
Description |
Deletes paths for the given | ||
Parameters | osid.id.IdList | pathIds | the Ids of the paths to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | pathIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasPaths | ||
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. |