org.osid.ontology.batch

Interface SubjectBatchAdminSession

All Superinterfaces:

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

public interface SubjectBatchAdminSession
extends SubjectAdminSession

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

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

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

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

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

The delete operations delete Subjects in bulk. To unmap a Subject from the current Ontology, the SubjectOntologyAssignmentSession should be used. These delete operations attempt to remove the Subject itself thus removing it from all known Ontology catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasSubjects(AliasRequestList aliasRequests) Adds an Id to a Subject for the purpose of creating compatibility.
CreateResponseList	createSubjects(SubjectBatchFormList subjectForms) Creates a new set of Subjects.
DeleteResponseList	deleteAllSubjects() Deletes all Subjects in this Ontology .
DeleteResponseList	deleteSubjects(IdList subjectIds) Deletes subjects for the given Ids.
SubjectBatchFormList	getSubjectFormsForCreate(long number, Type[] subjectRecordTypes) Gets the subject forms for creating a bunch of new subjects.
SubjectBatchFormList	getSubjectFormsForUpdate(IdList subjectIds) Gets the subject forms for updating an existing set of subjects.
UpdateResponseList	updateSubjects(SubjectBatchFormList subjectForms) Updates existing subjects.

Methods inherited from interface org.osid.ontology.SubjectAdminSession

aliasSubject, canCreateSubjects, canCreateSubjectWithRecordTypes, canDeleteSubjects, canManageSubjectAliases, canUpdateSubjects, createSubject, deleteSubject, getOntology, getOntologyId, getSubjectFormForCreate, getSubjectFormForUpdate, updateSubject

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

getSubjectFormsForCreate

SubjectBatchFormList getSubjectFormsForCreate(long number,
                                            Type[] subjectRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets the subject forms for creating a bunch of new subjects.

Parameters:

number - the number of forms to retrieve

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

Returns:

the subject forms

Throws:

NullArgumentException - subjectRecordTypes 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.

createSubjects

CreateResponseList createSubjects(SubjectBatchFormList subjectForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

subjectForms - the subject forms

Returns:

the create responses

Throws:

NullArgumentException - subjectForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSubjectFormsForUpdate

SubjectBatchFormList getSubjectFormsForUpdate(IdList subjectIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

subjectIds - the Ids of the Subject

Returns:

the subject form

Throws:

NotFoundException - a subjectId is not found

NullArgumentException - subjectIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateSubjects

UpdateResponseList updateSubjects(SubjectBatchFormList subjectForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

subjectForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - subjectForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllSubjects

DeleteResponseList deleteAllSubjects()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Subjects in this Ontology .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteSubjects

DeleteResponseList deleteSubjects(IdList subjectIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes subjects for the given Ids.

Parameters:

subjectIds - the Ids of the subjects to delete

Returns:

the delete responses

Throws:

NullArgumentException - subjectIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasSubjects

AliasResponseList aliasSubjects(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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