Interface SubtaskIssueAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

SubtaskIssueBatchAdminSession

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.

Method Summary

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.

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.

Method Details

getFrontOfficeId

Id getFrontOfficeId()

Gets the FrontOffice Id associated with this session.

Returns:

the FrontOffice Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOffice

FrontOffice getFrontOffice()
                    throws OperationFailedException,
PermissionDeniedException

Gets the FrontOffice associated with this session.

Returns:

the front office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateSubtasks

boolean canCreateSubtasks()

Tests if this user can create subtask 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.

Returns:

false if subtask Issue creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateSubtaskWithRecordTypes

boolean canCreateSubtaskWithRecordTypes(Type[] issueRecordTypes)

Tests if this user can create a single 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.

Parameters:

issueRecordTypes - array of issue record types

Returns:

true if Issue creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - issueRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getSubtaskFormForCreate

IssueForm getSubtaskFormForCreate(Id issueId,
 Id queueId,
 Type[] issueRecordTypes)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the issue form for creating subtasks. A new form should be requested for each create transaction.

Parameters:

issueId - the Id of the Issue

queueId - the Id of the Queue in which the subtask should be created

issueRecordTypes - array of issue record types

Returns:

the issue form

Throws:

NotFoundException - issueId or queueId is not found

NullArgumentException - issueId, queueId or issueRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createSubtask

Issue createSubtask(IssueForm issueForm)
             throws OperationFailedException,
PermissionDeniedException

Creates a subtask Issue . A subtask is a nested Issue .

Parameters:

issueForm - the form for the subtask

Returns:

the new Issue

Throws:

IllegalStateException - issueForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - issueForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - issueForm did not originate from getSubtaskFormForCreate()

Compliance:

mandatory - This method must be implemented.