Interface | osid.ontology.RelevancyOntologyAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignRelevancies | ||
Description |
Tests if this user can alter relevancy/ontology
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignRelevanciesToOntology | ||
Description |
Tests if this user can alter relevancy/ontology
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Parameters | osid.id.Id | ontologyId | the Id of the Ontology |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | ontologyId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableOntologyIds | ||
Description |
Gets a list of ontologies including and under the given ontology node in which any relevancy can be assigned. | ||
Parameters | osid.id.Id | ontologyId | the Id of the Ontology |
Return | osid.id.IdList | list of assignable ontology Ids | |
Errors | NULL_ARGUMENT | ontologyId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableOntologyIdsForRelevancy | ||
Description |
Gets a list of ontologies including and under the given ontology node in which a specific relevancy can be assigned. | ||
Parameters | osid.id.Id | ontologyId | the Id of the Ontology |
osid.id.Id | relevancyId | the Id of the Relevancy | |
Return | osid.id.IdList | list of assignable ontology Ids | |
Errors | NULL_ARGUMENT | ontologyId or relevancyId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignRelevancyToOntology | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | relevancyId | the Id of the Relevancy |
osid.id.Id | ontologyId | the Id of the Ontology | |
Errors | ALREADY_EXISTS | relevancyId is already assigned to ontologyId | |
NOT_FOUND | relevancyId or ontologyId not found | ||
NULL_ARGUMENT | relevancyId or ontologyId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignRelevancyFromOntology | ||
Description |
Removes a | ||
Parameters | osid.id.Id | relevancyId | the Id of the Relevancy |
osid.id.Id | ontologyId | the Id of the Ontology | |
Errors | NOT_FOUND | relevancyId or ontologyId not found or
relevancyId not assigned to ontologyId | |
NULL_ARGUMENT | relevancyId or ontologyId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignRelevancyToOntology | ||
Description |
Moves a | ||
Parameters | osid.id.Id | relevancyId | the Id of the Relevancy |
osid.id.Id | fromOntologyId | the Id of the current Ontology | |
osid.id.Id | toOntologyId | the Id of the destination Ontology | |
Errors | NOT_FOUND | relevancyId, fromOntologyId, or toOntologyId
not found or relevancyId not mapped to fromOntologyId
| |
NULL_ARGUMENT | relevancyId, fromOntologyId, or toOntologyId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |