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