Interface | osid.mapping.path.batch.ObstacleBatchAdminSession | ||
---|---|---|---|
Implements | osid.mapping.path.ObstacleAdminSession | ||
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 | getObstacleFormsForCreate | ||
Description |
Gets the obstacle forms for creating a bunch of new obstacles. A form is returned for each supplied path. | ||
Parameters | osid.id.IdList | pathIds | a list of paths |
osid.type.Type[] | obstacleRecordTypes | array of obstacle record types to be included in each create operation or an empty list if none | |
Return | osid.mapping.path.batch.ObstacleBatchFormList | the obstacle forms | |
Errors | NOT_FOUND | a pathId is not found | |
NULL_ARGUMENT | pathIds or obstacleRecordTypes 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 | createObstacles | ||
Description |
Creates a new set of | ||
Parameters | osid.mapping.path.batch.ObstacleBatchFormList | obstacleForms | the obstacle forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | obstacleForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getObstacleFormsForUpdate | ||
Description |
Gets the obstacle forms for updating an existing set of obstacles. A new obstacle form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | obstacleIds | the Ids of the Obstacle |
Return | osid.mapping.path.batch.ObstacleBatchFormList | the obstacle forms | |
Errors | NOT_FOUND | an obstacleId is not found | |
NULL_ARGUMENT | obstacleIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateObstacles | ||
Description |
Updates existing obstacles. 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.ObstacleBatchFormList | obstacleForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | obstacleForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllObstacles | ||
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 | deleteObstacles | ||
Description |
Deletes obstacles for the given | ||
Parameters | osid.id.IdList | obstacleIds | the Ids of the obstacles to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | obstacleIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteObstaclesForPath | ||
Description |
Deletes obstacles for the given path. | ||
Parameters | osid.id.IdList | pathId | an Id of a path |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | pathId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasObstacles | ||
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. |