public interface SubtaskIssueAdminSession extends OsidSession
This session creates subtask Issues.
Subtasks are issues
that are created in the contex of an existing issue.
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.
To create a subtask, an IssueForm
is requested using
getSubtaskFormForCreate()
specifying the desired issue and
record Types
or none if no record Types
are
needed. The returned IssueForm
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 the IssueForm
is
submiited to a create operation, it cannot be reused with another create
operation unless the first operation was unsuccessful. Each
IssueForm
corresponds to an attempted transaction.
Modifier and Type | Method and 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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFrontOfficeId()
FrontOffice
Id
associated with
this session. FrontOffice Id
associated with this sessionmandatory
- This method must be implemented. FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
FrontOffice
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateSubtasks()
Issues.
A return
of true does not guarantee successful authorization. A return of false
indicates that it is known creating a subtask will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer create operations to an
unauthorized user. false
if subtask Issue
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateSubtaskWithRecordTypes(Type[] issueRecordTypes)
Issue
using the
desired record types. While
TrackingManager.getIssueRecordTypes()
can be used to examine
which records are supported, this method tests which record(s) are
required for creating a specific Issue.
Providing an
empty array tests if an Issue
can be created with no
records.issueRecordTypes
- array of issue record types true
if Issue
creation using the
specified record Types
is supported,
false
otherwiseNullArgumentException
- issueRecordTypes
is null
mandatory
- This method must be implemented. IssueForm getSubtaskFormForCreate(Id issueId, Id queueId, Type[] issueRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
issueId
- the Id
of the Issue
queueId
- the Id
of the Queue
in
which the subtask should be createdissueRecordTypes
- array of issue record typesNotFoundException
- issueId
or
queueId
is not foundNullArgumentException
- issueId, queueId
or issueRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. Issue createSubtask(IssueForm issueForm) throws OperationFailedException, PermissionDeniedException
Issue.
A subtask is a nested
Issue.
issueForm
- the form for the subtask Issue
IllegalStateException
- issueForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- issueForm
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- issueForm
did not
originate from getSubtaskFormForCreate()
mandatory
- This method must be implemented.