Interface RelevancyBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, 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 .