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

This session blocks 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.
MethodcanBlockIssues
Description

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

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

Tests if this user can block an Issue. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating the subtask will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer blocking operations to an unauthorized user.

Parametersosid.id.IdissueIdthe Id of the Issue
Returnboolean false if issue blocking is not authorized, true otherwise
ErrorsNULL_ARGUMENT issueId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the issueId is not found, then it is acceptable to return false to indicate the lack of create available.

MethodblockIssue
Description

Blocks an Issue.

Parametersosid.id.IdblockedIssueIdthe Id of the blocked Issue
osid.id.IdblockingIssueIdthe Id of the blocking Issue
ErrorsALREADY_EXISTS blockingIssueId already blocking blockedIssueId
NOT_FOUND blockedIssueId or blockingIssueId not found
NULL_ARGUMENT blockedIssueId or blockingIssueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunblockIssue
Description

Unblocks an Issue.

Parametersosid.id.IdblockedIssueIdthe Id of the blocked Issue
osid.id.IdblockingIssueIdthe Id of the blocking Issue
ErrorsNOT_FOUND blockedIssueId is not blocked by blockingIssueId
NULL_ARGUMENT blockedIssueId or blockingIssueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.