Interface | osid.ontology.batch.RelevancyBatchAdminSession | ||
---|---|---|---|
Implements | osid.ontology.RelevancyAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getRelevancyFormsForCreate | ||
Description |
Gets the relevancy forms for creating a bunch of new relevancies. A form is returned for each subject and related pair. | ||
Parameters | osid.ontology.batch.RelevancyPeerList | peers | the relationship peers |
osid.type.Type[] | relevancyRecordTypes | array of relevancy record types to be included in each create operation or an empty list if none | |
Return | osid.ontology.batch.RelevancyBatchFormList | the relevancy forms | |
Errors | NOT_FOUND | a subjectId is not found | |
NULL_ARGUMENT | peers or relevancyRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createRelevancies | ||
Description |
Creates a new set of | ||
Parameters | osid.ontology.batch.RelevancyBatchFormList | relevancyForms | the relevancy forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | relevancyForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelevancyFormsForUpdate | ||
Description |
Gets the relevancy forms for updating an existing set of relevancies. A new relevancy form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | relevancyIds | the Ids of the Relevancy |
Return | osid.ontology.batch.RelevancyBatchFormList | the relevancy form | |
Errors | NOT_FOUND | a relevancyId is not found | |
NULL_ARGUMENT | relevancyIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRelevancies | ||
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
| ||
Parameters | osid.ontology.batch.RelevancyBatchFormList | relevancyForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | relevancyForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllRelevancies | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRelevancies | ||
Description |
Deletes relevancies for the given | ||
Parameters | osid.id.IdList | relevancyIds | the Ids of the relevancies to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | relevancyIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRelevanciesForSubject | ||
Description |
Deletes relevancies for the given subject. | ||
Parameters | osid.id.Id | subjectId | the Id of a subject |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | subjectId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRelevanciesForMappedId | ||
Description |
Deletes relevancies for the given mapped | ||
Parameters | osid.id.Id | id | an Id |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | id is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveRelevanciesByDate | ||
Description |
Deletes relevancies expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasRelevancies | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |