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

Interface	osid.offering.rules.OfferingConstrainerEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.offering.rules.OfferingRulesManager`
Used By	`osid.offering.rules.OfferingRulesProxyManager`
Description	This session creates and removes offering constrainer enablers. The data for create and update is provided via the `OfferingConstrainerEnablerForm`.
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	canCreateOfferingConstrainerEnabler
Description	Tests if this user can create offering constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `OfferingConstrainerEnabler` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `OfferingConstrainerEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOfferingConstrainerEnablerWithRecordTypes
Description	Tests if this user can create a single `OfferingConstrainerEnabler` using the desired record types. While `OfferingRulesManager.getOfferingConstrainerEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `OfferingConstrainerEnabler`. Providing an empty array tests if an `OfferingConstrainerEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`offeringConstrainerEnablerRecordTypes`	array of offering constrainer enabler record types
Return	`boolean`		`true` if `OfferingConstrainerEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`offeringConstrainerEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainerEnablerFormForCreate
Description	Gets the offering constrainer enabler form for creating new offering constrainer enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`offeringConstrainerEnablerRecordTypes`	array of offering constrainer enabler record types
Return	`osid.offering.rules.OfferingConstrainerEnablerForm`		the offering constrainer enabler form
Errors	NULL_ARGUMENT		`offeringConstrainerEnablerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createOfferingConstrainerEnabler
Description	Creates a new `OfferingConstrainerEnabler`.
Parameters	`osid.offering.rules.OfferingConstrainerEnablerForm`	`offeringConstrainerEnablerForm`	the form for this `OfferingConstrainerEnabler`
Return	`osid.offering.rules.OfferingConstrainerEnabler`		the new `OfferingConstrainerEnabler`
Errors	ILLEGAL_STATE		`offeringConstrainerEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`offeringConstrainerEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`offeringConstrainerEnablerForm did not originate from getOfferingConstrainerEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateOfferingConstrainerEnablers
Description	Tests if this user can update offering constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `OfferingConstrainerEnabler` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `OfferingConstrainerEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainerEnablerFormForUpdate
Description	Gets the offering constrainer enabler form for updating an existing offering constrainer enabler. A new offering constrainer enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`offeringConstrainerEnablerId`	the `Id` of the `OfferingConstrainerEnabler`
Return	`osid.offering.rules.OfferingConstrainerEnablerForm`		the offering constrainer enabler form
Errors	NOT_FOUND		`offeringConstrainerEnablerId` is not found
	NULL_ARGUMENT		`offeringConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateOfferingConstrainerEnabler
Description	Updates an existing offering constrainer enabler.
Parameters	`osid.offering.rules.OfferingConstrainerEnablerForm`	`offeringConstrainerEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`offeringConstrainerEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`offeringConstrainerEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`offeringConstrainerEnablerForm` did not originate from `getOfferingConstrainerEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteOfferingConstrainerEnablers
Description	Tests if this user can delete offering constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `OfferingConstrainerEnabler` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `OfferingConstrainerEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteOfferingConstrainerEnabler
Description	Deletes an `OfferingConstrainerEnabler`.
Parameters	`osid.id.Id`	`offeringConstrainerEnablerId`	the `Id` of the `OfferingConstrainerEnabler` to remove
Errors	NOT_FOUND		`offeringConstrainerEnablerId` not found
	NULL_ARGUMENT		`offeringConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageOfferingConstrainerEnablerAliases
Description	Tests if this user can manage `Id` aliases for offering constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `OfferingConstrainerEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasOfferingConstrainerEnabler
Description	Adds an `Id` to an `OfferingConstrainerEnabler` for the purpose of creating compatibility. The primary `Id` of the `OfferingConstrainerEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another offering constrainer enabler. it is reassigned to the given offering constrainer enabler `Id`.
Parameters	`osid.id.Id`	`offeringConstrainerEnablerId`	the `Id` of an `OfferingConstrainerEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`offeringConstrainerEnablerId` not found
	NULL_ARGUMENT		`offeringConstrainerEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.