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

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

MethodcanAssignProcessProcessors
Description

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

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

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

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

Adds an existing ProcessProcessor to an Office.

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

Removes a ProcessProcessor from an Office.

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

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

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