org.osid.learning.batch

Interface ProficiencyBatchAdminSession

All Superinterfaces:

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

public interface ProficiencyBatchAdminSession
extends ProficiencyAdminSession

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

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

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

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

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

The delete operations delete Proficiencies in bulk. To unmap a Proficiency from the current ObjectiveBank, the ProficiencyObjectiveBankAssignmentSession should be used. These delete operations attempt to remove the Proficiency itself thus removing it from all known ObjectiveBank catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasProficiencies(AliasRequestList aliasRequests) Adds an Id to a Proficiency for the purpose of creating compatibility.
CreateResponseList	createProficiencies(ProficiencyBatchFormList proficiencyForms) Creates a new set of Proficiencies.
DeleteResponseList	deleteAllProficiencies() Deletes all Proficiencies in this ObjectiveBank .
DeleteResponseList	deleteIneffectiveProficienciesByDate(DateTime date) Deletes proficiencies expired befoe the given date.
DeleteResponseList	deleteProficiencies(IdList proficiencyIds) Deletes proficiencies for the given Ids.
DeleteResponseList	deleteProficienciesForObjective(Id objectiveId) Deletes proficiencies for the given objective.
DeleteResponseList	deleteProficienciesForResource(Id resourceId) Deletes proficiencies for the given resource.
ProficiencyBatchFormList	getProficiencyFormsForCreate(ProficiencyPeerList peers, Type[] proficiencyRecordTypes) Gets the proficiency forms for creating a bunch of new proficiencies.
ProficiencyBatchFormList	getProficiencyFormsForUpdate(IdList proficiencyIds) Gets the proficiency forms for updating an existing set of proficiencies.
UpdateResponseList	updateProficiencies(ProficiencyBatchFormList proficiencyForms) Updates existing proficiencies.

Methods inherited from interface org.osid.learning.ProficiencyAdminSession

aliasProficiency, canCreateProficiencies, canCreateProficiencyWithRecordTypes, canDeleteProficiencies, canManageProficiencyAliases, canUpdateProficiencies, createProficiency, deleteProficiencies, deleteProficiency, getObjectiveBank, getObjectiveBankId, getProficiencyFormForCreate, getProficiencyFormForUpdate, updateProficiency

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

getProficiencyFormsForCreate

ProficiencyBatchFormList getProficiencyFormsForCreate(ProficiencyPeerList peers,
                                                    Type[] proficiencyRecordTypes)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the proficiency forms for creating a bunch of new proficiencies. A form is returned for each supplied objective and resource peer.

Parameters:

peers - the proficiency peers

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

Returns:

the proficiency forms

Throws:

NotFoundException - an objectiveId or resourceId is not found

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

createProficiencies

CreateResponseList createProficiencies(ProficiencyBatchFormList proficiencyForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

proficiencyForms - the proficiency forms

Returns:

the create responses

Throws:

NullArgumentException - proficiencyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProficiencyFormsForUpdate

ProficiencyBatchFormList getProficiencyFormsForUpdate(IdList proficiencyIds)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

proficiencyIds - the Ids of the Proficiency

Returns:

the proficiency form

Throws:

NotFoundException - a proficiencyId is not found

NullArgumentException - proficiencyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateProficiencies

UpdateResponseList updateProficiencies(ProficiencyBatchFormList proficiencyForms)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

proficiencyForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - proficiencyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllProficiencies

DeleteResponseList deleteAllProficiencies()
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes all Proficiencies in this ObjectiveBank .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProficiencies

DeleteResponseList deleteProficiencies(IdList proficiencyIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes proficiencies for the given Ids.

Parameters:

proficiencyIds - the Ids of the proficiencies to delete

Returns:

the delete responses

Throws:

NullArgumentException - proficiencyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProficienciesForObjective

DeleteResponseList deleteProficienciesForObjective(Id objectiveId)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Deletes proficiencies for the given objective.

Parameters:

objectiveId - the Id of an objective

Returns:

the delete responses

Throws:

NullArgumentException - objectiveId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteProficienciesForResource

DeleteResponseList deleteProficienciesForResource(Id resourceId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Deletes proficiencies for the given resource.

Parameters:

resourceId - the Id of a 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.

deleteIneffectiveProficienciesByDate

DeleteResponseList deleteIneffectiveProficienciesByDate(DateTime date)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Deletes proficiencies expired befoe 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.

aliasProficiencies

AliasResponseList aliasProficiencies(AliasRequestList aliasRequests)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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