org.osid.calendaring.batch

Interface ScheduleSlotBatchAdminSession

All Superinterfaces:

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

public interface ScheduleSlotBatchAdminSession
extends ScheduleSlotAdminSession

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

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

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

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

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

The delete operations delete ScheduleSlots in bulk. To unmap a ScheduleSlot from the current Calendar, the ScheduleSlotCalendarAssignmentSession should be used. These delete operations attempt to remove the ScheduleSlot itself thus removing it from all known Calendar catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasScheduleSlots(AliasRequestList aliasRequests) Adds an Id to a ScheduleSlot for the purpose of creating compatibility.
CreateResponseList	createScheduleSlots(ScheduleSlotBatchFormList scheduleSlotForms) Creates a new set of ScheduleSlots.
DeleteResponseList	deleteAllScheduleSlots() Deletes all ScheduleSlots in this Calendar .
DeleteResponseList	deleteContainedScheduleSlots(Id scheduleSlotId) Deletes schedule slots contained within the given schedule slot.
DeleteResponseList	deleteScheduleSlots(IdList scheduleSlotIds) Deletes schedule slots for the given Ids.
ScheduleSlotBatchFormList	getScheduleSlotFormsForCreate(long number, Type[] scheduleSlotRecordTypes) Gets the schedule slot forms for creating a bunch of new schedule slots.
ScheduleSlotBatchFormList	getScheduleSlotFormsForUpdate(IdList scheduleSlotIds) Gets the schedule slot forms for updating an existing set of schedule slots.
UpdateResponseList	updateScheduleSlots(ScheduleSlotBatchFormList scheduleSlotForms) Updates existing schedule slots.

Methods inherited from interface org.osid.calendaring.ScheduleSlotAdminSession

aliasScheduleSlot, canCreateScheduleSlots, canCreateScheduleSlotWithRecordTypes, canDeleteScheduleSlots, canManageScheduleSlotAliases, canUpdateScheduleSlots, createScheduleSlot, deleteScheduleSlot, getCalendar, getCalendarId, getScheduleSlotFormForCreate, getScheduleSlotFormForUpdate, updateScheduleSlot

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

getScheduleSlotFormsForCreate

ScheduleSlotBatchFormList getScheduleSlotFormsForCreate(long number,
                                                      Type[] scheduleSlotRecordTypes)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets the schedule slot forms for creating a bunch of new schedule slots.

Parameters:

number - the number of forms to retrieve

scheduleSlotRecordTypes - array of schedule slot record types to be included in each create operation or an empty list if none

Returns:

the schedule slot forms

Throws:

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

createScheduleSlots

CreateResponseList createScheduleSlots(ScheduleSlotBatchFormList scheduleSlotForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

scheduleSlotForms - the schedule slot forms

Returns:

the create responses

Throws:

NullArgumentException - scheduleSlotForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScheduleSlotFormsForUpdate

ScheduleSlotBatchFormList getScheduleSlotFormsForUpdate(IdList scheduleSlotIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the schedule slot forms for updating an existing set of schedule slots. A new schedule slot form should be requested for each update transaction.

Parameters:

scheduleSlotIds - the Ids of the ScheduleSlot

Returns:

the schedule slot form

Throws:

NotFoundException - a scheduleSlotId is not found

NullArgumentException - scheduleSlotIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateScheduleSlots

UpdateResponseList updateScheduleSlots(ScheduleSlotBatchFormList scheduleSlotForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

scheduleSlotForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - scheduleSlotForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllScheduleSlots

DeleteResponseList deleteAllScheduleSlots()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all ScheduleSlots in this Calendar .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteScheduleSlots

DeleteResponseList deleteScheduleSlots(IdList scheduleSlotIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes schedule slots for the given Ids.

Parameters:

scheduleSlotIds - the Ids of the schedule slots to delete

Returns:

the delete responses

Throws:

NullArgumentException - scheduleSlotIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteContainedScheduleSlots

DeleteResponseList deleteContainedScheduleSlots(Id scheduleSlotId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes schedule slots contained within the given schedule slot.

Parameters:

scheduleSlotId - the Id of a schedule slot

Returns:

the delete responses

Throws:

NullArgumentException - scheduleSlotId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasScheduleSlots

AliasResponseList aliasScheduleSlots(AliasRequestList aliasRequests)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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