public interface SubtaskIssueBatchAdminSession extends SubtaskIssueAdminSession
This session creates and deletes Subtasks
in bulk. The
data for create is provided by the consumer via the form object.
OsidForms
are requested for each create or update and may not be
reused.
To create a Subtask,
a SubtaskForm
is
requested using getSubtaskFormsForCreate()
specifying the
desired issue, queue, and record Types
or none if no record
Types
are needed. Each of the returned SubtaskForms
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
SubtaskForm
is submiited to a create operation, it cannot
be reused with another create operation unless the first operation was
unsuccessful. Each SubtaskForm
corresponds to an attempted
transaction.
The SubtaskForms
returned from
getSubtaskFormsForCreate()
may be linked to the originating
request through the peer Ids
of the SubtaskForm.
In the case where there may be duplicates, any SubtaskForm
of the same peer Ids
may be used for a create
operation.
Once a batch of SubtaskForms
are submitted for create,
a CreateResponse
is returned for each SubtaskForm,
although the ordering is not defined. Only errors that pertain to
the entire create operation are returned from createSubtasks(),
errors specific to an individual SubtaskForm
are
indicated in the corresponding CreateResponse.
CreateResponses
may be linked to the originating
SubtaskForm
through the SubtaskForm
Id
.
Modifier and Type | Method and Description |
---|---|
CreateResponseList |
createSubtasks(IssueBatchFormList issueForms)
Creates a new set of
Subtasks. |
DeleteResponseList |
deleteAllSubtasks()
Deletes all
Subtasks in this FrontOffice
. |
DeleteResponseList |
deleteSubtasksForIssue(Id issueId)
Deletes all subtasks for the given issue.
|
DeleteResponseList |
deleteSubtasksForQueue(Id queueId)
Deletes all subtasks for the given queue.
|
IssueBatchFormList |
getSubtaskFormsForCreate(SubtaskIssuePeerList peers,
Type[] issueRecordTypes)
Gets the subtask forms for creating a bunch of new subtasks.
|
canCreateSubtasks, canCreateSubtaskWithRecordTypes, createSubtask, getFrontOffice, getFrontOfficeId, getSubtaskFormForCreate
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
IssueBatchFormList getSubtaskFormsForCreate(SubtaskIssuePeerList peers, Type[] issueRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- an Id
of a queueissueRecordTypes
- array of issue record types to be included in
each create operation or an empty list if noneNotFoundException
- a queueId
or
issueId
is not foundNullArgumentException
- peers
or
issueRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createSubtasks(IssueBatchFormList issueForms) throws OperationFailedException, PermissionDeniedException
Subtasks.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.issueForms
- the issue formsNullArgumentException
- issueForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllSubtasks() throws OperationFailedException, PermissionDeniedException
Subtasks
in this FrontOffice
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteSubtasksForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
queueId
- an Id
of a queueNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteSubtasksForIssue(Id issueId) throws OperationFailedException, PermissionDeniedException
issueId
- an Id
of an issueNullArgumentException
- issueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.