org.osid.personnel.batch

Interface AppointmentBatchAdminSession

All Superinterfaces:

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

public interface AppointmentBatchAdminSession
extends AppointmentAdminSession

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

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

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

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

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

The delete operations delete Appointments in bulk. To unmap an Appointment from the current Realm, the AppointmentRealmAssignmentSession should be used. These delete operations attempt to remove the Appointment itself thus removing it from all known Realm catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasAppointments(AliasRequestList aliasRequests) Adds an Id to an Appointment for the purpose of creating compatibility.
CreateResponseList	createAppointments(AppointmentBatchFormList appointmentForms) Creates a new set of Appointments.
DeleteResponseList	deleteAllAppointments() Deletes all Appointments in this Realm .
DeleteResponseList	deleteAppointments(IdList appointmentIds) Deletes appointments for the given Ids.
DeleteResponseList	deleteAppointmentsForPerson(Id personId) Deletes appointments for the given person.
DeleteResponseList	deleteAppointmentsForPosition(Id positionId) Deletes appointments for the given position.
DeleteResponseList	deleteIneffectiveAppointmentsByDate(DateTime date) Deletes appointments expired before the given date.
AppointmentBatchFormList	getAppointmentFormsForCreate(AppointmentPeerList peers, Type[] appointmentRecordTypes) Gets the appointment forms for creating a bunch of new appointments.
AppointmentBatchFormList	getAppointmentFormsForUpdate(IdList appointmentIds) Gets the appointment forms for updating an existing set of appointments.
UpdateResponseList	updateAppointments(AppointmentBatchFormList appointmentForms) Updates existing appointments.

Methods inherited from interface org.osid.personnel.AppointmentAdminSession

aliasAppointment, canCreateAppointments, canCreateAppointmentWithRecordTypes, canDeleteAppointments, canManageAppointmentAliases, canUpdateAppointments, createAppointment, deleteAppointment, getAppointmentFormForCreate, getAppointmentFormForUpdate, getRealm, getRealmId, updateAppointment

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

getAppointmentFormsForCreate

AppointmentBatchFormList getAppointmentFormsForCreate(AppointmentPeerList peers,
                                                    Type[] appointmentRecordTypes)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the appointment forms for creating a bunch of new appointments. A form is returned for each supplied position and resource pair.

Parameters:

peers - the relationship peers

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

Returns:

the appointment forms

Throws:

NotFoundException - a personId or positionId is not found

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

createAppointments

CreateResponseList createAppointments(AppointmentBatchFormList appointmentForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

appointmentForms - the appointment forms

Returns:

the create responses

Throws:

NullArgumentException - appointmentForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAppointmentFormsForUpdate

AppointmentBatchFormList getAppointmentFormsForUpdate(IdList appointmentIds)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

appointmentIds - the Ids of the Appointment

Returns:

the appointment form

Throws:

NotFoundException - an appointmentId is not found

NullArgumentException - appointmentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAppointments

UpdateResponseList updateAppointments(AppointmentBatchFormList appointmentForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

appointmentForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - appointmentForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAppointments

DeleteResponseList deleteAllAppointments()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes all Appointments in this Realm .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAppointments

DeleteResponseList deleteAppointments(IdList appointmentIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes appointments for the given Ids.

Parameters:

appointmentIds - the Ids of the appointments to delete

Returns:

the delete responses

Throws:

NullArgumentException - appointmentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAppointmentsForPerson

DeleteResponseList deleteAppointmentsForPerson(Id personId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Deletes appointments for the given person.

Parameters:

personId - an Id of a person

Returns:

the delete responses

Throws:

NullArgumentException - personId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAppointmentsForPosition

DeleteResponseList deleteAppointmentsForPosition(Id positionId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes appointments for the given position.

Parameters:

positionId - an Id of a position

Returns:

the delete responses

Throws:

NullArgumentException - positionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveAppointmentsByDate

DeleteResponseList deleteIneffectiveAppointmentsByDate(DateTime date)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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

aliasAppointments

AliasResponseList aliasAppointments(AliasRequestList aliasRequests)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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