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

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

MethodcanAssignProcessEnablers
Description

Tests if this user can alter process 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. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignProcessEnablersToOffice
Description

Tests if this user can alter process 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. This is intended as a hint to an application that may opt not to offer lookup 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 enabler 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.
MethodgetAssignableOfficeIdsForProcessEnabler
Description

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

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

Adds an existing ProcessEnabler to an Office.

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

Removes a ProcessEnabler from an Office.

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

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

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