public interface PathBatchAdminSession extends PathAdminSession
This session creates, updates, and deletes Paths 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
Path, a PathForm is requested using
getPathFormsForCreate() specifying the desired record Types
or none if no record Types are needed. Each of the
returned PathForms 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 PathForm is submiited to a create
operation, it cannot be reused with another create operation unless the
first operation was unsuccessful. Each PathForm corresponds
to an attempted transaction.
The PathForms returned from
getPathFormsForCreate() may be linked to the originating request
through the peer Ids of the PathForm. In the
case where there may be duplicates, any PathForm of the
same peer Ids may be used for a create operation.
Once a batch of PathForms are submitted for create, a
CreateResponse is returned for each PathForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createPaths(),
errors specific to an individual PathForm are
indicated in the corresponding CreateResponse.
CreateResponses may be linked to the originating PathForm
through the PathForm Id .
For updates, PathForms are requested to the Path
Id that is to be updated using
getPathFormsForUpdate() where the reference Id in
the PathForm may be used to link the request. Similarly,
the PathForm has metadata about the data that can be
updated and it can perform validation before submitting the update. The
PathForm can only be used once for a successful update and
cannot be reused.
Once a batch of PathForms are submitted for update, an
UpdateResponse is returned for each PathForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updatePaths(),
errors specific to an individual PathForm are
indicated in the corresponding UpdateResponse.
UpdateResponses may be linked to the originating PathForm
through the PathForm Id.
The delete operations delete Paths in bulk. To unmap a
Path from the current Map, the
PathMapAssignmentSession should be used. These delete operations
attempt to remove the Path itself thus removing it from all
known Map catalogs. Bulk delete operations return the
results in DeleteResponses.
| Modifier and Type | Method and Description |
|---|---|
AliasResponseList |
aliasPaths(AliasRequestList aliasRequests)
Adds an
Id to a Path for the purpose of
creating compatibility. |
CreateResponseList |
createPaths(PathBatchFormList pathForms)
Creates a new set of
Paths. |
DeleteResponseList |
deleteAllPaths()
Deletes all
Paths in this Map . |
DeleteResponseList |
deletePaths(IdList pathIds)
Deletes paths for the given
Ids. |
PathBatchFormList |
getPathFormsForCreate(long number,
Type[] pathRecordTypes)
Gets the path forms for creating a bunch of new paths.
|
PathBatchFormList |
getPathFormsForUpdate(IdList pathIds)
Gets the path forms for updating an existing set of paths.
|
UpdateResponseList |
updatePaths(PathBatchFormList pathForms)
Updates existing paths.
|
aliasPath, canCreatePaths, canCreatePathWithRecordTypes, canDeletePaths, canManagePathAliases, canUpdatePaths, createPath, deletePath, getMap, getMapId, getPathFormForCreate, getPathFormForUpdate, updatePathgetAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsclosePathBatchFormList getPathFormsForCreate(long number, Type[] pathRecordTypes) throws OperationFailedException, PermissionDeniedException
number - the number of forms to retrievepathRecordTypes - array of path record types to be included in
each create operation or an empty list if noneNullArgumentException - pathRecordTypes
is null OperationFailedException - unable to complete requestPermissionDeniedException - authorization failureUnsupportedException - unable to request forms with
given record typesmandatory - This method must be implemented. CreateResponseList createPaths(PathBatchFormList pathForms) throws OperationFailedException, PermissionDeniedException
Paths. This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse .pathForms - the path formsNullArgumentException - pathForms is
null OperationFailedException - unable to complete requestPermissionDeniedException - authorization failuremandatory - This method must be implemented. PathBatchFormList getPathFormsForUpdate(IdList pathIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
pathIds - the Ids of the Path NotFoundException - a pathId is not
foundNullArgumentException - pathIds is
null OperationFailedException - unable to complete requestPermissionDeniedException - authorization failuremandatory - This method must be implemented. UpdateResponseList updatePaths(PathBatchFormList pathForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse .pathForms - the form containing the elements to be updatedNullArgumentException - pathForms is
null OperationFailedException - unable to complete requestPermissionDeniedException - authorization failuremandatory - This method must be implemented. DeleteResponseList deleteAllPaths() throws OperationFailedException, PermissionDeniedException
Paths in this Map .OperationFailedException - unable to complete requestPermissionDeniedException - authorization failuremandatory - This method must be implemented. DeleteResponseList deletePaths(IdList pathIds) throws OperationFailedException, PermissionDeniedException
Ids. pathIds - the Ids of the paths to deleteNullArgumentException - pathIds is
null OperationFailedException - unable to complete requestPermissionDeniedException - authorization failuremandatory - This method must be implemented. AliasResponseList aliasPaths(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id to a Path for the purpose of
creating compatibility. The primary Id of the
Path is determined by the provider. The new Id
is an alias to the primary Id. If the alias is a
pointer to another path, it is reassigned to the given path Id.
aliasRequests - the alias requestsNullArgumentException - aliasRequests is
null OperationFailedException - unable to complete requestPermissionDeniedException - authorization failuremandatory - This method must be implemented.