OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.SubtaskIssueAdminSession
Implementsosid.OsidSession
Description

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.

MethodgetFrontOfficeId
Description

Gets the FrontOffice Id associated with this session.

Returnosid.id.Idthe FrontOffice Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFrontOffice
Description

Gets the FrontOffice associated with this session.

Returnosid.tracking.FrontOfficethe front office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateSubtasks
Description

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.

Returnboolean false if subtask Issue creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateSubtaskWithRecordTypes
Description

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.

Parametersosid.type.Type[]issueRecordTypesarray of issue record types
Returnboolean true if Issue creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT issueRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetSubtaskFormForCreate
Description

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

Parametersosid.id.IdissueIdthe Id of the Issue
osid.id.IdqueueIdthe Id of the Queue in which the subtask should be created
osid.type.Type[]issueRecordTypesarray of issue record types
Returnosid.tracking.IssueFormthe issue form
ErrorsNOT_FOUND issueId or queueId is not found
NULL_ARGUMENT issueId, queueId or issueRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateSubtask
Description

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

Parametersosid.tracking.IssueFormissueFormthe form for the subtask
Returnosid.tracking.Issuethe new Issue
ErrorsILLEGAL_STATE issueForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT issueForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED issueForm did not originate from getSubtaskFormForCreate()
CompliancemandatoryThis method must be implemented.