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

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

MethodcanAssignStepEnablers
Description

Tests if this user can alter step 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.
MethodcanAssignStepEnablerToOffice
Description

Tests if this user can alter step 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 step 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.
MethodgetAssignableOfficeIdsForStepEnabler
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.id.IdstepEnablerIdthe Id of the StepEnabler
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENTofficeId or stepEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignStepEnablerToOffice
Description

Adds an existing StepEnabler to an Office .

Parametersosid.id.IdstepEnablerIdthe Id of the StepEnabler
osid.id.IdofficeIdthe Id of the Office
ErrorsALREADY_EXISTSstepEnablerId is already assigned to officeId
NOT_FOUNDstepEnablerId or officeId not found
NULL_ARGUMENTstepEnablerId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignStepEnablerFromOffice
Description

Removes a StepEnabler from an Office .

Parametersosid.id.IdstepEnablerIdthe Id of the StepEnabler
osid.id.IdofficeIdthe Id of the Office
ErrorsNOT_FOUNDstepEnablerId or officeId not found or stepEnablerId not assigned to officeId
NULL_ARGUMENTstepEnablerId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignStepEnablerToOffice
Description

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

Parametersosid.id.IdstepEnablerIdthe Id of the StepEnabler
osid.id.IdfromOfficeIdthe Id of the current Office
osid.id.IdtoOfficeIdthe Id of the destination Office
ErrorsALREADY_EXISTSstepEnablerId already assigned to toOfficeId
NOT_FOUNDstepEnablerId, fromOfficeId , or toOfficeId not found or stepEnablerId not mapped to fromOfficeId
NULL_ARGUMENTstepEnablerId, fromOfficeId , or toOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.