Interface SubtaskIssueBatchAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, SubtaskIssueAdminSession

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 .

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface SubtaskIssueAdminSession

canCreateSubtasks, canCreateSubtaskWithRecordTypes, createSubtask, getFrontOffice, getFrontOfficeId, getSubtaskFormForCreate

Modifier and Type	Method	Description
boolean	canCreateSubtasks()	Tests if this user can create subtask Issues .
boolean	canCreateSubtaskWithRecordTypes(Type[] issueRecordTypes)	Tests if this user can create a single Issue using the desired record types.
Issue	createSubtask(IssueForm issueForm)	Creates a subtask Issue .
FrontOffice	getFrontOffice()	Gets the FrontOffice associated with this session.
Id	getFrontOfficeId()	Gets the FrontOffice Id associated with this session.
IssueForm	getSubtaskFormForCreate(Id issueId, Id queueId, Type[] issueRecordTypes)	Gets the issue form for creating subtasks.

Method Details

getSubtaskFormsForCreate

IssueBatchFormList getSubtaskFormsForCreate(SubtaskIssuePeerList peers,
 Type[] issueRecordTypes)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the subtask forms for creating a bunch of new subtasks. A SubtaskForm is returned for each queue and issue.

Parameters:

peers - an Id of a queue

issueRecordTypes - array of issue record types to be included in each create operation or an empty list if none

Returns:

the issue forms

Throws:

NotFoundException - a queueId or issueId is not found

NullArgumentException - peers or issueRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createSubtasks

CreateResponseList createSubtasks(IssueBatchFormList issueForms)
                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

issueForms - the issue forms

Returns:

the create responses

Throws:

NullArgumentException - issueForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllSubtasks

DeleteResponseList deleteAllSubtasks()
                              throws OperationFailedException,
PermissionDeniedException

Deletes all Subtasks in this FrontOffice .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSubtasksForQueue

DeleteResponseList deleteSubtasksForQueue(Id queueId)
                                   throws OperationFailedException,
PermissionDeniedException

Deletes all subtasks for the given queue.

Parameters:

queueId - an Id of a queue

Returns:

the delete responses

Throws:

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSubtasksForIssue

DeleteResponseList deleteSubtasksForIssue(Id issueId)
                                   throws OperationFailedException,
PermissionDeniedException

Deletes all subtasks for the given issue.

Parameters:

issueId - an Id of an issue

Returns:

the delete responses

Throws:

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.