org.osid.room.construction.batch

Interface RenovationBatchAdminSession

All Superinterfaces:

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

public interface RenovationBatchAdminSession
extends RenovationAdminSession

This session creates, updates, and deletes Renovations 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 Renovation, a RenovationForm is requested using getRenovationFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned RenovationForms 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 RenovationForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RenovationForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Renovations in bulk. To unmap a Renovation from the current Campus, the RenovationCampusAssignmentSession should be used. These delete operations attempt to remove the Renovation itself thus removing it from all known Campus catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasRenovations(AliasRequestList aliasRequests) Adds an Id to a Renovation for the purpose of creating compatibility.
CreateResponseList	createRenovations(RenovationBatchFormList renovationForms) Creates a new set of Renovations.
DeleteResponseList	deleteAllRenovations() Deletes all Renovations in this Campus .
DeleteResponseList	deleteIneffectiveRenovationsByDate(DateTime date) Deletes renovations expired before the given date.
DeleteResponseList	deleteRenovations(IdList renovationIds) Deletes renovations for the given Ids.
RenovationBatchFormList	getRenovationFormsForCreate(long number, Type[] renovationRecordTypes) Gets the renovation forms for creating a bunch of new renovations.
RenovationBatchFormList	getRenovationFormsForUpdate(IdList renovationIds) Gets the renovation forms for updating an existing set of renovations.
UpdateResponseList	updateRenovations(RenovationBatchFormList renovationForms) Updates existing renovations.

Methods inherited from interface org.osid.room.construction.RenovationAdminSession

aliasRenovation, canCreateRenovations, canCreateRenovationWithRecordTypes, canDeleteRenovations, canManageRenovationAliases, canUpdateRenovations, createRenovation, deleteRenovation, getCampus, getCampusId, getRenovationFormForCreate, getRenovationFormForUpdate, updateRenovation

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

getRenovationFormsForCreate

RenovationBatchFormList getRenovationFormsForCreate(long number,
                                                  Type[] renovationRecordTypes)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets the renovation forms for creating a bunch of new renovations.

Parameters:

number - the number of forms to retrieve

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

Returns:

the renovation forms

Throws:

NullArgumentException - renovationRecordTypes 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.

createRenovations

CreateResponseList createRenovations(RenovationBatchFormList renovationForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

renovationForms - the renovation forms

Returns:

the create responses

Throws:

NullArgumentException - renovationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRenovationFormsForUpdate

RenovationBatchFormList getRenovationFormsForUpdate(IdList renovationIds)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

renovationIds - the Ids of the Renovation

Returns:

the renovation form

Throws:

NotFoundException - a renovationId is not found

NullArgumentException - renovationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRenovations

UpdateResponseList updateRenovations(RenovationBatchFormList renovationForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

renovationForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - renovationForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllRenovations

DeleteResponseList deleteAllRenovations()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes all Renovations in this Campus .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRenovations

DeleteResponseList deleteRenovations(IdList renovationIds)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes renovations for the given Ids.

Parameters:

renovationIds - the Ids of the renovations to delete

Returns:

the delete responses

Throws:

NullArgumentException - renovationIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveRenovationsByDate

DeleteResponseList deleteIneffectiveRenovationsByDate(DateTime date)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Deletes renovations expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasRenovations

AliasResponseList aliasRenovations(AliasRequestList aliasRequests)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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