org.osid.room.batch

Interface CampusBatchAdminSession

All Superinterfaces:

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

public interface CampusBatchAdminSession
extends CampusAdminSession

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

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

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

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

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

The delete operations delete Campuses in bulk. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasCampuses(AliasRequestList aliasRequests) Adds an Id to an Campus for the purpose of creating compatibility.
CreateResponseList	createCampuses(CampusBatchFormList campusForms) Creates a new set of Campuses.
DeleteResponseList	deleteAllCampuses() Deletes all Campuses.
DeleteResponseList	deleteCampuses(IdList campusIds) Deletes campuses for the given Ids.
CampusBatchFormList	getCampusFormsForCreate(long number, Type[] campusRecordTypes) Gets the campus forms for creating a bunch of new campuses.
CampusBatchFormList	getCampusFormsForUpdate(IdList campusIds) Gets the campus forms for updating an existing set of campuses.
UpdateResponseList	updateCampuses(CampusBatchFormList campusForms) Updates existing campuses.

Methods inherited from interface org.osid.room.CampusAdminSession

aliasCampus, canCreateCampuses, canCreateCampusWithRecordTypes, canDeleteCampuses, canManageCampusAliases, canUpdateCampuses, createCampus, deleteCampus, getCampusFormForCreate, getCampusFormForUpdate, updateCampus

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

getCampusFormsForCreate

CampusBatchFormList getCampusFormsForCreate(long number,
                                          Type[] campusRecordTypes)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets the campus forms for creating a bunch of new campuses.

Parameters:

number - the number of forms to retrieve

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

Returns:

the campus forms

Throws:

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

createCampuses

CreateResponseList createCampuses(CampusBatchFormList campusForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

campusForms - the campus forms

Returns:

the create responses

Throws:

NullArgumentException - campusForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCampusFormsForUpdate

CampusBatchFormList getCampusFormsForUpdate(IdList campusIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

campusIds - the Ids of the Campus

Returns:

the campus form

Throws:

NotFoundException - an campusId is not found

NullArgumentException - campusIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCampuses

UpdateResponseList updateCampuses(CampusBatchFormList campusForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

campusForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - campusForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllCampuses

DeleteResponseList deleteAllCampuses()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Campuses.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteCampuses

DeleteResponseList deleteCampuses(IdList campusIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes campuses for the given Ids.

Parameters:

campusIds - the Ids of the campuses to delete

Returns:

the delete responses

Throws:

NullArgumentException - campusIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasCampuses

AliasResponseList aliasCampuses(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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