Interface | osid.ontology.SubjectLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Subjects may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
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 | canLookupSubjects | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSubjectView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenarySubjectView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedOntologyView | ||
Description |
Federates the view for methods in this session. A federated view will include subjects in ontologies which are children of this ontology in the ontology hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedOntologyView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this ontology only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSubject | ||
Description |
Gets the | ||
Parameters | osid.id.Id | subjectId | Id of the Subject |
Return | osid.ontology.Subject | the subject | |
Errors | NOT_FOUND | subjectId not found | |
NULL_ARGUMENT | subjectId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSubjectsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | subjectIds | the list of Ids to retrieve |
Return | osid.ontology.SubjectList | the returned Subject list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | subjectIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubjectsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | subjectGenusType | a subject genus type |
Return | osid.ontology.SubjectList | the returned Subject list | |
Errors | NULL_ARGUMENT | subjectGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubjectsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | subjectGenusType | a subject genus type |
Return | osid.ontology.SubjectList | the returned Subject list | |
Errors | NULL_ARGUMENT | subjectGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubjectsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | subjectRecordType | a subject record type |
Return | osid.ontology.SubjectList | the returned Subject list | |
Errors | NULL_ARGUMENT | subjectRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubjects | ||
Description |
Gets all | ||
Return | osid.ontology.SubjectList | a SubjectList | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |