OSID - osid.ordering.PriceScheduleAdminSession Service Interface Definition

Interface	osid.ordering.PriceScheduleAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `PriceSchedules.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `PriceSchedule,` a `PriceScheduleForm` is requested using `gePriceScheduleFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `PriceScheduleForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `PriceScheduleForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PriceScheduleForm` corresponds to an attempted transaction. For updates, `PriceScheduleForms` are requested to the `PriceSchedule` `Id` that is to be updated using `getPriceScheduleFormForUpdate().` Similarly, the `PriceScheduleForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PriceScheduleForm` can only be used once for a successful update and cannot be reused. The delete operations delete `PriceSchedules.` To unmap a `PriceSchedule` from the current `Store,` the `PriceScheduleStoreAssignmentSession` should be used. These delete operations attempt to remove the `PriceSchedule` itself thus removing it from all known `Store` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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	canCreatePriceSchedules
Description	Tests if this user can create `PriceSchedules.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Price` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `PriceSchedule` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePriceScheduleWithRecordTypes
Description	Tests if this user can create a single `PriceSchedule` using the desired record types. While `OrderingManager.getPriceScheduleRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `PriceSchedule.` Providing an empty array tests if a `PriceSchedule` can be created with no records.
Parameters	`osid.type.Type[]`	`priceScheduleRecordTypes`	array of price schedule record types
Return	`boolean`		`true` if `PriceSchedule` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`priceScheduleRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceScheduleFormForCreate
Description	Gets the price schedule form for creating new prices. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`priceScheduleRecordTypes`	array of price schedule record types
Return	`osid.ordering.PriceScheduleForm`		the price schedule form
Errors	NULL_ARGUMENT		`priceScheduleRecordTypes` 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	createPriceSchedule
Description	Creates a new `PriceSchedule.`
Parameters	`osid.ordering.PriceForm`	`priceScheduleForm`	the form for this `PriceSchedule`
Return	`osid.ordering.PriceSchedule`		the new `PriceSchedule`
Errors	ILLEGAL_STATE		`priceScheduleForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`priceScheduleForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceScheduleForm` did not originate from `getPriceScheduleFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePriceSchedules
Description	Tests if this user can update `PriceSchedules.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `PriceSchedule` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `PriceSchedule` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPriceScheduleFormForUpdate
Description	Gets the price S\schedule form for updating an existing price. A new price schedule form should be requested for each update transaction.
Parameters	`osid.id.Id`	`priceScheduleId`	the `Id` of the `Price`
Return	`osid.ordering.PriceScheduleForm`		the price schedule form
Errors	NULL_ARGUMENT		`priceScheduleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	updatePriceSchedule
Description	Updates an existing price schedule.
Parameters	`osid.ordering.PriceScheduleForm`	`priceScheduleForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`priceScheduleForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`priceScheduleForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceScheduleForm` did not originate from `getPriceScheduleFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePriceSchedules
Description	Tests if this user can delete `PriceSchedules` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `PriceSchedule` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `PriceSchedule` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePriceSchedule
Description	Deletes a `PriceSchedule.`
Parameters	`osid.id.Id`	`priceScheduleId`	the `Id` of the `PriceSchedule` to remove
Errors	NOT_FOUND		`priceScheduleId` not found
	NULL_ARGUMENT		`priceScheduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePriceScheduleAliases
Description	Tests if this user can manage `Id` aliases for `PriceSchedules.` 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 `PriceSchedule` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPriceSchedule
Description	Adds an `Id` to a `PriceSchedule` for the purpose of creating compatibility. The primary `Id` of the `PriceSchedule` 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 schedule, it is reassigned to the given price schedule `Id.`
Parameters	`osid.id.Id`	`priceScheduleId`	the `Id` of a `PriceSchedule`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`priceScheduleId` not found
	NULL_ARGUMENT		`priceScheduleId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePrices
Description	Tests if this user can create `Prices` for a `PriceSchedule.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `PriceSchedule` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Parameters	`osid.id.Id`	`priceScheduleId`	the `Id` of a `PriceSchedule`
Return	`boolean`		`false` if `Price` creation is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`priceScheduleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePriceWithRecordTypes
Description	Tests if this user can create a single `Price` using the desired record types. While `OrderingManager.getPriceRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Price.` Providing an empty array tests if a `Grade` can be created with no records.
Parameters	`osid.id.Id`	`priceScheduleId`	the `Id` of a `PriceSchedule`
Parameters	`osid.type.Type[]`	`priceRecordTypes`	array of price record types
Return	`boolean`		`true` if `Price` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`priceScheduleId` or `priceRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceFormForCreate
Description	Gets the price form for creating new prices. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`priceScheduleId`	the `Id` of a `PriceSchedule`
Parameters	`osid.type.Type[]`	`priceRecordTypes`	array of price record types
Return	`osid.grading.GradeForm`		the price form
Errors	NOT_FOUND		`priceScheduleId` is not found
	NULL_ARGUMENT		`priceScheduleId` or `priceRecordTypes` 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	createPrice
Description	Creates a new `Price.`
Parameters	`osid.ordering.PriceForm`	`priceForm`	the form for this `Price`
Return	`osid.ordering.Price`		the new `Price`
Errors	ILLEGAL_STATE		`priceForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`priceForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceForm` did not originate from `getPriceFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePrices
Description	Tests if this user can update `Prices.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Price` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Parameters	`osid.id.Id`	`priceScheduleId`	the `Id` of a `PriceSchedule`
Return	`boolean`		`false` if `Price` modification is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`priceSchedule` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceFormForUpdate
Description	Gets the price form for updating an existing price. A new price form should be requested for each update transaction.
Parameters	`osid.id.Id`	`priceId`	the `Id` of the `Price`
Return	`osid.ordering.PriceForm`		the price form
Errors	NOT_FOUND		`priceId` is not found
	NULL_ARGUMENT		`priceId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updatePrice
Description	Updates an existing price.
Parameters	`osid.ordering.PriceForm`	`priceForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`priceForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`priceForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`priceForm` did not originate from `getPriceFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePrices
Description	Tests if this user can delete prices. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Price` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Parameters	`osid.id.Id`	`priceScheduleId`	the `Id` of a `PriceSchedule`
Return	`boolean`		`false` if `Grade` deletion is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`priceScheduleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	deletePrice
Description	Deletes a `Price.`
Parameters	`osid.id.Id`	`priceId`	the `Id` of the `Price` to remove
Errors	NOT_FOUND		`priceId` not found
	NULL_ARGUMENT		`priceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePriceAliases
Description	Tests if this user can manage `Id` aliases for `Prices.` 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 `Price` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPrice
Description	Adds an `Id` to a `Price` for the purpose of creating compatibility. The primary `Id` of the `Price` 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, it is reassigned to the given price `Id.`
Parameters	`osid.id.Id`	`priceId`	the `Id` of a `Price`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`priceId` not found
	NULL_ARGUMENT		`priceId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.