OSID - osid.ordering.rules.PriceEnablerAdminSession Service Interface Definition

Interface	osid.ordering.rules.PriceEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes price enablers. The data for create and update is provided via the `PriceEnablerForm.`
Method	getStoreId
Description	Gets the `Store` `Id` associated with this session.
Return	`osid.id.Id`		the `Store Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getStore
Description	Gets the `Store` associated with this session.
Return	`osid.ordering.Store`		the store
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePriceEnabler
Description	Tests if this user can create price enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `PriceEnabler` 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 `PriceEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePriceEnablerWithRecordTypes
Description	Tests if this user can create a single `PriceEnabler` using the desired record types. While `OrderingRulesManager.getPriceEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `PriceEnabler.` Providing an empty array tests if a `PriceEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`priceEnablerRecordTypes`	array of price enabler record types
Return	`boolean`		`true` if `PriceEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`priceEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablerFormForCreate
Description	Gets the price enabler form for creating new price enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`priceEnablerRecordTypes`	array of price enabler record types
Return	`osid.ordering.rules.PriceEnablerForm`		the price enabler form
Errors	NULL_ARGUMENT		`priceEnablerRecordTypes` 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	createPriceEnabler
Description	Creates a new `PriceEnabler.`
Parameters	`osid.ordering.rules.PriceEnablerForm`	`priceEnablerForm`	the form for this `PriceEnabler`
Return	`osid.ordering.rules.PriceEnabler`		the new `PriceEnabler`
Errors	ILLEGAL_STATE		`priceEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`priceEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceEnablerForm` did not originate from `getPriceEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePriceEnablers
Description	Tests if this user can update price enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `PriceEnabler` 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 `PriceEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPriceEnablerFormForUpdate
Description	Gets the price enabler form for updating an existing price enabler. A new price enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`priceEnablerId`	the `Id` of the `PriceEnabler`
Return	`osid.ordering.rules.PriceEnablerForm`		the price enabler form
Errors	NOT_FOUND		`priceEnablerId` is not found
	NULL_ARGUMENT		`priceEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePriceEnabler
Description	Updates an existing price enabler.
Parameters	`osid.ordering.rules.PriceEnablerForm`	`priceEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`priceEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`priceEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceEnablerForm` did not originate from `getPriceEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePriceEnablers
Description	Tests if this user can delete price enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `PriceEnabler` 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 `PriceEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePriceEnabler
Description	Deletes a `PriceEnabler.`
Parameters	`osid.id.Id`	`priceEnablerId`	the `Id` of the `PriceEnabler` to remove
Errors	NOT_FOUND		`priceEnablerId` not found
	NULL_ARGUMENT		`priceEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePriceEnablerAliases
Description	Tests if this user can manage `Id` aliases for price 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 `PriceEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPriceEnabler
Description	Adds an `Id` to a `PriceEnabler` for the purpose of creating compatibility. The primary `Id` of the `PriceEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another price enabler. it is reassigned to the given price enabler `Id.`
Parameters	`osid.id.Id`	`priceEnablerId`	the `Id` of a `PriceEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`priceEnablerId` not found
	NULL_ARGUMENT		`priceEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.