OSID Logo
OSID Specifications
ontology batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.batch.RelevancyBatchAdminSession
Implementsosid.ontology.RelevancyAdminSession
Description

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.

MethodgetRelevancyFormsForCreate
Description

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

Parametersosid.ontology.batch.RelevancyPeerListpeersthe relationship peers
osid.type.Type[]relevancyRecordTypesarray of relevancy record types to be included in each create operation or an empty list if none
Returnosid.ontology.batch.RelevancyBatchFormListthe relevancy forms
ErrorsNOT_FOUNDa subjectId is not found
NULL_ARGUMENT peers or relevancyRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateRelevancies
Description

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 .

Parametersosid.ontology.batch.RelevancyBatchFormListrelevancyFormsthe relevancy forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT relevancyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRelevancyFormsForUpdate
Description

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

Parametersosid.id.IdListrelevancyIdsthe Ids of the Relevancy
Returnosid.ontology.batch.RelevancyBatchFormListthe relevancy form
ErrorsNOT_FOUNDa relevancyId is not found
NULL_ARGUMENT relevancyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRelevancies
Description

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 .

Parametersosid.ontology.batch.RelevancyBatchFormListrelevancyFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT relevancyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllRelevancies
Description

Deletes all Relevancies in this Ontology .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRelevancies
Description

Deletes relevancies for the given Ids.

Parametersosid.id.IdListrelevancyIdsthe Ids of the relevancies to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT relevancyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRelevanciesForSubject
Description

Deletes relevancies for the given subject.

Parametersosid.id.IdsubjectIdthe Id of a subject
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT subjectId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRelevanciesForMappedId
Description

Deletes relevancies for the given mapped Id.

Parametersosid.id.Ididan Id
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveRelevanciesByDate
Description

Deletes relevancies expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasRelevancies
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.