OSID Logo
OSID Specifications
mapping path batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.batch.SignalBatchAdminSession
Implementsosid.mapping.path.SignalAdminSession
Description

This session creates, updates, and deletes Signals in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Signal, a SignalForm is requested using getSignalFormsForCreate() specifying the desired path and record Types or none if no record Types are needed. Each of the returned SignalForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a SignalForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each SignalForm corresponds to an attempted transaction.

The SignalForms returned from getSignalFormsForCreate() may be linked to the originating request through the peer Ids of the SignalForm. In the case where there may be duplicates, any SignalForm of the same peer Ids may be used for a create operation.

Once a batch of SignalForms are submitted for create, a CreateResponse is returned for each SignalForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createSignals(), errors specific to an individual SignalForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating SignalForm through the SignalForm Id .

For updates, SignalForms are requested to the Signal Id that is to be updated using getSignalFormsForUpdate() where the reference Id in the SignalForm may be used to link the request. Similarly, the SignalForm has metadata about the data that can be updated and it can perform validation before submitting the update. The SignalForm can only be used once for a successful update and cannot be reused.

Once a batch of SignalForms are submitted for update, an UpdateResponse is returned for each SignalForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateSignals(), errors specific to an individual SignalForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating SignalForm through the SignalForm Id.

The delete operations delete Signals in bulk. To unmap a Signal from the current Map, the SignalMapAssignmentSession should be used. These delete operations attempt to remove the Signal itself thus removing it from all known Map catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetSignalFormsForCreate
Description

Gets the signal forms for creating a bunch of new signals. A form is returned for each supplied path.

Parametersosid.id.IdListpathIdsa list of paths
osid.type.Type[]signalRecordTypesarray of signal record types to be included in each create operation or an empty list if none
Returnosid.mapping.path.batch.SignalBatchFormListthe signal forms
ErrorsNOT_FOUNDa pathId is not found
NULL_ARGUMENT pathIds or signalRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateSignals
Description

Creates a new set of Signals. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.mapping.path.batch.SignalBatchFormListsignalFormsthe signal forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT signalForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSignalFormsForUpdate
Description

Gets the signal forms for updating an existing set of signals. A new signal form should be requested for each update transaction.

Parametersosid.id.IdListsignalIdsthe Ids of the Signal
Returnosid.mapping.path.batch.SignalBatchFormListthe signal forms
ErrorsNOT_FOUNDa signalId is not found
NULL_ARGUMENT signalIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateSignals
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 BatchCreateResponse .

Parametersosid.mapping.path.batch.SignalBatchFormListsignalFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT signalForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllSignals
Description

Deletes all Signals in this Map .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteSignals
Description

Deletes signals for the given Ids.

Parametersosid.id.IdListsignalIdsthe Ids of the signals to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT signalIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteSignalsForPath
Description

Deletes signals for the given path.

Parametersosid.id.IdpathIdthe Id of a path
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasSignals
Description

Adds an Id to a Signal for the purpose of creating compatibility. The primary Id of the Signal is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another signal, it is reassigned to the given signal Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.