OSID - osid.subscription.rules.SubscriptionEnablerRuleApplicationSession Service Interface Definition

Interface	osid.subscription.rules.SubscriptionEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods to apply `SubscriptionEnablers` to `Subscriptions`. A `Subscription` with multiple `SubscriptionEnablers` means any positive rule evaluation across the enablers result in an effective `Subscription`.
Method	getPublisherId
Description	Gets the `Publisher` `Id` associated with this session.
Return	`osid.id.Id`		the `Publisher Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPublisher
Description	Gets the `Publisher` associated with this session.
Return	`osid.subscription.Publisher`		the publisher
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignSubscriptionEnablers
Description	Tests if this user can alter subscription enabler/subscription 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	assignSubscriptionEnablerToSubscription
Description	Adds an existing `SubscriptionEnabler` to a `Subscription`.
Parameters	`osid.id.Id`	`subscriptionEnablerId`	the `Id` of the `SubscriptionEnabler`
Parameters	`osid.id.Id`	`subscriptionId`	the `Id` of the `Subscription`
Errors	ALREADY_EXISTS		`subscriptionEnablerId` is already applied to `subscriptionId`
	NOT_FOUND		`subscriptionEnablerId` or `subscriptionId` not found
	NULL_ARGUMENT		`subscriptionEnablerId` or `subscriptionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignSubscriptionEnablerFromSubscription
Description	Removes a `SubscriptionEnabler` from a `Subscription`.
Parameters	`osid.id.Id`	`subscriptionEnablerId`	the `Id` of the `SubscriptionEnabler`
Parameters	`osid.id.Id`	`subscriptionId`	the `Id` of the `Subscription`
Errors	NOT_FOUND		`subscriptionEnablerId` or `subscriptionId` not found or `subscriptionEnablerId` not applied to `subscriptionId`
	NULL_ARGUMENT		`subscriptionEnablerId` or `subscriptionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceSubscriptionEnablers
Description	Tests if this user can order `SubscriptionEnablers`. 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 `SubscriptionEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveSubscriptionEnablerAhead
Description	Reorders subscription enablers for a subscription by moving the specified subscription enabler in front of a reference subscription enabler.
Parameters	`osid.id.Id`	`subscriptionEnablerId`	the `Id` of a `SubscriptionEnabler`
	`osid.id.Id`	`subscriptionId`	the `Id` of a `Subscription`
	`osid.id.Id`	`referenceId`	the reference subscription enabler `Id`
Errors	NOT_FOUND		`subscriptionEnablerId, subscriptionId`, or `referenceId` not found or, `subscriptionEnabelrId` or `referenceId` not related to `subscriptionId`
	NULL_ARGUMENT		`subscriptionEnablerId, subscriptionId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveSubscriptionEnablerBehind
Description	Reorders subscription enablers for a subscription by moving the specified subscription enabler behind a reference subscription enabler.
Parameters	`osid.id.Id`	`subscriptionEnablerId`	the `Id` of a `SubscriptionEnabler`
	`osid.id.Id`	`subscriptionId`	the `Id` of a `Subscription`
	`osid.id.Id`	`referenceId`	the reference subscription enabler `Id`
Errors	NOT_FOUND		`subscriptionEnablerId, subscriptionId`, or `referenceId` not found or, `subscriptionEnabelrId` or `referenceId` not related to `subscriptionId`
	NULL_ARGUMENT		`subscriptionEnablerId, subscriptionId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderSubscriptionEnablers
Description	Reorders a set of subscription enablers for a subscription.
Parameters	`osid.id.Id[]`	`subscriptionEnablerIds`	the `Ids` for a set of `SubscriptionEnablers`
Parameters	`osid.id.Id`	`subscriptionId`	the `Id` of a `Subscription`
Errors	NOT_FOUND		`subscriptionId` not found or, an `subscriptionEnabelrId` not related to `subscriptionId`
	NULL_ARGUMENT		`subscriptionEnablerIds` or `subscriptionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.