org.osid.ontology

Interface OntologyLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface OntologyLookupSession
extends OsidSession

This session provides methods for retrieving Ontology objects. The Ontology represents a collection of Subjects.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

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 it can access, without breaking execution. However, an administrative application may require all Ontology elements to be available.

Ontologies may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Ontology.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupOntologies() Tests if this user can perform Ontology lookups.
OntologyList	getOntologies() Gets all Ontologies.
OntologyList	getOntologiesByGenusType(Type ontologyGenusType) Gets an OntologyList corresponding to the given ontology genus Type which does not include ontologies of types derived from the specified Type.
OntologyList	getOntologiesByIds(IdList ontologyIds) Gets an OntologyList corresponding to the given IdList.
OntologyList	getOntologiesByParentGenusType(Type ontologyGenusType) Gets an OntologyList corresponding to the given ontology genus Type and include any additional ontologies with genus types derived from the specified Type.
OntologyList	getOntologiesByProvider(Id resourceId) Gets an OntologyList for the given provider.
OntologyList	getOntologiesByRecordType(Type ontologyRecordType) Gets an OntologyList containing the given ontology record Type.
Ontology	getOntology(Id ontologyId) Gets the Ontology specified by its Id.
void	useComparativeOntologyView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryOntologyView() A complete view of the Ontology returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupOntologies

boolean canLookupOntologies()

Tests if this user can perform Ontology lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeOntologyView

void useComparativeOntologyView()

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.

usePlenaryOntologyView

void usePlenaryOntologyView()

A complete view of the Ontology returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getOntology

Ontology getOntology(Id ontologyId)
                     throws NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Gets the Ontology specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Ontology may have a different Id than requested, such as the case where a duplicate Id was assigned to an Ontology and retained for compatility.

Parameters:

ontologyId - Id of the Ontology

Returns:

the ontology

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getOntologiesByIds

OntologyList getOntologiesByIds(IdList ontologyIds)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets an OntologyList corresponding to the given IdList. In plenary mode, the returned list contains all of the ontologies specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Ontology objects may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

ontologyIds - the list of Ids to retrieve

Returns:

the returned Ontology list

Throws:

NotFoundException - an Id was not found

NullArgumentException - ontologyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologiesByGenusType

OntologyList getOntologiesByGenusType(Type ontologyGenusType)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets an OntologyList corresponding to the given ontology genus Type which does not include ontologies of types derived from the specified Type. In plenary mode, the returned list contains all known ontologies or an error results. Otherwise, the returned list may contain only those ontologies that are accessible through this session.

Parameters:

ontologyGenusType - an ontology genus type

Returns:

the returned Ontology list

Throws:

NullArgumentException - ontologyGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologiesByParentGenusType

OntologyList getOntologiesByParentGenusType(Type ontologyGenusType)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets an OntologyList corresponding to the given ontology genus Type and include any additional ontologies with genus types derived from the specified Type. In plenary mode, the returned list contains all known ontologies or an error results. Otherwise, the returned list may contain only those ontologies that are accessible through this session.

Parameters:

ontologyGenusType - an ontology genus type

Returns:

the returned Ontology list

Throws:

NullArgumentException - ontologyGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologiesByRecordType

OntologyList getOntologiesByRecordType(Type ontologyRecordType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets an OntologyList containing the given ontology record Type. In plenary mode, the returned list contains all known ontologies or an error results. Otherwise, the returned list may contain only those ontologies that are accessible through this session.

Parameters:

ontologyRecordType - an ontology record type

Returns:

the returned Ontology list

Throws:

NullArgumentException - ontologyRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologiesByProvider

OntologyList getOntologiesByProvider(Id resourceId)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets an OntologyList for the given provider. In plenary mode, the returned list contains all known ontologies or an error results. Otherwise, the returned list may contain only those ontologies that are accessible through this session.

Parameters:

resourceId - a resource Id

Returns:

the returned Ontology list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologies

OntologyList getOntologies()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets all Ontologies. In plenary mode, the returned list contains all known ontologies or an error results. Otherwise, the returned list may contain only those ontologies that are accessible through this session.

Returns:

an OntologyList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.