OSID - osid.control.rules.ActionEnablerRuleApplicationSession Service Interface Definition

Interface	osid.control.rules.ActionEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `ActionEnablers` to `Actions.` An `Action` with multiple `ActionEnablers` means any positive rule evaluation across the enablers result in an active `Action.`
Method	getSystemId
Description	Gets the `System` `Id` associated with this session.
Return	`osid.id.Id`		the `System Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSystem
Description	Gets the `System` associated with this session.
Return	`osid.control.System`		the system
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignActionEnablers
Description	Tests if this user can alter action enabler/action 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	assignActionEnablerToAction
Description	Adds an existing `ActionEnabler` to an `Action.`
Parameters	`osid.id.Id`	`actionEnablerId`	the `Id` of the `ActionEnabler`
Parameters	`osid.id.Id`	`actionId`	the `Id` of the `Action`
Errors	ALREADY_EXISTS		`actionEnablerId` already applied to `actionId`
	NOT_FOUND		`actionEnablerId` or `actionId` not found
	NULL_ARGUMENT		`actionEnablerId` or `actionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignActionEnablerFromAction
Description	Removes an `ActionEnabler` from an `Action.`
Parameters	`osid.id.Id`	`actionEnablerId`	the `Id` of the `ActionEnabler`
Parameters	`osid.id.Id`	`actionId`	the `Id` of the `Action`
Errors	NOT_FOUND		`actionEnablerId` or `actionId` not found or `actionEnablerId` not applied to `actionId`
	NULL_ARGUMENT		`actionEnablerId` or `actionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceActionEnablers
Description	Tests if this user can order `ActionEnablers.` 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 `ActionEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveActionEnablerAhead
Description	Reorders action enablers for an action by moving the specified action enabler in front of a reference action enabler.
Parameters	`osid.id.Id`	`actionEnablerId`	the `Id` of an `ActionEnabler`
	`osid.id.Id`	`actionId`	the `Id` of an `Action`
	`osid.id.Id`	`referenceId`	the reference action enabler `Id`
Errors	NOT_FOUND		`actionEnablerId, actionId,` or `referenceId` not found or, `actionEnablerId` or `referenceId` not related to `actionId`
	NULL_ARGUMENT		`actionEnablerId, actionId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveActionEnablerBehind
Description	Reorders action enablers for an action by moving the specified action enabler behind a reference action enabler.
Parameters	`osid.id.Id`	`actionEnablerId`	the `Id` of an `ActionEnabler`
	`osid.id.Id`	`actionId`	the `Id` of an `Action`
	`osid.id.Id`	`referenceId`	the reference action enabler `Id`
Errors	NOT_FOUND		`actionEnablerId, actionId,` or `referenceId` not found or, `actionEnablerId` or `referenceId` not related to `actionId`
	NULL_ARGUMENT		`actionEnablerId, actionId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderActionEnablers
Description	Reorders a set of action enablers for an action.
Parameters	`osid.id.Id[]`	`actionEnablerIds`	the `Ids` for a set of `ActionEnablers`
Parameters	`osid.id.Id`	`actionId`	the `Id` of an `Action`
Errors	NOT_FOUND		`actionEnablerId` not found or, an `actionEnablerId` not related to `actionId`
	NULL_ARGUMENT		`actionEnablerIds` or `actionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.