OSID Logo
OSID Specifications
workflow rules package
Version 3.1.0
Interfaceosid.workflow.rules.ProcessConstrainerOfficeAssignmentSession
Implementsosid.OsidSession
Used Byosid.workflow.rules.WorkflowRulesManager
osid.workflow.rules.WorkflowRulesProxyManager
Description

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

MethodcanAssignProcessConstrainers
Description

Tests if this user can alter process constrainer/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. T his 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.
MethodcanAssignProcessConstrainerToOffice
Description

Tests if this user can alter process constrainer/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. T his 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 constrainer 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.
MethodgetAssignableOfficeIdsForProcessConstrainer
Description

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

Parametersosid.id.IdofficeId the Id of the Office
osid.id.IdprocessConstrainerId the Id of the ProcessConstrainer
Returnosid.id.IdList list of assignable office Ids
ErrorsNULL_ARGUMENT officeId or processConstrainerId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignProcessConstrainerToOffice
Description

Adds an existing ProcessConstrainer to an Office.

Parametersosid.id.IdprocessConstrainerId the Id of the ProcessConstrainer
osid.id.IdofficeId the Id of the Office
ErrorsALREADY_EXISTS processConstrainerId is already assigned to officeId
NOT_FOUND processConstrainerId or officeId not found
NULL_ARGUMENT processConstrainerId or officeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignProcessConstrainerFromOffice
Description

Removes a ProcessConstrainer from an Office.

Parametersosid.id.IdprocessConstrainerId the Id of the ProcessConstraienr
osid.id.IdofficeId the Id of the Office
ErrorsNOT_FOUND processConstrainerId or officeId not found or processConstrainerId not assigned to officeId
NULL_ARGUMENT processConstrainerId or officeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignProcessConstrainerToOffice
Description

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

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