Interface | osid.mapping.path.batch.SignalBatchAdminSession | ||
---|---|---|---|
Implements | osid.mapping.path.SignalAdminSession | ||
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 | getSignalFormsForCreate | ||
Description |
Gets the signal forms for creating a bunch of new signals. A form is returned for each supplied path. | ||
Parameters | osid.id.IdList | pathIds | a list of paths |
osid.type.Type[] | signalRecordTypes | array of signal record types to be included in each create operation or an empty list if none | |
Return | osid.mapping.path.batch.SignalBatchFormList | the signal forms | |
Errors | NOT_FOUND | a pathId is not found | |
NULL_ARGUMENT | pathIds or signalRecordTypes 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 | createSignals | ||
Description |
Creates a new set of | ||
Parameters | osid.mapping.path.batch.SignalBatchFormList | signalForms | the signal forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | signalForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSignalFormsForUpdate | ||
Description |
Gets the signal forms for updating an existing set of signals. A new signal form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | signalIds | the Ids of the Signal |
Return | osid.mapping.path.batch.SignalBatchFormList | the signal forms | |
Errors | NOT_FOUND | a signalId is not found | |
NULL_ARGUMENT | signalIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateSignals | ||
Description |
Updates existing signals. 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.SignalBatchFormList | signalForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | signalForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllSignals | ||
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 | deleteSignals | ||
Description |
Deletes signals for the given | ||
Parameters | osid.id.IdList | signalIds | the Ids of the signals to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | signalIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteSignalsForPath | ||
Description |
Deletes signals for the given path. | ||
Parameters | osid.id.Id | pathId | the 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 | aliasSignals | ||
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. |