OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.WorkOfficeAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Works to Office mappings. A Work may appear in multiple Office objects and removing the last reference to a Work is the equivalent of deleting it. Each Office may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Work to another Office is not a copy operation (eg: does not change its Id ).

MethodcanAssignWorks
Description

Tests if this user can alter work/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
CompliancemandatoryThis method must be implemented.
MethodcanAssignWorksToOffice
Description

Tests if this user can alter work/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.IdofficeIdthe Id of the Office
Returnboolean false if workflow is not authorized, true otherwise
ErrorsNULL_ARGUMENT officeId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableOfficeIds
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableOfficeIdsForWork
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.id.IdworkIdthe Id of the Work
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENT officeId or workId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignWorkToOffice
Description

Adds an existing Work to a Office.

Parametersosid.id.IdworkIdthe Id of the Work
osid.id.IdofficeIdthe Id of the Office
ErrorsALREADY_EXISTS workId is already assigned to officeId
NOT_FOUND workId or officeId not found
NULL_ARGUMENT workId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignWorkFromOffice
Description

Removes a Work from a Office.

Parametersosid.id.IdworkIdthe Id of the Work
osid.id.IdofficeIdthe Id of the Office
ErrorsNOT_FOUND workId or officeId not found or workId not assigned to officeId
NULL_ARGUMENT workId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.