OSID Logo
OSID Specifications
workflow rules package
Version 3.0.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.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis 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.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 processor 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.
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.IdofficeIdthe Id of the Office
osid.id.IdprocessProcessorIdthe Id of the ProcessProcessor
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENTofficeId or processProcessorId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignProcessProcessorToOffice
Description

Adds an existing ProcessProcessor to an Office .

Parametersosid.id.IdprocessProcessorIdthe Id of the ProcessProcessor
osid.id.IdofficeIdthe Id of the Office
ErrorsALREADY_EXISTSprocessProcessorId is already assigned to officeId
NOT_FOUNDprocessProcessorId or officeId not found
NULL_ARGUMENTprocessProcessorId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignProcessProcessorFromOffice
Description

Removes a ProcessProcessor from an Office .

Parametersosid.id.IdprocessProcessorIdthe Id of the ProcessProcessor
osid.id.IdofficeIdthe Id of the Office
ErrorsNOT_FOUNDprocessProcessorId or officeId not found or processProcessorId not assigned to officeId
NULL_ARGUMENTprocessProcessorId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignProcessProcessorToOffice
Description

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

Parametersosid.id.IdprocessProcessorIdthe Id of the ProcessProcessor
osid.id.IdfromOfficeIdthe Id of the current Office
osid.id.IdtoOfficeIdthe Id of the destination Office
ErrorsALREADY_EXISTSprocessProcessorId already assigned to toOfficeId
NOT_FOUNDprocessProcessorId, fromOfficeId , or toOfficeId not found or processProcessorId not mapped to fromOfficeId
NULL_ARGUMENTprocessProcessorId, fromOfficeId , or toOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.