OSID Logo
OSID Specifications
workflow package
Version 3.1.0
Interfaceosid.workflow.ProcessOfficeAssignmentSession
Implementsosid.OsidSession
Used Byosid.workflow.WorkflowManager
osid.workflow.WorkflowProxyManager
Description

This session provides methods to re-assign Process to Office mappings. A Process may appear in multiple Offices 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
Compliancemandatory This 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.IdofficeId the Id of the Office
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT officeId is null
Compliancemandatory This 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.IdofficeId the Id of the Office
Returnosid.id.IdList list of assignable office Ids
ErrorsNULL_ARGUMENT officeId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.IdofficeId the Id of the Office
osid.id.IdprocessId the Id of the Process
Returnosid.id.IdList list of assignable office Ids
ErrorsNULL_ARGUMENT officeId or processId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignProcessToOffice
Description

Adds an existing Process to an Office.

Parametersosid.id.IdprocessId the Id of the Process
osid.id.IdofficeId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignProcessFromOffice
Description

Removes a Process from an Office.

Parametersosid.id.IdprocessId the Id of the Process
osid.id.IdofficeId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignProcessToOffice
Description

Moves a Process from one Office to another. Mappings to other Offices are unaffected.

Parametersosid.id.IdprocessId the Id of the Process
osid.id.IdfromOfficeId the Id of the current Office
osid.id.IdtoOfficeId the Id of the destination Office
ErrorsALREADY_EXISTS processId, already assigned to toOfficeId
NOT_FOUND processId, fromOfficeId, or toOfficeId not found or processId not mapped to fromOfficeId
NULL_ARGUMENT processId, fromOfficeId, or toOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.