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

Interface	osid.calendaring.rules.SupersedingEventEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session provides methods to apply `SupersedingEventEnablers` to `SupersedingEvents`. A `SupersedingEvent` with multiple `SupersedingEventEnablers` means any positive rule evaluation across the enablers result in an effective `SupersedingEvent`.
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	canAssignSupersedingEventEnablers
Description	Tests if this user can alter superseding event enabler/superseding 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	assignSupersedingEventEnablerToSupersedingEvent
Description	Adds an existing `SupersedingEventEnabler` to a `SupersedingEvent`.
Parameters	`osid.id.Id`	`supersedingEventEnablerId`	the `Id` of the `SupersedingEventEnabler`
Parameters	`osid.id.Id`	`supersedingEventId`	the `Id` of the `SupersedingEvent`
Errors	ALREADY_EXISTS		`supersedingEventEnablerId` already applied to `supersedingEventId`
	NOT_FOUND		`supersedingEventEnablerId` or `supersedingEventId` not found
	NULL_ARGUMENT		`supersedingEventEnablerId` or `supersedingEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignSupersedingEventEnablerFromSupersedingEvent
Description	Removes a `SupersedingEventEnabler` from a `SupersedingEvent`.
Parameters	`osid.id.Id`	`supersedingEventEnablerId`	the `Id` of the `SupersedingEventEnabler`
Parameters	`osid.id.Id`	`supersedingEventId`	the `Id` of the `Calendar`
Errors	NOT_FOUND		`supersedingEventEnablerId` or `supersedingEventId` not found or `supersedingEventEnablerId` not applied to `supersedingEventId`
	NULL_ARGUMENT		`supersedingEventEnablerId` or `supersedingEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceSupersedingEventEnablers
Description	Tests if this user can order `SupersedingEventEnablers`. 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 `SupersedingEventEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveSupersedingEventEnablerAhead
Description	Reorders superseding event enablers for a superseding event by moving the specified superseding event enabler in front of a reference superseding event enabler.
Parameters	`osid.id.Id`	`supersedingEventEnablerId`	the `Id` of a `SupersedingEventEnabler`
	`osid.id.Id`	`supersedingEventId`	the `Id` of a `SupersedingEvent`
	`osid.id.Id`	`referenceId`	the reference superseding event enabler `Id`
Errors	NOT_FOUND		`supersedingEventEnablerId, supersedingEventId`, or `referenceId` not found or, `supersedingEventEnablerId` or `referenceId` not related to `supersedingEventId`
	NULL_ARGUMENT		`supersedingEventEnablerId, supersedingEventId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveSupersedingEventEnablerBehind
Description	Reorders superseding event enablers for a superseding event by moving the specified superseding event enabler behind a reference superseding event enabler.
Parameters	`osid.id.Id`	`supersedingEventEnablerId`	the `Id` of a `SupersedingEventEnabler`
	`osid.id.Id`	`supersedingEventId`	the `Id` of a `SupersedingEvent`
	`osid.id.Id`	`referenceId`	the reference superseding event enabler `Id`
Errors	NOT_FOUND		`supersedingEventEnablerId, supersedingEventId`, or `referenceId` not found or, `supersedingEventEnablerId` or `referenceId` not related to `supersedingEventId`
	NULL_ARGUMENT		`supersedingEventEnablerId, supersedingEventId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderSupersedingEventEnablers
Description	Reorders a set of superseding event enablers for a superseding event.
Parameters	`osid.id.Id[]`	`supersedingEventEnablerIds`	the `Ids` for a set of `SupersedingEventEnablerIds`
Parameters	`osid.id.Id`	`supersedingEventId`	the `Id` of a `SupersedingEvent`
Errors	NOT_FOUND		`supersedingEventId` not found or, an `supersedingEventEnablerId` not related to `supersedingEventId`
	NULL_ARGUMENT		`supersedingEventEnablerIds` or `supersedingEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.