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

This session provides methods to re-assign Process to Office mappings. A Process may appear in multiple Office objects and removing the last reference to a Process 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 Process to another Office is not a copy operation (eg: does not change its Id ).

MethodcanAssignProcesses
Description

Tests if this user can alter process/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.
MethodcanAssignProcessesToOffice
Description

Tests if this user can alter process/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 mapping 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 process 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.
MethodgetAssignableOfficeIdsForProcess
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.id.IdprocessIdthe Id of the Process
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENT officeId or processId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignProcessToOffice
Description

Adds an existing Process to a Office.

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

Removes a Process from a Office.

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