org.osid.room.batch

Interface BuildingBatchAdminSession

All Superinterfaces:

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

public interface BuildingBatchAdminSession
extends BuildingAdminSession

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

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

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

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

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

The delete operations delete Buildings in bulk. To unmap a Building from the current Campus, the BuildingCampusAssignmentSession should be used. These delete operations attempt to remove the Building 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	aliasBuildings(AliasRequestList aliasRequests) Adds an Id to a Building for the purpose of creating compatibility.
CreateResponseList	createBuildings(BuildingBatchFormList buildingForms) Creates a new set of Buildings.
DeleteResponseList	deleteAllBuildings() Deletes all Buildings in this Campus .
DeleteResponseList	deleteBuildings(IdList buildingIds) Deletes buildings for the given Ids.
DeleteResponseList	deleteIneffectiveBuildingsByDate(DateTime date) Deletes buildings expired before the given date.
BuildingBatchFormList	getBuildingFormsForCreate(long number, Type[] buildingRecordTypes) Gets the building forms for creating a bunch of new buildings.
BuildingBatchFormList	getBuildingFormsForUpdate(IdList buildingIds) Gets the building forms for updating an existing set of buildings.
UpdateResponseList	updateBuildings(BuildingBatchFormList buildingForms) Updates existing buildings.

Methods inherited from interface org.osid.room.BuildingAdminSession

aliasBuilding, canCreateBuildings, canCreateBuildingWithRecordTypes, canDeleteBuildings, canManageBuildingAliases, canUpdateBuildings, createBuilding, deleteBuilding, getBuildingFormForCreate, getBuildingFormForUpdate, getCampus, getCampusId, updateBuilding

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

getBuildingFormsForCreate

BuildingBatchFormList getBuildingFormsForCreate(long number,
                                              Type[] buildingRecordTypes)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets the building forms for creating a bunch of new buildings.

Parameters:

number - the number of forms to retrieve

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

Returns:

the building forms

Throws:

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

createBuildings

CreateResponseList createBuildings(BuildingBatchFormList buildingForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

buildingForms - the building forms

Returns:

the create responses

Throws:

NullArgumentException - buildingForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBuildingFormsForUpdate

BuildingBatchFormList getBuildingFormsForUpdate(IdList buildingIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

buildingIds - the Ids of the Building

Returns:

the building form

Throws:

NotFoundException - a buildingId is not found

NullArgumentException - buildingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateBuildings

UpdateResponseList updateBuildings(BuildingBatchFormList buildingForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

buildingForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - buildingForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllBuildings

DeleteResponseList deleteAllBuildings()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Buildings in this Campus .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteBuildings

DeleteResponseList deleteBuildings(IdList buildingIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes buildings for the given Ids.

Parameters:

buildingIds - the Ids of the buildings to delete

Returns:

the delete responses

Throws:

NullArgumentException - buildingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveBuildingsByDate

DeleteResponseList deleteIneffectiveBuildingsByDate(DateTime date)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Deletes buildings 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.

aliasBuildings

AliasResponseList aliasBuildings(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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