public interface ObstacleBatchAdminSession extends ObstacleAdminSession
This session creates, updates, and deletes Obstacles
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 an
Obstacle,
an ObstacleForm
is requested using
getObstacleFormsForCreate()
specifying the desired path and
record Types
or none if no record Types
are
needed. Each of the returned ObstacleForms
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 an ObstacleForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
ObstacleForm
corresponds to an attempted transaction.
The ObstacleForms
returned from
getObstacleFormsForCreate()
may be linked to the originating
request through the peer Ids
of the ObstacleForm.
In the case where there may be duplicates, any ObstacleForm
of the same peer Ids
may be used for a create
operation.
Once a batch of ObstacleForms
are submitted for create,
a CreateResponse
is returned for each ObstacleForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createObstacles(),
errors specific to an individual ObstacleForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
ObstacleForm
through the ObstacleForm
Id
.
For updates, ObstacleForms
are requested to the
Obstacle
Id
that is to be updated using
getObstacleFormsForUpdate()
where the reference Id
in the ObstacleForm
may be used to link the request.
Similarly, the ObstacleForm
has metadata about the data
that can be updated and it can perform validation before submitting the
update. The ObstacleForm
can only be used once for a
successful update and cannot be reused.
Once a batch of ObstacleForms
are submitted for update,
an UpdateResponse
is returned for each ObstacleForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateObstacles(),
errors specific to an individual ObstacleForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
ObstacleForm
through the ObstacleForm
Id.
The delete operations delete Obstacles
in bulk. To
unmap an Obstacle
from the current Map,
the
ObstacleMapAssignmentSession
should be used. These delete
operations attempt to remove the Obstacle
itself thus
removing it from all known Map
catalogs. Bulk delete
operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasObstacles(AliasRequestList aliasRequests)
Adds an
Id to an Obstacle for the
purpose of creating compatibility. |
CreateResponseList |
createObstacles(ObstacleBatchFormList obstacleForms)
Creates a new set of
Obstacles. |
DeleteResponseList |
deleteAllObstacles()
Deletes all
Obstacles in this Map . |
DeleteResponseList |
deleteObstacles(IdList obstacleIds)
Deletes obstacles for the given
Ids. |
DeleteResponseList |
deleteObstaclesForPath(IdList pathId)
Deletes obstacles for the given path.
|
ObstacleBatchFormList |
getObstacleFormsForCreate(IdList pathIds,
Type[] obstacleRecordTypes)
Gets the obstacle forms for creating a bunch of new obstacles.
|
ObstacleBatchFormList |
getObstacleFormsForUpdate(IdList obstacleIds)
Gets the obstacle forms for updating an existing set of obstacles.
|
UpdateResponseList |
updateObstacles(ObstacleBatchFormList obstacleForms)
Updates existing obstacles.
|
aliasObstacle, canCreateObstacles, canCreateObstacleWithRecordTypes, canDeleteObstacles, canManageObstacleAliases, canUpdateObstacles, createObstacle, deleteObstacle, getMap, getMapId, getObstacleFormForCreate, getObstacleFormForUpdate, updateObstacle
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ObstacleBatchFormList getObstacleFormsForCreate(IdList pathIds, Type[] obstacleRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
pathIds
- a list of pathsobstacleRecordTypes
- array of obstacle record types to be
included in each create operation or an empty list if noneNotFoundException
- a pathId
is not
foundNullArgumentException
- pathIds
or
obstacleRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createObstacles(ObstacleBatchFormList obstacleForms) throws OperationFailedException, PermissionDeniedException
Obstacles.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.obstacleForms
- the obstacle formsNullArgumentException
- obstacleForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ObstacleBatchFormList getObstacleFormsForUpdate(IdList obstacleIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
obstacleIds
- the Ids
of the Obstacle
NotFoundException
- an obstacleId
is not
foundNullArgumentException
- obstacleIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateObstacles(ObstacleBatchFormList obstacleForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.obstacleForms
- the form containing the elements to be updatedNullArgumentException
- obstacleForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllObstacles() throws OperationFailedException, PermissionDeniedException
Obstacles
in this Map
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteObstacles(IdList obstacleIds) throws OperationFailedException, PermissionDeniedException
Ids.
obstacleIds
- the Ids
of the obstacles to deleteNullArgumentException
- obstacleIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteObstaclesForPath(IdList pathId) throws OperationFailedException, PermissionDeniedException
pathId
- an Id
of a pathNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasObstacles(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an Obstacle
for the
purpose of creating compatibility. The primary Id
of
the Obstacle
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another obstacle, it is reassigned to the given
obstacle Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.