org.osid.offering.batch

Interface ResultBatchAdminSession

All Superinterfaces:

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

public interface ResultBatchAdminSession
extends ResultAdminSession

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

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

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

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

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

The delete operations delete Results in bulk. To unmap a Result from the current Catalogue, the ResultCatalogueAssignmentSession should be used. These delete operations attempt to remove the Result itself thus removing it from all known Catalogue catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasResults(AliasRequestList aliasRequests) Adds an Id to a Result for the purpose of creating compatibility.
CreateResponseList	createResults(ResultBatchFormList resultForms) Creates a new set of Results.
DeleteResponseList	deleteAllResults() Deletes all Results in this Catalogue .
DeleteResponseList	deleteResults(IdList resultIds) Deletes results for the given Ids.
DeleteResponseList	deleteResultsForParticipant(Id participantId) Deletes results for the given participant.
ResultBatchFormList	getResultFormsForCreate(IdList participantIds, Type[] resultRecordTypes) Gets the result forms for creating a bunch of new results.
ResultBatchFormList	getResultFormsForUpdate(IdList resultIds) Gets the result forms for updating an existing set of results.
UpdateResponseList	updateResults(ResultBatchFormList resultForms) Updates existing results.

Methods inherited from interface org.osid.offering.ResultAdminSession

aliasResult, canCreateResults, canCreateResultWithRecordTypes, canDeleteResults, canManageResultAliases, canUpdateResults, createResult, deleteResult, getCatalogue, getCatalogueId, getResultFormForCreate, getResultFormForUpdate, updateResult

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

getResultFormsForCreate

ResultBatchFormList getResultFormsForCreate(IdList participantIds,
                                          Type[] resultRecordTypes)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the result forms for creating a bunch of new results. A form is returned for each participant.

Parameters:

participantIds - a list of participants

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

Returns:

the result forms

Throws:

NotFoundException - a participantId is not found

NullArgumentException - participantIds or resultRecordTypes 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.

createResults

CreateResponseList createResults(ResultBatchFormList resultForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

resultForms - the result forms

Returns:

the create responses

Throws:

NullArgumentException - resultForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getResultFormsForUpdate

ResultBatchFormList getResultFormsForUpdate(IdList resultIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

resultIds - the Ids of the Result

Returns:

the result form

Throws:

NotFoundException - a resultId is not found

NullArgumentException - resultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateResults

UpdateResponseList updateResults(ResultBatchFormList resultForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

resultForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - resultForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllResults

DeleteResponseList deleteAllResults()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Results in this Catalogue .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteResults

DeleteResponseList deleteResults(IdList resultIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes results for the given Ids.

Parameters:

resultIds - the Ids of the results to delete

Returns:

the delete responses

Throws:

NullArgumentException - resultIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteResultsForParticipant

DeleteResponseList deleteResultsForParticipant(Id participantId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Deletes results for the given participant.

Parameters:

participantId - an Id of a participant

Returns:

the delete responses

Throws:

NullArgumentException - participantId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasResults

AliasResponseList aliasResults(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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