org.osid.room.squatting.batch

Interface LeaseBatchAdminSession

All Superinterfaces:

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

public interface LeaseBatchAdminSession
extends LeaseAdminSession

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

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

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

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

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

The delete operations delete Leases in bulk. To unmap a Lease from the current Campus, the LeaseCampusAssignmentSession should be used. These delete operations attempt to remove the Lease 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	aliasLeases(AliasRequestList aliasRequests) Adds an Id to a Lease for the purpose of creating compatibility.
CreateResponseList	createLeases(LeaseBatchFormList leaseForms) Creates a new set of Leases.
DeleteResponseList	deleteAllLeases() Deletes all Leases in this Campus .
DeleteResponseList	deleteIneffectiveLeasesByDate(DateTime date) Deletes leases expired before the given date.
DeleteResponseList	deleteLeases(IdList leaseIds) Deletes leases for the given Ids.
DeleteResponseList	deleteLeasesForRoom(Id roomId) Deletes leases for the given room.
DeleteResponseList	deleteLeasesForTenant(Id resourceId) Deletes leases for the given tenant.
LeaseBatchFormList	getLeaseFormsForCreate(LeasePeerList peers, Type[] leaseRecordTypes) Gets the lease forms for creating a bunch of new leases.
LeaseBatchFormList	getLeaseFormsForUpdate(IdList leaseIds) Gets the lease forms for updating an existing set of leases.
UpdateResponseList	updateLeases(LeaseBatchFormList leaseForms) Updates existing leases.

Methods inherited from interface org.osid.room.squatting.LeaseAdminSession

aliasLease, canCreateLeases, canCreateLeaseWithRecordTypes, canDeleteLeases, canManageLeaseAliases, canUpdateLeases, createLease, deleteLease, getCampus, getCampusId, getLeaseFormForCreate, getLeaseFormForUpdate, updateLease

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

getLeaseFormsForCreate

LeaseBatchFormList getLeaseFormsForCreate(LeasePeerList peers,
                                        Type[] leaseRecordTypes)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the lease forms for creating a bunch of new leases. A lease form is returned for each supplied peer.

Parameters:

peers - a list of lease peers

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

Returns:

the lease forms

Throws:

NotFoundException - a roomId or resourceId is not found

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

createLeases

CreateResponseList createLeases(LeaseBatchFormList leaseForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

leaseForms - the lease forms

Returns:

the create responses

Throws:

NullArgumentException - leaseForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLeaseFormsForUpdate

LeaseBatchFormList getLeaseFormsForUpdate(IdList leaseIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

leaseIds - the Ids of the Lease

Returns:

the lease form

Throws:

NotFoundException - a leaseId is not found

NullArgumentException - leaseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateLeases

UpdateResponseList updateLeases(LeaseBatchFormList leaseForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

leaseForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - leaseForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllLeases

DeleteResponseList deleteAllLeases()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Leases in this Campus .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteLeases

DeleteResponseList deleteLeases(IdList leaseIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes leases for the given Ids.

Parameters:

leaseIds - the Ids of the leases to delete

Returns:

the delete responses

Throws:

NullArgumentException - leaseIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteLeasesForRoom

DeleteResponseList deleteLeasesForRoom(Id roomId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes leases for the given room.

Parameters:

roomId - the Id of a room

Returns:

the delete responses

Throws:

NullArgumentException - roomId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteLeasesForTenant

DeleteResponseList deleteLeasesForTenant(Id resourceId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes leases for the given tenant.

Parameters:

resourceId - the Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveLeasesByDate

DeleteResponseList deleteIneffectiveLeasesByDate(DateTime date)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

aliasLeases

AliasResponseList aliasLeases(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

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