org.osid.ontology.batch

Interface RelevancyBatchAdminSession

All Superinterfaces:

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

public interface RelevancyBatchAdminSession
extends RelevancyAdminSession

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

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

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

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

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

The delete operations delete Relevancies in bulk. To unmap a Relevancy from the current Ontology, the RelevancyOntologyAssignmentSession should be used. These delete operations attempt to remove the Relevancy 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	aliasRelevancies(AliasRequestList aliasRequests) Adds an Id to a Relevancy for the purpose of creating compatibility.
CreateResponseList	createRelevancies(RelevancyBatchFormList relevancyForms) Creates a new set of Relevancies.
DeleteResponseList	deleteAllRelevancies() Deletes all Relevancies in this Ontology .
DeleteResponseList	deleteIneffectiveRelevanciesByDate(DateTime date) Deletes relevancies expired before the given date.
DeleteResponseList	deleteRelevancies(IdList relevancyIds) Deletes relevancies for the given Ids.
DeleteResponseList	deleteRelevanciesForMappedId(Id id) Deletes relevancies for the given mapped Id.
DeleteResponseList	deleteRelevanciesForSubject(Id subjectId) Deletes relevancies for the given subject.
RelevancyBatchFormList	getRelevancyFormsForCreate(RelevancyPeerList peers, Type[] relevancyRecordTypes) Gets the relevancy forms for creating a bunch of new relevancies.
RelevancyBatchFormList	getRelevancyFormsForUpdate(IdList relevancyIds) Gets the relevancy forms for updating an existing set of relevancies.
UpdateResponseList	updateRelevancies(RelevancyBatchFormList relevancyForms) Updates existing relevancies.

Methods inherited from interface org.osid.ontology.RelevancyAdminSession

aliasRelevancy, canCreateRelevancies, canCreateRelevancyWithRecordTypes, canDeleteRelevancies, canManageRelevancyAliases, canUpdateRelevancies, createRelevancy, deleteRelevancy, getOntology, getOntologyId, getRelevancyFormForCreate, getRelevancyFormForUpdate, updateRelevancy

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

getRelevancyFormsForCreate

RelevancyBatchFormList getRelevancyFormsForCreate(RelevancyPeerList peers,
                                                Type[] relevancyRecordTypes)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the relevancy forms for creating a bunch of new relevancies. A form is returned for each subject and related pair.

Parameters:

peers - the relationship peers

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

Returns:

the relevancy forms

Throws:

NotFoundException - a subjectId is not found

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

createRelevancies

CreateResponseList createRelevancies(RelevancyBatchFormList relevancyForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

relevancyForms - the relevancy forms

Returns:

the create responses

Throws:

NullArgumentException - relevancyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelevancyFormsForUpdate

RelevancyBatchFormList getRelevancyFormsForUpdate(IdList relevancyIds)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

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

Parameters:

relevancyIds - the Ids of the Relevancy

Returns:

the relevancy form

Throws:

NotFoundException - a relevancyId is not found

NullArgumentException - relevancyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRelevancies

UpdateResponseList updateRelevancies(RelevancyBatchFormList relevancyForms)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

relevancyForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - relevancyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllRelevancies

DeleteResponseList deleteAllRelevancies()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Deletes all Relevancies in this Ontology .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRelevancies

DeleteResponseList deleteRelevancies(IdList relevancyIds)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes relevancies for the given Ids.

Parameters:

relevancyIds - the Ids of the relevancies to delete

Returns:

the delete responses

Throws:

NullArgumentException - relevancyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRelevanciesForSubject

DeleteResponseList deleteRelevanciesForSubject(Id subjectId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Deletes relevancies for the given subject.

Parameters:

subjectId - the Id of a subject

Returns:

the delete responses

Throws:

NullArgumentException - subjectId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRelevanciesForMappedId

DeleteResponseList deleteRelevanciesForMappedId(Id id)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes relevancies for the given mapped Id.

Parameters:

id - an Id

Returns:

the delete responses

Throws:

NullArgumentException - id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveRelevanciesByDate

DeleteResponseList deleteIneffectiveRelevanciesByDate(DateTime date)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

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

aliasRelevancies

AliasResponseList aliasRelevancies(AliasRequestList aliasRequests)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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