org.osid.offering.batch

Interface OfferingBatchAdminSession

All Superinterfaces:

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

public interface OfferingBatchAdminSession
extends OfferingAdminSession

This session creates, updates, and deletes Offerings 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 an Offering, an OfferingForm is requested using getOfferingFormsForCreate() specifying the desired canonical unit, time period, and record Types or none if no record Types are needed. Each of the returned OfferingForms 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 an OfferingForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each OfferingForm corresponds to an attempted transaction.

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

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

For updates, OfferingForms are requested to the Offering Id that is to be updated using getOfferingFormsForUpdate() where the reference Id in the OfferingForm may be used to link the request. Similarly, the OfferingForm has metadata about the data that can be updated and it can perform validation before submitting the update. The OfferingForm can only be used once for a successful update and cannot be reused.

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

The delete operations delete Offerings in bulk. To unmap an Offering from the current Catalogue, the OfferingCatalogueAssignmentSession should be used. These delete operations attempt to remove the Offering itself thus removing it from all known Catalogue catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasOfferings(AliasRequestList aliasRequests) Adds an Id to an Offering for the purpose of creating compatibility.
CreateResponseList	createOfferings(OfferingBatchFormList offeringForms) Creates a new set of Offerings.
DeleteResponseList	deleteAllOfferings() Deletes all Offerings in this Catalogue .
DeleteResponseList	deleteOfferings(IdList offeringIds) Deletes offerings for the given Ids.
DeleteResponseList	deleteOfferingsForCanonicalUnit(Id canonicalUnitId) Deletes all offerings mapped to the given canonical unit.
DeleteResponseList	deleteOfferingsForTimePeriod(Id timePeriodId) Deletes all offerings mapped to the given time period.
OfferingBatchFormList	getOfferingFormsForCreate(OfferingPeerList peers, Type[] offeringRecordTypes) Gets the offeringforms for creating a bunch of new offerings.
OfferingBatchFormList	getOfferingFormsForUpdate(IdList offeringIds) Gets the offering forms for updating an existing set of offerings.
UpdateResponseList	updateOfferings(OfferingBatchFormList offeringForms) Updates existing offerings.

Methods inherited from interface org.osid.offering.OfferingAdminSession

aliasOffering, canCreateOfferings, canCreateOfferingWithRecordTypes, canDeleteOfferings, canManageOfferingAliases, canUpdateOfferings, createOffering, deleteOffering, getCatalogue, getCatalogueId, getOfferingFormForCreate, getOfferingFormForUpdate, updateOffering

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

getOfferingFormsForCreate

OfferingBatchFormList getOfferingFormsForCreate(OfferingPeerList peers,
                                              Type[] offeringRecordTypes)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the offeringforms for creating a bunch of new offerings. A new result form is returned for each supplied canonical unit and time period.

Parameters:

peers - a list of canonical unit peers

offeringRecordTypes - array of offering record types to be included in each create operation or an empty list if none

Returns:

the offeringforms

Throws:

NotFoundException - a canonicalUnitId or timePeriodId is not found

NullArgumentException - peers or offeringRecordTypes 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.

createOfferings

CreateResponseList createOfferings(OfferingBatchFormList offeringForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

offeringForms - the offering forms

Returns:

the create responses

Throws:

NullArgumentException - offeringForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfferingFormsForUpdate

OfferingBatchFormList getOfferingFormsForUpdate(IdList offeringIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the offering forms for updating an existing set of offerings. A new offeringform should be requested for each update transaction.

Parameters:

offeringIds - the Ids of the Offering

Returns:

the offering form

Throws:

NotFoundException - an offeringId is not found

NullArgumentException - offeringIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateOfferings

UpdateResponseList updateOfferings(OfferingBatchFormList offeringForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

offeringForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - offeringForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllOfferings

DeleteResponseList deleteAllOfferings()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Offerings in this Catalogue .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteOfferings

DeleteResponseList deleteOfferings(IdList offeringIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes offerings for the given Ids.

Parameters:

offeringIds - the Ids of the offerings to delete

Returns:

the delete responses

Throws:

NullArgumentException - offeringIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteOfferingsForCanonicalUnit

DeleteResponseList deleteOfferingsForCanonicalUnit(Id canonicalUnitId)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Deletes all offerings mapped to the given canonical unit.

Parameters:

canonicalUnitId - an Id of a canonical unit

Returns:

the delete responses

Throws:

NullArgumentException - canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteOfferingsForTimePeriod

DeleteResponseList deleteOfferingsForTimePeriod(Id timePeriodId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes all offerings mapped to the given time period.

Parameters:

timePeriodId - an Id of a time period

Returns:

the delete responses

Throws:

NullArgumentException - timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasOfferings

AliasResponseList aliasOfferings(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Adds an Id to an Offering for the purpose of creating compatibility. The primary Id of the Offering is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another offering, it is reassigned to the given offering 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.