Interface | osid.mapping.path.batch.IntersectionBatchAdminSession | ||
---|---|---|---|
Implements | osid.mapping.path.IntersectionAdminSession | ||
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 | getIntersectionFormsForCreate | ||
Description |
Gets the intersection forms for creating a bunch of new intersections. | ||
Parameters | osid.mapping.path.batch.IntersectionPathList | paths | the list of paths for the intersections |
osid.type.Type[] | intersectionRecordTypes | array of intersection record types to be included in each create operation or an empty list if none | |
Return | osid.mapping.path.batch.IntersectionBatchFormList | the intersection forms | |
Errors | NOT_FOUND | a pathId is not found | |
NULL_ARGUMENT | paths or intersectionRecordTypes 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 | createIntersections | ||
Description |
Creates a new set of | ||
Parameters | osid.mapping.path.batch.IntersectionBatchFormList | intersectionForms | the intersection forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | intersectionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionFormsForUpdate | ||
Description |
Gets the intersection forms for updating an existing set of intersections. A new intersection form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | intersectionIds | the Ids of the Intersection |
Return | osid.mapping.path.batch.IntersectionBatchFormList | the intersection forms | |
Errors | NOT_FOUND | an intersectionId is not found | |
NULL_ARGUMENT | intersectionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateIntersections | ||
Description |
Updates existing intersections. 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.IntersectionBatchFormList | intersectionForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | intersectionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllIntersections | ||
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 | deleteIntersections | ||
Description |
Deletes intersections for the given | ||
Parameters | osid.id.IdList | intersectionIds | the Ids of the intersections to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | intersectionIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasIntersections | ||
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. |