OSID - osid.workflow.rules.ProcessEnablerRuleApplicationSession Service Interface Definition

Interface	osid.workflow.rules.ProcessEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `ProcessEnablers` to `Processs.` A `Process` with multiple `ProcessEnablers` means any positive rule evaluation across the constrainers result in an accessible `Process.`
Method	getOfficeId
Description	Gets the `Office` `Id` associated with this session.
Return	`osid.id.Id`		the `Office Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOffice
Description	Gets the `Office` associated with this session.
Return	`osid.workflow.Office`		the office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignProcessEnablers
Description	Tests if this user can alter process enabler/process 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.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignProcessEnablerToProcess
Description	Adds an existing `ProcessEnabler` to a `Process.`
Parameters	`osid.id.Id`	`processEnablerId`	the `Id` of the `ProcessEnabler`
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process`
Errors	ALREADY_EXISTS		`processEnablerId` is already applied to `processId`
	NOT_FOUND		`processEnablerId` or `processId` not found
	NULL_ARGUMENT		`processEnablerId` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignProcessEnablerFromProcess
Description	Removes a `ProcessEnabler` from a `Process.`
Parameters	`osid.id.Id`	`processEnablerId`	the `Id` of the `ProcessEnabler`
Parameters	`osid.id.Id`	`processId`	the `Id` of the `Process`
Errors	NOT_FOUND		`processEnablerId` or `processId` not found or `processEnablerId` not applied to `processId`
	NULL_ARGUMENT		`processEnablerId` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceProcessEnablers
Description	Tests if this user can order `ProcessEnablers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `ProcessEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveProcessEnablerAhead
Description	Reorders process enablers for a process by moving the specified process enabler in front of a reference process enabler.
Parameters	`osid.id.Id`	`processEnablerId`	the `Id` of a `ProcessEnabler`
	`osid.id.Id`	`processId`	the `Id` of a `Process`
	`osid.id.Id`	`referenceId`	the reference process enabler `Id`
Errors	NOT_FOUND		`processEnablerId, processId,` or `referenceId` not found or, `processEnablerId` or `referenceId` not related to `processId`
	NULL_ARGUMENT		`processEnablerId, processId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveProcessEnablerBehind
Description	Reorders process enablers for a process by moving the specified process enabler behind a reference process enabler.
Parameters	`osid.id.Id`	`processEnablerId`	the `Id` of a `ProcessEnabler`
	`osid.id.Id`	`processId`	the `Id` of a `Process`
	`osid.id.Id`	`referenceId`	the reference process enabler `Id`
Errors	NOT_FOUND		`processEnablerId, processId,` or `referenceId` not found or, `processEnablerId` or `referenceId` not related to `processId`
	NULL_ARGUMENT		`processEnablerId, processId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderProcessEnablers
Description	Reorders a set of process enablers for a process.
Parameters	`osid.id.Id[]`	`processEnablerIds`	the `Ids` for a set of `ProcessEnablers`
Parameters	`osid.id.Id`	`processId`	the `Id` of a `Process`
Errors	NOT_FOUND		`processId` not found or, an `processEnablerId` not related to `processId`
	NULL_ARGUMENT		`processEnabelrIds` or `processId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.