OSID Logo
OSID Specifications
tracking package
Version 3.1.0
Interfaceosid.tracking.IssueFrontOfficeAssignmentSession
Implementsosid.OsidSession
Used Byosid.tracking.TrackingManager
osid.tracking.TrackingProxyManager
Description

This session provides methods to re-assign Issues to FrontOffice objects. An Issue may appear in multiple FrontOffice objects and removing the last reference to an Issue is the equivalent of deleting it. Each FrontOffice may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Issue to another FrontOffice is not a copy operation (eg: does not change its Id).

MethodcanAssignIssues
Description

Tests if this user can alter issue/front office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignIssuesToFrontOffice
Description

Tests if this user can alter issue/front office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT frontOfficeId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableFrontOfficeIds
Description

Gets a list of front offices including and under the given front office node in which any issue can be assigned.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice
Returnosid.id.IdList list of assignable front office Ids
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableFrontOfficeIdsForIssue
Description

Gets a list of front offices including and under the given front office node in which a specific issue can be assigned.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice
osid.id.IdissueId the Id of the Issue
Returnosid.id.IdList list of assignable front office Ids
ErrorsNULL_ARGUMENT frontOfficeId or issueId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignIssueToFrontOffice
Description

Adds an existing Issue to a FrontOffice.

Parametersosid.id.IdissueId the Id of the Issue
osid.id.IdfrontOfficeId the Id of the FrontOffice
ErrorsALREADY_EXISTS issueId is already assigned to frontOfficeId
NOT_FOUND issueId or frontOfficeId not found
NULL_ARGUMENT issueId or frontOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignIssueFromFrontOffice
Description

Removes an Issue from a FrontOffice.

Parametersosid.id.IdissueId the Id of the Issue
osid.id.IdfrontOfficeId the Id of the FrontOffice
ErrorsNOT_FOUND issueId or frontOfficeId not found or issueId not assigned to frontOfficeId
NULL_ARGUMENT issueId or frontOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignIssueToFrontOffice
Description

Moves an Issue from one FrontOffice to another. Mappings to other FrontOffices are unaffected.

Parametersosid.id.IdissueId the Id of the Issue
osid.id.IdfromFrontOfficeId the Id of the current FrontOffice
osid.id.IdtoFrontOfficeId the Id of the destination FrontOffice
ErrorsALREADY_EXISTS issueId already assigned to toFrontOfficeId
NOT_FOUND issueId, fromFrontOfficeId, or toFrontOfficeId not found or issueId not mapped to fromFrontOfficeId
NULL_ARGUMENT issueId, fromFrontOfficeId, or toFrontOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.