org.osid.ordering.batch

Interface PriceScheduleBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PriceScheduleAdminSession

public interface PriceScheduleBatchAdminSession
extends PriceScheduleAdminSession

This session creates, updates, and deletes PriceSchedules in bulk. 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 getPriceScheduleFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned PriceScheduleForms 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 a 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.

The PriceScheduleForms returned from getPriceScheduleFormsForCreate() may be linked to the originating request through the peer Ids of the PriceScheduleForm. In the case where there may be duplicates, any PriceScheduleForm of the same peer Ids may be used for a create operation.

Once a batch of PriceScheduleForms are submitted for create, a CreateResponse is returned for each PriceScheduleForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createPriceSchedules(), errors specific to an individual PriceScheduleForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating PriceScheduleForm through the PriceScheduleForm Id .

For updates, PriceScheduleForms are requested to the PriceSchedule Id that is to be updated using getPriceScheduleFormsForUpdate() where the reference Id in the PriceScheduleForm may be used to link the request. 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.

Once a batch of PriceScheduleForms are submitted for update, an UpdateResponse is returned for each PriceScheduleForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updatePriceSchedules(), errors specific to an individual PriceScheduleForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating PriceScheduleForm through the PriceScheduleForm Id.

The delete operations delete PriceSchedules in bulk. 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. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPrices(AliasRequestList aliasRequests) Adds an Id to a Price for the purpose of creating compatibility.
AliasResponseList	aliasPriceSchedules(AliasRequestList aliasRequests) Adds an Id to a PriceSchedule for the purpose of creating compatibility.
CreateResponseList	createPrices(PriceBatchFormList priceForms) Creates a new set of Prices.
CreateResponseList	createPriceSchedules(PriceScheduleBatchFormList priceScheduleForms) Creates a new set of PriceSchedules.
DeleteResponseList	deleteAllPrices() Deletes all Prices in this Store .
DeleteResponseList	deleteAllPriceSchedules() Deletes all PriceSchedules in this Store .
DeleteResponseList	deletePrices(IdList priceIds) Deletes prices for the given Ids.
DeleteResponseList	deletePriceSchedules(IdList priceScheduleIds) Deletes price schedules for the given Ids.
DeleteResponseList	deletePricesForPriceSchedule(Id priceScheduleId) Deletes prices for the given price schedule.
PriceBatchFormList	getPriceFormsForCreate(IdList priceScheduleIds, Type[] priceScheduleRecordTypes) Gets the price forms for creating a bunch of new prices.
PriceBatchFormList	getPriceFormsForUpdate(IdList priceIds) Gets the price forms for updating an existing set of prices.
PriceScheduleBatchFormList	getPriceScheduleFormsForCreate(long number, Type[] priceScheduleRecordTypes) Gets the price schedule forms for creating a bunch of new price schedules.
PriceScheduleBatchFormList	getPriceScheduleFormsForUpdate(IdList priceScheduleIds) Gets the price schedule forms for updating an existing set of price schedules.
UpdateResponseList	updatePrices(PriceBatchFormList priceForms) Updates existing prices.
UpdateResponseList	updatePriceSchedules(PriceScheduleBatchFormList priceScheduleForms) Updates existing price schedules.

Methods inherited from interface org.osid.ordering.PriceScheduleAdminSession

aliasPrice, aliasPriceSchedule, canCreatePrices, canCreatePriceSchedules, canCreatePriceScheduleWithRecordTypes, canCreatePriceWithRecordTypes, canDeletePrices, canDeletePriceSchedules, canManagePriceAliases, canManagePriceScheduleAliases, canUpdatePrices, canUpdatePriceSchedules, createPrice, createPriceSchedule, deletePrice, deletePriceSchedule, getPriceFormForCreate, getPriceFormForUpdate, getPriceScheduleFormForCreate, getPriceScheduleFormForUpdate, getStore, getStoreId, updatePrice, updatePriceSchedule

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPriceScheduleFormsForCreate

