OSID - osid.offering.rules.OfferingConstrainerEnablerRuleApplicationSession Service Interface Definition

Interface	osid.offering.rules.OfferingConstrainerEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `OfferingConstrainerEnablers` to `OfferingConstrainers.` An `OfferingConstrainer` with multiple `OfferingConstrainerEnablers` means any positive rule evaluation across the enablers result in an effective `OfferingConstrainer.`
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignOfferingConstrainerEnablers
Description	Tests if this user can alter offering constrainer enabler/offering constrainer 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	assignOfferingConstrainerEnablerToOfferingConstrainer
Description	Adds an existing `OfferingConstrainerEnabler` to an `OfferingConstrainer.`
Parameters	`osid.id.Id`	`offeringConstrainerEnablerId`	the `Id` of the `OfferingConstrainerEnabler`
Parameters	`osid.id.Id`	`offeringConstrainerId`	the `Id` of the `OfferingConstrainer`
Errors	ALREADY_EXISTS		`offeringConstrainerEnablerId` already applied to `offeringConstrainerId`
	NOT_FOUND		`offeringConstrainerEnablerId` or `offeringConstrainerId` not found
	NULL_ARGUMENT		`offeringConstrainerEnablerId` or `offeringConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignOfferingConstrainerEnablerFromOfferingConstrainer
Description	Removes an `OfferingConstrainerEnabler` from an `OfferingConstrainer.`
Parameters	`osid.id.Id`	`offeringConstrainerEnablerId`	the `Id` of the `OfferingConstrainerEnabler`
Parameters	`osid.id.Id`	`offeringConstrainerId`	the `Id` of the `OfferingConstrainer`
Errors	NOT_FOUND		`offeringConstrainerEnablerId` or `offeringConstrainerId` not found or `offeringConstrainerEnablerId` not applied to `offeringConstrainerId`
	NULL_ARGUMENT		`offeringConstrainerEnablerId` or `offeringConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceOfferingConstrainerEnablers
Description	Tests if this user can order `OfferingConstrainerEnablers.` 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 `OfferingConstrainerEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveOfferingConstrainerEnablerAhead
Description	Reorders offering constrainer enablers for an offering constrainer by moving the specified offering constrainer enabler in front of a reference offering constrainer enabler.
Parameters	`osid.id.Id`	`offeringConstrainerEnablerId`	the `Id` of an `OfferingConstrainerEnabler`
	`osid.id.Id`	`offeringConstrainerId`	the `Id` of an `OfferingConstrainer`
	`osid.id.Id`	`referenceId`	the reference offering constrainer enabler `Id`
Errors	NOT_FOUND		`offeringConstrainerEnablerId, offeringConstrainerId,` or `referenceId` not found or, `offeringConstrainerEnablerId` or `referenceId` not related to `offeringConstrainerId`
	NULL_ARGUMENT		`offeringConstrainerEnablerId, offeringConstrainerId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveOfferingConstrainerEnablerBehind
Description	Reorders offering constrainer enablers for a canonical unit by moving the specified offering constrainer enabler behind a reference offering constrainer enabler.
Parameters	`osid.id.Id`	`offeringConstrainerEnablerId`	the `Id` of an `OfferingConstrainerEnabler`
	`osid.id.Id`	`offeringConstrainerId`	the `Id` of an `OfferingConstrainer`
	`osid.id.Id`	`referenceId`	the reference offering constrainer enabler `Id`
Errors	NOT_FOUND		`offeringConstrainerEnablerId, offeringConstrainerId,` or `referenceId` not found or, `offeringConstrainerEnablerId` or `referenceId` not related to `offeringConstrainerId`
	NULL_ARGUMENT		`offeringConstrainerEnablerId, offeringConstrainerId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderOfferingConstrainerEnablers
Description	Reorders a set of offering constrainer enablers for an offering constrainer.
Parameters	`osid.id.Id[]`	`offeringConstrainerEnablerIds`	the `Ids` for a set of `OfferingConstrainerEnablers`
Parameters	`osid.id.Id`	`offeringConstrainerId`	the `Id` of an `OfferingConstrainer`
Errors	NOT_FOUND		`canonicalUnitConstraienrId` not found or, an `offeringConstrainerEnablerId` not related to `offeringConstrainerId`
	NULL_ARGUMENT		`offeringConstrainerEnablerIds` or `offeringConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.