Interface | osid.ontology.RelevancyAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getOntologyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Ontology Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOntology | ||
Description |
Gets the | ||
Return | osid.ontology.Ontology | the Ontology associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRelevancies | ||
Description |
Tests if this user can create relevancies. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known creating a | ||
Return | boolean | false if Relevancy creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRelevancyWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | relevancyRecordTypes | array of relevancy record types |
Return | boolean | true if Relevancy creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | relevancyRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelevancyFormForCreate | ||
Description |
Gets the relevancy form for creating new relevancies. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | subjectId | the Id of the Subject |
osid.id.Id | id | a mapped Id | |
osid.type.Type[] | relevancyRecordTypes | array of relevancy record types | |
Return | osid.ontology.RelevancyForm | the relevancy form | |
Errors | NOT_FOUND | subjectId is not found | |
NULL_ARGUMENT | subjectId or id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createRelevancy | ||
Description |
Creates a new | ||
Parameters | osid.ontology.RelevancyForm | relevancyForm | the form for this Relevancy |
Return | osid.ontology.Relevancy | the new Relevancy | |
Errors | ILLEGAL_STATE | relevancyForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | relevancyForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | relevancyForm did not originate from
getRelevancyFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRelevancies | ||
Description |
Tests if this user can update relevancies. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known updating a | ||
Return | boolean | false if relevancy modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelevancyFormForUpdate | ||
Description |
Gets the relevancy form for updating an existing relevancy. A new relevancy form should be requested for each update transaction. | ||
Parameters | osid.id.Id | relevancyId | the Id of the Relevancy |
Return | osid.ontology.RelevancyForm | the relevancy form | |
Errors | NOT_FOUND | relevancyId is not found | |
NULL_ARGUMENT | relevancyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRelevancy | ||
Description |
Updates an existing relevancy. | ||
Parameters | osid.ontology.RelevancyForm | relevancyForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | relevancyForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | relevancyForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | relevancyForm did not originate from
getRelevancyFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRelevancies | ||
Description |
Tests if this user can delete relevancies. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known deleting a | ||
Return | boolean | false if Relevancy deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteRelevancy | ||
Description |
Deletes the | ||
Parameters | osid.id.Id | relevancyId | the Id of the Relevancy to delete |
Errors | NOT_FOUND | a Relevancy was not found identified by the given Id
| |
NULL_ARGUMENT | relevancyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRelevancyAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Relevancy aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRelevancy | ||
Description |
Adds an | ||
Parameters | osid.id.Id | relevancyId | the Id of a Relevancy |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | relevancyId not found | ||
NULL_ARGUMENT | relevancyId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |