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

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

MethodcanAssignProcessProcessorEnablers
Description

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

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

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

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

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

Adds an existing ProcessProcessorEnabler to an Office.

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

Removes a ProcessProcessorEnabler from an Office.

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

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

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