Interface | osid.ontology.OntologyLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. For example, a browsing application
may only need to examine the Ontologies may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of the | ||
Method | canLookupOntologies | ||
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 | useComparativeOntologyView | ||
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 | usePlenaryOntologyView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | Id of the Ontology |
Return | osid.ontology.Ontology | the ontology | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getOntologiesByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | ontologyIds | the list of Ids to retrieve |
Return | osid.ontology.OntologyList | the returned Ontology list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | ontologyIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOntologiesByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | ontologyGenusType | an ontology genus type |
Return | osid.ontology.OntologyList | the returned Ontology list | |
Errors | NULL_ARGUMENT | ontologyGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOntologiesByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | ontologyGenusType | an ontology genus type |
Return | osid.ontology.OntologyList | the returned Ontology list | |
Errors | NULL_ARGUMENT | ontologyGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOntologiesByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | ontologyRecordType | an ontology record type |
Return | osid.ontology.OntologyList | the returned Ontology list | |
Errors | NULL_ARGUMENT | ontologyRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOntologiesByProvider | ||
Description |
Gets an | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.ontology.OntologyList | the returned Ontology list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOntologies | ||
Description |
Gets all | ||
Return | osid.ontology.OntologyList | an OntologyList | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |