org.osid.calendaring.batch

Interface TimePeriodBatchAdminSession

All Superinterfaces:

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

public interface TimePeriodBatchAdminSession
extends TimePeriodAdminSession

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

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

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

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

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

The delete operations delete TimePeriods in bulk. To unmap a TimePeriod from the current Calendar, the TimePeriodCalendarAssignmentSession should be used. These delete operations attempt to remove the TimePeriod 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	aliasTimePeriods(AliasRequestList aliasRequests) Adds an Id to a TimePeriod for the purpose of creating compatibility.
CreateResponseList	createTimePeriods(TimePeriodBatchFormList timePeriodForms) Creates a new set of TimePeriods.
DeleteResponseList	deleteAllTimePeriods() Deletes all TimePeriods in this Calendar .
DeleteResponseList	deleteTimePeriods(IdList timePeriodIds) Deletes time periods for the given Ids.
DeleteResponseList	deleteTimePeriodsByDate(DateTime date) Deletes time periods containing the given date.
TimePeriodBatchFormList	getTimePeriodFormsForCreate(long number, Type[] timePeriodRecordTypes) Gets the time period forms for creating a bunch of new time periods.
TimePeriodBatchFormList	getTimePeriodFormsForUpdate(IdList timePeriodIds) Gets the time period forms for updating an existing set of time periods.
UpdateResponseList	updateTimePeriods(TimePeriodBatchFormList timePeriodForms) Updates existing time periods.

Methods inherited from interface org.osid.calendaring.TimePeriodAdminSession

addExceptionEvent, aliasTimePeriod, canCreateTimePeriods, canCreateTimePeriodWithRecordTypes, canDeleteTimePeriods, canManageTimePeriodAliases, canUpdateTimePeriods, createTimePeriod, deleteTimePeriod, getCalendar, getCalendarId, getTimePeriodFormForCreate, getTimePeriodFormForUpdate, removeExceptionEvent, updateTimePeriod

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

getTimePeriodFormsForCreate

TimePeriodBatchFormList getTimePeriodFormsForCreate(long number,
                                                  Type[] timePeriodRecordTypes)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets the time period forms for creating a bunch of new time periods.

Parameters:

number - the number of forms to retrieve

timePeriodRecordTypes - array of time period record types to be included in each create operation or an empty list if none

Returns:

the time period forms

Throws:

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

createTimePeriods

CreateResponseList createTimePeriods(TimePeriodBatchFormList timePeriodForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

timePeriodForms - the time period forms

Returns:

the create responses

Throws:

NullArgumentException - timePeriodForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTimePeriodFormsForUpdate

TimePeriodBatchFormList getTimePeriodFormsForUpdate(IdList timePeriodIds)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Gets the time period forms for updating an existing set of time periods. A new time period form should be requested for each update transaction.

Parameters:

timePeriodIds - the Ids of the TimePeriod

Returns:

the time period form

Throws:

NotFoundException - a timePeriodId is not found

NullArgumentException - timePeriodIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateTimePeriods

UpdateResponseList updateTimePeriods(TimePeriodBatchFormList timePeriodForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

timePeriodForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - timePeriodForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllTimePeriods

DeleteResponseList deleteAllTimePeriods()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes all TimePeriods in this Calendar .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteTimePeriods

DeleteResponseList deleteTimePeriods(IdList timePeriodIds)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes time periods for the given Ids.

Parameters:

timePeriodIds - the Ids of the time periods to delete

Returns:

the delete responses

Throws:

NullArgumentException - timePeriodIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteTimePeriodsByDate

DeleteResponseList deleteTimePeriodsByDate(DateTime date)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes time periods containing 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.

aliasTimePeriods

AliasResponseList aliasTimePeriods(AliasRequestList aliasRequests)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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