OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepConstrainerEnablerOfficeAssignmentSession
Implementsosid.OsidSession
Description

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

MethodcanAssignStepConstrainerEnablers
Description

Tests if this user can alter step constrainer 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
CompliancemandatoryThis method must be implemented.
MethodcanAssignStepConstrainerEnablersToOffice
Description

Tests if this user can alter step constrainer 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.IdofficeIdthe Id of the Office
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT officeId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableOfficeIds
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableOfficeIdsForStepConstrainerEnabler
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.id.IdstepConstrainerEnablerIdthe Id of the StepConstrainerEnabler
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENT officeId or stepConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignStepConstrainerEnablerToOffice
Description

Adds an existing StepConstrainerEnabler to an Office.

Parametersosid.id.IdstepConstrainerEnablerIdthe Id of the StepConstrainerEnabler
osid.id.IdofficeIdthe Id of the Office
ErrorsALREADY_EXISTS stepConstrainerEnablerId is already assigned to officeId
NOT_FOUND stepConstrainerEnablerId or officeId not found
NULL_ARGUMENT stepConstrainerEnablerId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignStepConstrainerEnablerFromOffice
Description

Removes a StepConstrainerEnabler from an Office.

Parametersosid.id.IdstepConstrainerEnablerIdthe Id of the StepConstrainerEnabler
osid.id.IdofficeIdthe Id of the Office
ErrorsNOT_FOUND stepConstrainerEnablerId or officeId not found or stepConstrainerEnablerId not assigned to officeId
NULL_ARGUMENT stepConstrainerEnablerId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignStepConstrainerEnablerToOffice
Description

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

Parametersosid.id.IdstepConstrainerEnablerIdthe Id of the StepConstrainerEnabler
osid.id.IdfromOfficeIdthe Id of the current Office
osid.id.IdtoOfficeIdthe Id of the destination Office
ErrorsNOT_FOUND stepConstrainerEnablerId, fromOfficeId, or toOfficeId not found or stepConstrainerEnablerId not mapped to fromOfficeId
NULL_ARGUMENT stepConstrainerEnablerId, fromOfficeId, or toOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.