org.osid.calendaring.batch

Interface ScheduleBatchAdminSession

All Superinterfaces:

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

public interface ScheduleBatchAdminSession
extends ScheduleAdminSession

This session creates, updates, and deletes Schedules 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 Schedule, a ScheduleForm is requested using getScheduleFormsForCreate() specifying the desired schedule slot, time period, record Types or none if no record Types are needed. Each of the returned ScheduleForms 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 ScheduleForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ScheduleForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Schedules in bulk. To unmap a Schedule from the current Calendar, the ScheduleCalendarAssignmentSession should be used. These delete operations attempt to remove the Schedule 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	aliasSchedules(AliasRequestList aliasRequests) Adds an Id to a Schedule for the purpose of creating compatibility.
CreateResponseList	createSchedules(ScheduleBatchFormList scheduleForms) Creates a new set of Schedules.
DeleteResponseList	deleteAllSchedules() Deletes all Schedules in this Calendar .
DeleteResponseList	deleteSchedules(IdList scheduleIds) Deletes schedules for the given Ids.
DeleteResponseList	deleteSchedulesForScheduleSlot(Id scheduleSlotId) Deletes schedules for the given schedule slot.
DeleteResponseList	deleteSchedulesForTimePeriod(Id timePeriodId) Deletes schedules for the given time period.
ScheduleBatchFormList	getScheduleFormsForCreate(SchedulePeerList peers, Type[] scheduleRecordTypes) Gets the schedule forms for creating a bunch of new schedules.
ScheduleBatchFormList	getScheduleFormsForUpdate(IdList scheduleIds) Gets the schedule forms for updating an existing set of schedules.
UpdateResponseList	updateSchedules(ScheduleBatchFormList scheduleForms) Updates existing schedules.

Methods inherited from interface org.osid.calendaring.ScheduleAdminSession

aliasSchedule, canCreateSchedules, canCreateScheduleWithRecordTypes, canDeleteSchedules, canManageScheduleAliases, canUpdateSchedules, createSchedule, deleteSchedule, getCalendar, getCalendarId, getScheduleFormForCreate, getScheduleFormForUpdate, updateSchedule

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

getScheduleFormsForCreate

ScheduleBatchFormList getScheduleFormsForCreate(SchedulePeerList peers,
                                              Type[] scheduleRecordTypes)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the schedule forms for creating a bunch of new schedules. A form is returned for each supplied schedule slot and time period pair.

Parameters:

peers - the schedule peers

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

Returns:

the schedule forms

Throws:

NotFoundException - a scheduleSlotId or timePeriodId is not found

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

createSchedules

CreateResponseList createSchedules(ScheduleBatchFormList scheduleForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

scheduleForms - the schedule forms

Returns:

the create responses

Throws:

NullArgumentException - scheduleForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScheduleFormsForUpdate

ScheduleBatchFormList getScheduleFormsForUpdate(IdList scheduleIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

scheduleIds - the Ids of the Schedule

Returns:

the schedule form

Throws:

NotFoundException - a scheduleId is not found

NullArgumentException - scheduleIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateSchedules

UpdateResponseList updateSchedules(ScheduleBatchFormList scheduleForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

scheduleForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - scheduleForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllSchedules

DeleteResponseList deleteAllSchedules()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Schedules in this Calendar .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSchedules

DeleteResponseList deleteSchedules(IdList scheduleIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes schedules for the given Ids.

Parameters:

scheduleIds - the Ids of the schedules to delete

Returns:

the delete responses

Throws:

NullArgumentException - scheduleIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSchedulesForScheduleSlot

DeleteResponseList deleteSchedulesForScheduleSlot(Id scheduleSlotId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes schedules for the given schedule slot.

Parameters:

scheduleSlotId - an 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.

deleteSchedulesForTimePeriod

DeleteResponseList deleteSchedulesForTimePeriod(Id timePeriodId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes schedules for the given time period.

Parameters:

timePeriodId - an Id of a time period

Returns:

the delete responses

Throws:

NullArgumentException - timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasSchedules

AliasResponseList aliasSchedules(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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