public interface ProcessBatchAdminSession extends ProcessAdminSession
This session creates, updates, and deletes Processes
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
Process,
a ProcessForm
is requested using
getProcessFormsForCreate()
specifying the desired record
Types
or none if no record Types
are needed. Each
of the returned ProcessForms
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 ProcessForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
ProcessForm
corresponds to an attempted transaction.
The ProcessForms
returned from
getProcessFormsForCreate()
may be linked to the originating
request through the peer Ids
of the ProcessForm.
In the case where there may be duplicates, any ProcessForm
of the same peer Ids
may be used for a create
operation.
Once a batch of ProcessForms
are submitted for create,
a CreateResponse
is returned for each ProcessForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createProcesses(),
errors specific to an individual ProcessForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
ProcessForm
through the ProcessForm
Id
.
For updates, ProcessForms
are requested to the
Process
Id
that is to be updated using
getProcessFormsForUpdate()
where the reference Id
in the ProcessForm
may be used to link the request.
Similarly, the ProcessForm
has metadata about the data that
can be updated and it can perform validation before submitting the update.
The ProcessForm
can only be used once for a successful
update and cannot be reused.
Once a batch of ProcessForms
are submitted for update,
an UpdateResponse
is returned for each ProcessForm,
although the ordering is not defined. Only errors that pertain to
the entire update operation are returned from updateProcesses(),
errors specific to an individual ProcessForm
are
indicated in the corresponding UpdateResponse.
UpdateResponses
may be linked to the originating
ProcessForm
through the ProcessForm
Id.
The delete operations delete Processes
in bulk. To
unmap a Process
from the current Office,
the
ProcessOfficeAssignmentSession
should be used. These delete
operations attempt to remove the Process
itself thus
removing it from all known Office
catalogs. Bulk delete
operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasProcesses(AliasRequestList aliasRequests)
Adds an
Id to a Process for the purpose
of creating compatibility. |
CreateResponseList |
createProcesses(ProcessBatchFormList processForms)
Creates a new set of
Processes. |
DeleteResponseList |
deleteAllProcesses()
Deletes all
Processes in this Office . |
DeleteResponseList |
deleteProcesses(IdList processIds)
Deletes processes for the given
Ids. |
ProcessBatchFormList |
getProcessFormsForCreate(long number,
Type[] processRecordTypes)
Gets the process forms for creating a bunch of new processes.
|
ProcessBatchFormList |
getProcessFormsForUpdate(IdList processIds)
Gets the process forms for updating an existing set of processes.
|
UpdateResponseList |
updateProcesses(ProcessBatchFormList processForms)
Updates existing processes.
|
addCompetency, aliasProcess, canAssignCompetencies, canCreateProcesses, canCreateProcessWithRecordTypes, canDeleteProcesses, canManageProcessAliases, canUpdateProcesses, createProcess, deleteProcess, getOffice, getOfficeId, getProcessFormForCreate, getProcessFormForUpdate, removeCompetencies, removeCompetency, updateProcess
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ProcessBatchFormList getProcessFormsForCreate(long number, Type[] processRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveprocessRecordTypes
- array of process record types to be
included in each create operation or an empty list if noneNullArgumentException
- processRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createProcesses(ProcessBatchFormList processForms) throws OperationFailedException, PermissionDeniedException
Processes.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.processForms
- the process formsNullArgumentException
- processForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcessBatchFormList getProcessFormsForUpdate(IdList processIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
processIds
- the Ids
of the Process
NotFoundException
- a processId
is not
foundNullArgumentException
- processIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateProcesses(ProcessBatchFormList processForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.processForms
- the form containing the elements to be updatedNullArgumentException
- processForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllProcesses() throws OperationFailedException, PermissionDeniedException
Processes
in this Office
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteProcesses(IdList processIds) throws OperationFailedException, PermissionDeniedException
Ids.
processIds
- the Ids
of the processes to deleteNullArgumentException
- processIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasProcesses(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to a Process
for the purpose
of creating compatibility. The primary Id
of the
Process
is determined by the provider. The new Id
is an alias to the primary Id.
If the alias is
a pointer to another process, it is reassigned to the given process
Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.