PriceScheduleBatchFormList getPriceScheduleFormsForCreate(long number,
                                                        Type[] priceScheduleRecordTypes)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets the price schedule forms for creating a bunch of new price schedules.

Parameters:

number - the number of forms to retrieve

priceScheduleRecordTypes - array of price schedule record types to be included in each create operation or an empty list if none

Returns:

the price schedule forms

Throws:

NullArgumentException - priceScheduleRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createPriceSchedules

CreateResponseList createPriceSchedules(PriceScheduleBatchFormList priceScheduleForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Creates a new set of PriceSchedules. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

priceScheduleForms - the price schedule forms

Returns:

the create responses

Throws:

NullArgumentException - priceScheduleForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPriceScheduleFormsForUpdate

PriceScheduleBatchFormList getPriceScheduleFormsForUpdate(IdList priceScheduleIds)
                                                          throws NotFoundException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

Gets the price schedule forms for updating an existing set of price schedules. A new price schedule form should be requested for each update transaction.

Parameters:

priceScheduleIds - the Ids of the PriceSchedules

Returns:

the price schedule form

Throws:

NotFoundException - a priceScheduleId is not found

NullArgumentException - priceScheduleIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePriceSchedules

UpdateResponseList updatePriceSchedules(PriceScheduleBatchFormList priceScheduleForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Updates existing price schedules. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

priceScheduleForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - priceScheduleForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPriceSchedules

DeleteResponseList deleteAllPriceSchedules()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes all PriceSchedules in this Store .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePriceSchedules

DeleteResponseList deletePriceSchedules(IdList priceScheduleIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes price schedules for the given Ids.

Parameters:

priceScheduleIds - the Ids of the price schedules to delete

Returns:

the delete responses

Throws:

NullArgumentException - priceScheduleIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPriceSchedules

AliasResponseList aliasPriceSchedules(AliasRequestList aliasRequests)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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 is 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:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPriceFormsForCreate

PriceBatchFormList getPriceFormsForCreate(IdList priceScheduleIds,
                                        Type[] priceScheduleRecordTypes)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the price forms for creating a bunch of new prices. A form is returned for each supplied price schedule.

Parameters:

priceScheduleIds - a list of price schedule Ids

priceScheduleRecordTypes - array of price schedule record types to be included in each create operation or an empty list if none

Returns:

the price schedule forms

Throws:

NotFoundException - a priceScheduleId is not found

NullArgumentException - priceScheduleId or priceScheduleRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createPrices

CreateResponseList createPrices(PriceBatchFormList priceForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Creates a new set of Prices. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

priceForms - the price forms

Returns:

the create responses

Throws:

NullArgumentException - priceForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPriceFormsForUpdate

PriceBatchFormList getPriceFormsForUpdate(IdList priceIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the price forms for updating an existing set of prices. A new price form should be requested for each update transaction.

Parameters:

priceIds - the Ids of the Prices

Returns:

the price forms

Throws:

NotFoundException - a priceId is not found

NullArgumentException - priceIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePrices

UpdateResponseList updatePrices(PriceBatchFormList priceForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

Updates existing prices. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

priceForms - the forms containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - priceForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPrices

DeleteResponseList deleteAllPrices()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Prices in this Store .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePrices

DeleteResponseList deletePrices(IdList priceIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes prices for the given Ids.

Parameters:

priceIds - the Ids of the price to delete

Returns:

the delete responses

Throws:

NullArgumentException - priceIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePricesForPriceSchedule

DeleteResponseList deletePricesForPriceSchedule(Id priceScheduleId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes prices for the given price schedule.

Parameters:

priceScheduleId - the Id ofa price schedule

Returns:

the delete responses

Throws:

NullArgumentException - priceScheduleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPrices

AliasResponseList aliasPrices(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

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 is an alias to the primary Id. If the alias is a pointer to another price, it is reassigned to the given price Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.