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

Interface	osid.calendaring.rules.OffsetEventEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session provides methods to apply `OffsetEventEnablers` to `OffsetEvents`. An `OffsetEvent` with multiple `OffsetEventEnablers` means any positive rule evaluation across the enablers result in an effective `OffsetEvent`.
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	canAssignOffsetEventEnablerRules
Description	Tests if this user can alter offset event enabler/offset event 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	assignOffsetEventEnablerToOffsetEvent
Description	Adds an existing `OffsetEventEnabler` to an `OffsetEvents`.
Parameters	`osid.id.Id`	`offsetEventEnablerId`	the `Id` of the `OffsetEventEnabler`
Parameters	`osid.id.Id`	`offsetEventId`	the `Id` of the `OffsetEvent`
Errors	ALREADY_EXISTS		`offsetEventEnablerId` already applied to `offsetEventId`
	NOT_FOUND		`offsetEventEnablerId` or `offsetEventId` not found
	NULL_ARGUMENT		`offsetEventEnablerId` or `offsetEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignOffsetEventEnablerFromOffsetEvent
Description	Removes an `OffsetEventEnabler` from an `OffsetEvent`.
Parameters	`osid.id.Id`	`offsetEventEnablerId`	the `Id` of the `OffsetEventEnabler`
Parameters	`osid.id.Id`	`offsetEventId`	the `Id` of the `OffsetEvent`
Errors	NOT_FOUND		`offsetEventEnablerId` or `offsetEventId` not found or `offsetEventEnablerId` not applied to `offsetEventId`
	NULL_ARGUMENT		`offsetEventEnablerId` or `offsetEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceOffsetEventEnablers
Description	Tests if this user can order `OffsetEventEnablers`. 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 `OffsetEventEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveOffsetEventEnablerAhead
Description	Reorders offset event enablers for an offset event by moving the specified offset event enabler in front of a reference offset event enabler.
Parameters	`osid.id.Id`	`offsetEventEnablerId`	the `Id` of an `OffsetEventEnabler`
	`osid.id.Id`	`offsetEventId`	the `Id` of an `OffsetEvent`
	`osid.id.Id`	`referenceId`	the reference offset event enabler `Id`
Errors	NOT_FOUND		`offsetEventEnablerId, offsetEventId`, or `referenceId` not found or, `offsetEventEnablerId` or `referenceId` not related to `offsetEventId`
	NULL_ARGUMENT		`offsetEventEnablerId, offsetEventId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveOffsetEventEnablerBehind
Description	Reorders offset event enablers for an offset event by moving the specified offset event enabler behind a reference offset event enabler.
Parameters	`osid.id.Id`	`offsetEventEnablerId`	the `Id` of an `OffsetEventEnabler`
	`osid.id.Id`	`offsetEventId`	the `Id` of an `OffsetEvent`
	`osid.id.Id`	`referenceId`	the reference offset event enabler `Id`
Errors	NOT_FOUND		`offsetEventEnablerId, offsetEventId`, or `referenceId` not found or, `offsetEventEnablerId` or `referenceId` not related to `offsetEventId`
	NULL_ARGUMENT		`offsetEventEnablerId, offsetEventId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderOffsetEventEnablers
Description	Reorders a set of offset event enablers for an offset event.
Parameters	`osid.id.Id[]`	`offsetEventEnablerIds`	the `Ids` for a set of `OffsetEventEnablers`
Parameters	`osid.id.Id`	`offsetEventId`	the `Id` of an `OffsetEvent`
Errors	NOT_FOUND		`offsetEventId` not found or, an `offsetEventEnablerId` not related to `offsetEventId`
	NULL_ARGUMENT		`offsetEventEnablerIds` or `offsetEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.