Interface | osid.ontology.rules.RelevancyEnablerOntologyAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignRelevancyEnablers | ||
Description |
Tests if this user can alter relevancy enabler/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 | canAssignRelevancyEnablersToOntology | ||
Description |
Tests if this user can alter relevancy enabler/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 enabler 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 | getAssignableOntologyIdsForRelevancyEnabler | ||
Description |
Gets a list of ontologies including and under the given ontology node in which a specific relevancy enabler can be assigned. | ||
Parameters | osid.id.Id | ontologyId | the Id of the Ontology |
osid.id.Id | relevancyEnablerId | the Id of the RelevancyEnabler | |
Return | osid.id.IdList | list of assignable ontology Ids | |
Errors | NULL_ARGUMENT | ontologyId or relevancyEnablerId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignRelevancyEnablerToOntology | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | relevancyEnablerId | the Id of the RelevancyEnabler |
osid.id.Id | ontologyId | the Id of the Ontology | |
Errors | ALREADY_EXISTS | relevancyEnablerId is already assigned to ontologyId
| |
NOT_FOUND | relevancyEnablerId or ontologyId not found | ||
NULL_ARGUMENT | relevancyEnablerId or ontologyId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignRelevancyEnablerFromOntology | ||
Description |
Removes a | ||
Parameters | osid.id.Id | relevancyEnablerId | the Id of the RelevancyEnabler |
osid.id.Id | ontologyId | the Id of the Ontology | |
Errors | NOT_FOUND | relevancyEnablerId or ontologyId not found or
relevancyEnablerId not assigned to ontologyId | |
NULL_ARGUMENT | relevancyEnablerId or ontologyId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignRelevancyEnablerToOntology | ||
Description |
Moves a | ||
Parameters | osid.id.Id | relevancyEnablerId | the Id of the RelevancyEnabler |
osid.id.Id | fromOntologyId | the Id of the current Ontology | |
osid.id.Id | toOntologyId | the Id of the destination Ontology | |
Errors | NOT_FOUND | relevancyEnablerId, fromOntologyId, or toOntologyId
not found or relevancyEnablerId not mapped to
fromOntologyId | |
NULL_ARGUMENT | relevancyEnablerId, fromOntologyId, or toOntologyId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |