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

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

MethodcanAssignProcessConstrainerEnablers
Description

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

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignProcessConstrainerEnablerToOffice
Description

Tests if this user can alter process constrainer enabler/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.IdofficeIdthe Id of the Office
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTofficeId 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 constrainer enabler can be assigned.

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

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.id.IdprocessConstrainerEnablerIdthe Id of the ProcessConstrainerEnabler
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENTofficeId or processConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignProcessConstrainerEnablerToOffice
Description

Adds an existing ProcessConstrainerEnabler to an Office .

Parametersosid.id.IdprocessConstrainerEnablerIdthe Id of the ProcessConstrainerEnabler
osid.id.IdofficeIdthe Id of the Office
ErrorsALREADY_EXISTSprocessConstrainerEnablerId is already assigned to officeId
NOT_FOUNDprocessConstrainerEnablerId or officeId not found
NULL_ARGUMENTprocessConstrainerEnablerId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignProcessConstrainerEnablerFromOffice
Description

Removes a ProcessConstrainerEnabler from an Office .

Parametersosid.id.IdprocessConstrainerEnablerIdthe Id of the ProcessConstraienrEnabler
osid.id.IdofficeIdthe Id of the Office
ErrorsNOT_FOUNDprocessConstrainerEnablerId or officeId not found or processConstrainerEnablerId not assigned to officeId
NULL_ARGUMENTprocessConstrainerEnablerId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignProcessConstrainerEnablerToOffice
Description

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

Parametersosid.id.IdprocessConstrainerEnablerIdthe Id of the ProcessConstrainerEnabler
osid.id.IdfromOfficeIdthe Id of the current Office
osid.id.IdtoOfficeIdthe Id of the destination Office
ErrorsALREADY_EXISTSprocessConstrainerEnablerId already assigned to toOfficeId
NOT_FOUNDprocessConstrainerEnablerId, fromOfficeId , or toOfficeId not found or processConstrainerEnablerId not mapped to fromOfficeId
NULL_ARGUMENTprocessConstrainerEnablerId, fromOfficeId , or toOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.