OSID - osid.calendaring.rules.CommitmentEnablerRuleApplicationSession Service Interface Definition

Interface	osid.calendaring.rules.CommitmentEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `CommitmentEnablers` to `Commitments.` A `Commitment` with multiple `CommitmentEnablers` means any positive rule evaluation across the enablers result in an effective `Commitment.`
Method	getCalendarId
Description	Gets the `Calendar` `Id` associated with this session.
Return	`osid.id.Id`		the `Calendar Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendar
Description	Gets the `Calendar` associated with this session.
Return	`osid.calendaring.Calendar`		the calendar
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignCommitmentEnablers
Description	Tests if this user can alter commitment enabler/commitment 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	assignCommitmentEnablerToCommitment
Description	Adds an existing `CommitmentEnabler` to a `Commitment.`
Parameters	`osid.id.Id`	`commitmentEnablerId`	the `Id` of the `CommitmentEnabler`
Parameters	`osid.id.Id`	`commitmentId`	the `Id` of the `Commitment`
Errors	ALREADY_EXISTS		`commitmentEnablerId` already applied to `commitmentId`
	NOT_FOUND		`commitmentEnablerId` or `commitmentId` not found
	NULL_ARGUMENT		`commitmentEnablerId` or `commitmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCommitmentEnablerFromCommitment
Description	Removes a `CommitmentEnabler` from a `Commitment.`
Parameters	`osid.id.Id`	`commitmentEnablerId`	the `Id` of the `CommitmentEnabler`
Parameters	`osid.id.Id`	`commitmentId`	the `Id` of the `Commitment`
Errors	NOT_FOUND		`commitmentEnablerId` or `commitmentId` not found or `commitmentEnablerId` not applied to `commitmentId`
	NULL_ARGUMENT		`commitmentEnablerId` or `commitmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceCommitmentEnablers
Description	Tests if this user can order `CommitmentEnablers.` 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 `CommitmentEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveCommitmentEnablerAhead
Description	Reorders commitment enablers for a commitment by moving the specified commitment enabler in front of a reference commitment enabler.
Parameters	`osid.id.Id`	`commitmentEventEnablerId`	the `Id` of a `CommitmentEnabler`
	`osid.id.Id`	`commitmentEventId`	the `Id` of a `Commitment`
	`osid.id.Id`	`referenceId`	the reference commitment enabler `Id`
Errors	NOT_FOUND		`commitmentEnablerId, commitmentId,` or `referenceId` not found or, `commitmentEnablerId` or `referenceId` not related to `commitmentId`
	NULL_ARGUMENT		`commitmentEnablerId, commitmentId` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveCommitmentEnablerBehind
Description	Reorders commitment enablers for a commitment event by moving the specified commitment enabler behind a reference commitment enabler.
Parameters	`osid.id.Id`	`commitmentEventEnablerId`	the `Id` of a `CommitmentEnabler`
	`osid.id.Id`	`commitmentEventId`	the `Id` of a `Commitment`
	`osid.id.Id`	`referenceId`	the reference commitment enabler `Id`
Errors	NOT_FOUND		`commitmentEnablerId, commitmentId,` or `referenceId` not found or, `commitmentEnablerId` or `referenceId` not related to `commitmentId`
	NULL_ARGUMENT		`commitmentEnablerId, commitmentId` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderCommitmentEnablers
Description	Reorders a set of commitment enablers for a commitment.
Parameters	`osid.id.Id[]`	`commitmentEventEnablerId`	the `Ids` for a set of `CommitmentEnablerIds`
Parameters	`osid.id.Id`	`commitmentEventId`	the `Id` of a `Commitment`
Errors	NOT_FOUND		`commitmentId` not found or, an `commitmentEnablerId` not related to `commitmentId`
	NULL_ARGUMENT		`commitmentEnablerIds` or `commitmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.