org.osid.course.chronicle.batch

Interface ProgramEntryBatchAdminSession

All Superinterfaces:

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

public interface ProgramEntryBatchAdminSession
extends ProgramEntryAdminSession

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

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

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

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

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

The delete operations delete ProgramEntries in bulk. To unmap a ProgramEntry from the current CourseCatalog, the ProgramEntryCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the ProgramEntry itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasProgramEntries(AliasRequestList aliasRequests) Adds an Id to a ProgramEntry for the purpose of creating compatibility.
CreateResponseList	createProgramEntries(ProgramEntryBatchFormList programEntryForms) Creates a new set of ProgramEntries.
DeleteResponseList	deleteAllProgramEntries() Deletes all ProgramEntries in this CourseCatalog .
DeleteResponseList	deleteIneffectiveProgramEntriesByDate(DateTime date) Deletes program entries expired before the given date.
DeleteResponseList	deleteProgramEntries(IdList programEntryIds) Deletes program entries for the given Ids.
DeleteResponseList	deleteProgramEntriesForProgram(Id programId) Deletes program entries for the given program.
DeleteResponseList	deleteProgramEntriesForStudent(Id resourceId) Deletes program entries for the given student
ProgramEntryBatchFormList	getProgramEntryFormsForCreate(ProgramEntryPeerList peers, Type[] programEntryRecordTypes) Gets the program entry forms for creating a bunch of new program entries.
ProgramEntryBatchFormList	getProgramEntryFormsForUpdate(IdList programEntryIds) Gets the program entry forms for updating an existing set of program entries.
UpdateResponseList	updateProgramEntries(ProgramEntryBatchFormList programEntryForms) Updates existing program entries.

Methods inherited from interface org.osid.course.chronicle.ProgramEntryAdminSession

aliasProgramEntry, canCreateProgramEntries, canCreateProgramEntryWithRecordTypes, canDeleteProgramEntries, canDeleteProgramEntry, canManageProgramEntryAliases, canUpdateProgramEntries, createProgramEntry, deleteProgramEntry, getCourseCatalog, getCourseCatalogId, getProgramEntryFormForCreate, getProgramEntryFormForUpdate, updateProgramEntry

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

getProgramEntryFormsForCreate

ProgramEntryBatchFormList getProgramEntryFormsForCreate(ProgramEntryPeerList peers,
                                                      Type[] programEntryRecordTypes)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the program entry forms for creating a bunch of new program entries. A ProgramEntryForm is returned for each program and student pair.

Parameters:

peers - a list of program entry peers

programEntryRecordTypes - array of program entry record types to be included in each create operation or an empty list if none

Returns:

the program entry forms

Throws:

NotFoundException - a programId or studentId is not found

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

createProgramEntries

CreateResponseList createProgramEntries(ProgramEntryBatchFormList programEntryForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

programEntryForms - the program entry forms

Returns:

the create responses

Throws:

NullArgumentException - programEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntryFormsForUpdate

ProgramEntryBatchFormList getProgramEntryFormsForUpdate(IdList programEntryIds)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the program entry forms for updating an existing set of program entries. A new program entry form should be requested for each update transaction.

Parameters:

programEntryIds - the Ids of the ProgramEntry

Returns:

the program entry form

Throws:

NotFoundException - a programEntryId is not found

NullArgumentException - programEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProgramEntries

UpdateResponseList updateProgramEntries(ProgramEntryBatchFormList programEntryForms)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

programEntryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - programEntryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllProgramEntries

DeleteResponseList deleteAllProgramEntries()
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes all ProgramEntries in this CourseCatalog .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProgramEntries

DeleteResponseList deleteProgramEntries(IdList programEntryIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes program entries for the given Ids.

Parameters:

programEntryIds - the Ids of the program entries to delete

Returns:

the delete responses

Throws:

NullArgumentException - programEntryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProgramEntriesForProgram

DeleteResponseList deleteProgramEntriesForProgram(Id programId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes program entries for the given program.

Parameters:

programId - the Id of a program

Returns:

the delete responses

Throws:

NullArgumentException - programId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProgramEntriesForStudent

DeleteResponseList deleteProgramEntriesForStudent(Id resourceId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes program entries for the given student

Parameters:

resourceId - the Id of a student

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveProgramEntriesByDate

DeleteResponseList deleteIneffectiveProgramEntriesByDate(DateTime date)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Deletes program entries 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.

aliasProgramEntries

AliasResponseList aliasProgramEntries(AliasRequestList aliasRequests)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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