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

This session branches issues.

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.
MethodcanBranchIssues
Description

Tests if this user can branch 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 branching operations to an unauthorized user.

Returnboolean false if Issue branching is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodbranchIssue
Description

Branches an Issue. The new issue is initialized with all the data from the root issue except for the log entries.

Parametersosid.id.IdissueIdthe Id of the Issue
Returnosid.tracking.Issuethe new Issue
ErrorsNOT_FOUND issueId not found
NULL_ARGUMENT issueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcopyLogEntry
Description

Copies a log entry from the root issue to be visible in the branched issue.

Parametersosid.id.IdbranchedIssueIdthe Id of the Issue
osid.id.IdlogEntryIdthe Id of the Issue
ErrorsALREADY_EXISTS branchedIssueId already has logEntryId
NOT_FOUND branchedIssueId or logEntryId not found
NULL_ARGUMENT branchedIssueId or logEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveLogEntry
Description

Removes a log entry from the branch issue.

Parametersosid.id.IdbranchedIssueIdthe Id of the Issue
osid.id.IdlogEntryIdthe Id of the Issue
ErrorsNOT_FOUND logEntryId is not in branchedIssueId
NULL_ARGUMENT branchedIssueId or logEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.