org.osid.recognition.batch

Interface ConferralBatchAdminSession

All Superinterfaces:

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

public interface ConferralBatchAdminSession
extends ConferralAdminSession

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

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

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

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

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

The delete operations delete Conferrals in bulk. To unmap a Conferral from the current Academy, the ConferralAcademyAssignmentSession should be used. These delete operations attempt to remove the Conferral itself thus removing it from all known Academy catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasConferrals(AliasRequestList aliasRequests) Adds an Id to a Conferral for the purpose of creating compatibility.
CreateResponseList	createConferrals(ConferralBatchFormList conferralForms) Creates a new set of Conferrals.
DeleteResponseList	deleteAllConferrals() Deletes all Conferrals in this Academy .
DeleteResponseList	deleteConferrals(IdList conferralIds) Deletes conferrals for the given Ids.
DeleteResponseList	deleteConferralsForAward(Id awardId) Deletes conferrals for the given award.
DeleteResponseList	deleteConferralsForRecipient(Id resourceId) Deletes conferrals for the given recipient.
DeleteResponseList	deleteIneffectiveConferralsByDate(DateTime date) Deletes conferrals expired before the given date.
ConferralBatchFormList	getConferralFormsForCreate(ConferralPeerList peers, Type[] conferralRecordTypes) Gets the conferral forms for creating a bunch of new conferrals.
ConferralBatchFormList	getConferralFormsForUpdate(IdList conferralIds) Gets the conferral forms for updating an existing set of conferrals.
UpdateResponseList	updateConferrals(ConferralBatchFormList conferralForms) Updates existing conferrals.

Methods inherited from interface org.osid.recognition.ConferralAdminSession

aliasConferral, canCreateConferrals, canCreateConferralWithRecordTypes, canDeleteConferrals, canManageConferralAliases, canUpdateConferrals, createConferral, deleteConferral, getAcademy, getAcademyId, getConferralFormForCreate, getConferralFormForUpdate, updateConferral

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

getConferralFormsForCreate

ConferralBatchFormList getConferralFormsForCreate(ConferralPeerList peers,
                                                Type[] conferralRecordTypes)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the conferral forms for creating a bunch of new conferrals. A new form is retuned for each supplied award and recipient.

Parameters:

peers - a list of conferral peers

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

Returns:

the conferral forms

Throws:

NotFoundException - an awardId or resourceId is not found

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

createConferrals

CreateResponseList createConferrals(ConferralBatchFormList conferralForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

conferralForms - the conferral forms

Returns:

the create responses

Throws:

NullArgumentException - conferralForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getConferralFormsForUpdate

ConferralBatchFormList getConferralFormsForUpdate(IdList conferralIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

conferralIds - the Ids of the Conferral

Returns:

the conferral form

Throws:

NotFoundException - a conferralId is not found

NullArgumentException - conferralIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateConferrals

UpdateResponseList updateConferrals(ConferralBatchFormList conferralForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

conferralForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - conferralForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllConferrals

DeleteResponseList deleteAllConferrals()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Conferrals in this Academy .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteConferrals

DeleteResponseList deleteConferrals(IdList conferralIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes conferrals for the given Ids.

Parameters:

conferralIds - the Ids of the conferrals to delete

Returns:

the delete responses

Throws:

NullArgumentException - conferralIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteConferralsForAward

DeleteResponseList deleteConferralsForAward(Id awardId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Deletes conferrals for the given award.

Parameters:

awardId - the Id of the award

Returns:

the delete responses

Throws:

NullArgumentException - awardId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteConferralsForRecipient

DeleteResponseList deleteConferralsForRecipient(Id resourceId)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes conferrals for the given recipient.

Parameters:

resourceId - the Id of the resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveConferralsByDate

DeleteResponseList deleteIneffectiveConferralsByDate(DateTime date)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

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

aliasConferrals

AliasResponseList aliasConferrals(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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