Interface OntologyManager

All Superinterfaces:

AutoCloseable, Closeable, OntologyProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface OntologyManager
extends OsidManager, OntologyProfile

The ontology manager provides access to ontology sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• SubjectLookupSession : a session to look up subjects
• SubjectQuerySession : a session to query subjects
• SubjectSearchSession: a session to search subjects
• SubjectAdminSession : a session to create, modify and delete subjects
• SubjectNotificationSession: a session to receive messages pertaining to subject changes
• SubjectHierarchySession : a session to traverse subject hierarchies
• SubjectHierarchyDesignSession : a sesion to manage subject hierarchies
• SubjectOntologySession : a session for retriieving subject and ontology mappings
• SubjectOntologyAssignmentSession : a session for managing subject and ontology mappings
• SubjectSmartOntologySession : a session to manage dynamic ontologies of subjects

• RelevancyLookupSession : a session to look up subject relevancies
• RelevancyQuerySession : a session to query subject relevancies
• RelevancySearchSession: a session to search subject relevancies
• RelevancyAdminSession : a session to create, modify and delete subject relevancies
• RelevancyNotificationSession: a session to receive messages pertaining to subject relevancy changes
• RelevancyOntologySession : a session for retriieving relevancy and ontology mappings
• RelevancyOntologyAssignmentSession : a session for managing relevancy and ontology mappings
• RelevancySmartOntologySession : a session to manage dynamic ontologies of relevancies

• OntologyLookupSession : a session to lookup ontologies
• OntologyQuerySession : a session to search ontologies
• OntologySearchSession : a session to search ontologies
• OntologyAdminSession : a session to create, modify and delete ontologies
• OntologyNotificationSession : a session to receive messages pertaining to ontology changes
• OntologyHierarchySession : a session to traverse the ontology hierarchy
• OntologyHierarchyDesignSession : a session to manage the ontology hierarchy

Method Summary

Modifier and Type	Method	Description
OntologyAdminSession	getOntologyAdminSession()	Gets the OsidSession associated with the ontology administration service.
OntologyAssignmentSession	getOntologyAssignmentSession()	Gets the session to assign Ids to ontologies.
OntologyBatchManager	getOntologyBatchManager()	Gets the ontology batch service.
OntologyHierarchyDesignSession	getOntologyHierarchyDesignSession()	Gets the session designing ontology hierarchies.
OntologyHierarchySession	getOntologyHierarchySession()	Gets the session traversing ontology hierarchies.
OntologyLookupSession	getOntologyLookupSession()	Gets the OsidSession associated with the ontology lookup service.
OntologyNotificationSession	getOntologyNotificationSession(OntologyReceiver ontologyReceiver)	Gets the notification session for notifications pertaining to ontology service changes.
OntologyQuerySession	getOntologyQuerySession()	Gets the OsidSession associated with the ontology query service.
OntologyRulesManager	getOntologyRulesManager()	Gets the ontology rules service.
OntologySearchSession	getOntologySearchSession()	Gets the OsidSession associated with the ontology search service.
RelevancyAdminSession	getRelevancyAdminSession()	Gets the OsidSession associated with the relevancy administration service.
RelevancyAdminSession	getRelevancyAdminSessionForOntology(Id ontologyId)	Gets the OsidSession associated with the relevancy admin service for the given ontology.
RelevancyLookupSession	getRelevancyLookupSession()	Gets the OsidSession associated with the relevancy lookup service.
RelevancyLookupSession	getRelevancyLookupSessionForOntology(Id ontologyId)	Gets the OsidSession associated with the relevancy lookup service for the given ontology.
RelevancyNotificationSession	getRelevancyNotificationSession(RelevancyReceiver relevancyReceiver)	Gets the notification session for notifications pertaining to relevancy changes.
RelevancyNotificationSession	getRelevancyNotificationSessionForOntology(RelevancyReceiver relevancyReceiver, Id ontologyId)	Gets the OsidSession associated with the relevancy notification service for the given ontology.
RelevancyOntologyAssignmentSession	getRelevancyOntologyAssignmentSession()	Gets the session managing relevancy ontology mappings.
RelevancyOntologySession	getRelevancyOntologySession()	Gets the session retrieving relevancy ontology mappings.
RelevancyQuerySession	getRelevancyQuerySession()	Gets the OsidSession associated with the relevancy query service.
RelevancyQuerySession	getRelevancyQuerySessionForOntology(Id ontologyId)	Gets the OsidSession associated with the relevancy query service for the given ontology.
RelevancySearchSession	getRelevancySearchSession()	Gets the OsidSession associated with the relevancy search service.
RelevancySearchSession	getRelevancySearchSessionForOntology(Id ontologyId)	Gets the OsidSession associated with the relevancy search service for the given ontology.
RelevancySmartOntologySession	getRelevancySmartOntologySession(Id ontologyId)	Gets the session managing relevancy smart ontologies.
SubjectAdminSession	getSubjectAdminSession()	Gets the OsidSession associated with the subject administration service.
SubjectAdminSession	getSubjectAdminSessionForOntology(Id ontologyId)	Gets the OsidSession associated with the subject admin service for the given ontology.
SubjectHierarchyDesignSession	getSubjectHierarchyDesignSession()	Gets the session designing subject hierarchies.
SubjectHierarchyDesignSession	getSubjectHierarchyDesignSessionForOntology(Id ontologyId)	Gets the OsidSession associated with the subject heirarchy design service for the given ontology.
SubjectHierarchySession	getSubjectHierarchySession()	Gets the session traversing subject hierarchies.
SubjectHierarchySession	getSubjectHierarchySessionForId(Id id)	Gets the hierarchy session for the given Id assigned using the OntologyAssignmentSession .
SubjectHierarchySession	getSubjectHierarchySessionForOntology(Id ontologyId)	Gets the OsidSession associated with the subject heirarchy traversal service for the given ontology.
SubjectLookupSession	getSubjectLookupSession()	Gets the OsidSession associated with the subject lookup service.
SubjectLookupSession	getSubjectLookupSessionForId(Id id)	Gets the OsidSession associated with the subject lookup service for the given Id assigned using the OntologyAssignmentSession .
SubjectLookupSession	getSubjectLookupSessionForOntology(Id ontologyId)	Gets the OsidSession associated with the subject lookup service for the given ontology.
SubjectNotificationSession	getSubjectNotificationSession(SubjectReceiver subjectReceiver)	Gets the notification session for notifications pertaining to subject changes.
SubjectNotificationSession	getSubjectNotificationSessionForOntology(SubjectReceiver subjectReceiver, Id ontologyId)	Gets the OsidSession associated with the subject notification service for the given ontology.
SubjectOntologyAssignmentSession	getSubjectOntologyAssignmentSession()	Gets the session managing subject ontology mappings.
SubjectOntologySession	getSubjectOntologySession()	Gets the session retrieving subject ontology mappings.
SubjectQuerySession	getSubjectQuerySession()	Gets the OsidSession associated with the subject query service.
SubjectQuerySession	getSubjectQuerySessionForOntology(Id ontologyId)	Gets the OsidSession associated with the subject query service for the given ontology.
SubjectSearchSession	getSubjectSearchSession()	Gets the OsidSession associated with the subject search service.
SubjectSearchSession	getSubjectSearchSessionForOntology(Id ontologyId)	Gets the OsidSession associated with the subject search service for the given ontology.
SubjectSmartOntologySession	getSubjectSmartOntologySession(Id ontologyId)	Gets the session managing subject smart ontologies.

Methods inherited from interface Closeable

close

Methods inherited from interface OntologyProfile

getOntologyRecordTypes, getOntologySearchRecordTypes, getRelevancyRecordTypes, getRelevancySearchRecordTypes, getSubjectRecordTypes, getSubjectSearchRecordTypes, supportsOntologyAdmin, supportsOntologyAssignment, supportsOntologyBatch, supportsOntologyHierarchy, supportsOntologyHierarchyDesign, supportsOntologyLookup, supportsOntologyNotification, supportsOntologyQuery, supportsOntologyRecordType, supportsOntologyRules, supportsOntologySearch, supportsOntologySearchRecordType, supportsRelevancyAdmin, supportsRelevancyLookup, supportsRelevancyNotification, supportsRelevancyOntology, supportsRelevancyOntologyAssignment, supportsRelevancyQuery, supportsRelevancyRecordType, supportsRelevancySearch, supportsRelevancySearchRecordType, supportsRelevancySmartOntology, supportsSubjectAdmin, supportsSubjectHierarchy, supportsSubjectHierarchyDesign, supportsSubjectLookup, supportsSubjectNotification, supportsSubjectOntology, supportsSubjectOntologyAssignment, supportsSubjectQuery, supportsSubjectRecordType, supportsSubjectSearch, supportsSubjectSearchRecordType, supportsSubjectSmartOntology, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getOntologyRecordTypes()	Gets the supported Ontology record types.
TypeList	getOntologySearchRecordTypes()	Gets the supported ontology search record types.
TypeList	getRelevancyRecordTypes()	Gets the supported Relevancy record types.
TypeList	getRelevancySearchRecordTypes()	Gets the supported Relevancy search record types.
TypeList	getSubjectRecordTypes()	Gets the supported Subject record types.
TypeList	getSubjectSearchRecordTypes()	Gets the supported Subject search record types.
boolean	supportsOntologyAdmin()	Tests if an ontology administrative service is supported.
boolean	supportsOntologyAssignment()	Tests if Ids can be asssigned to ontologies.
boolean	supportsOntologyBatch()	Tests if an ontology batch service is supported.
boolean	supportsOntologyHierarchy()	Tests if an ontology hierarchy traversal is supported.
boolean	supportsOntologyHierarchyDesign()	Tests if ontology hierarchy design is supported.
boolean	supportsOntologyLookup()	Tests if an ontology lookup service is supported.
boolean	supportsOntologyNotification()	Tests if ontology notification is supported.
boolean	supportsOntologyQuery()	Tests if an ontology query service is supported.
boolean	supportsOntologyRecordType(Type ontologyRecordType)	Tests if the given Ontology record type is supported.
boolean	supportsOntologyRules()	Tests if an ontology rules service is supported.
boolean	supportsOntologySearch()	Tests if an ontology search service is supported.
boolean	supportsOntologySearchRecordType(Type ontologySearchRecordType)	Tests if the given ontology search record type is supported.
boolean	supportsRelevancyAdmin()	Tests if a relevancy administrative service is supported.
boolean	supportsRelevancyLookup()	Tests if a subject relevancy lookup service is supported.
boolean	supportsRelevancyNotification()	Tests if relevancy notification is supported.
boolean	supportsRelevancyOntology()	Tests if a relevancy to ontology lookup session is available.
boolean	supportsRelevancyOntologyAssignment()	Tests if a relevancy to ontology assignment session is available.
boolean	supportsRelevancyQuery()	Tests if a relevancy query service is supported.
boolean	supportsRelevancyRecordType(Type relevancyRecordType)	Tests if the given Relevancy record type is supported.
boolean	supportsRelevancySearch()	Tests if a relevancy search service is supported.
boolean	supportsRelevancySearchRecordType(Type relevancySearchRecordType)	Tests if the given Relevancy search record type is supported.
boolean	supportsRelevancySmartOntology()	Tests if a relevancy smart ontology session is available.
boolean	supportsSubjectAdmin()	Tests if a subject administrative service is supported.
boolean	supportsSubjectHierarchy()	Tests if a subject hierarchy traversal is supported.
boolean	supportsSubjectHierarchyDesign()	Tests if subject hierarchy design is supported.
boolean	supportsSubjectLookup()	Tests if a subject lookup service is supported.
boolean	supportsSubjectNotification()	Tests if subject notification is supported.
boolean	supportsSubjectOntology()	Tests if a subject to ontology lookup session is available.
boolean	supportsSubjectOntologyAssignment()	Tests if a subject to ontology assignment session is available.
boolean	supportsSubjectQuery()	Tests if a subject query service is supported.
boolean	supportsSubjectRecordType(Type subjectRecordType)	Tests if the given Subject record type is supported.
boolean	supportsSubjectSearch()	Tests if a subject search service is supported.
boolean	supportsSubjectSearchRecordType(Type subjectSearchRecordType)	Tests if the given Subject search record type is supported.
boolean	supportsSubjectSmartOntology()	Tests if a subject smart ontology session is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getSubjectLookupSession

SubjectLookupSession getSubjectLookupSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the subject lookup service.

Returns:

a SubjectLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectLookup()} is {@code true} .

getSubjectLookupSessionForOntology

SubjectLookupSession getSubjectLookupSessionForOntology(Id ontologyId)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subject lookup service for the given ontology.

Parameters:

ontologyId - the Id of the ontology

Returns:

a SubjectLookupSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getSubjectLookupSessionForId

SubjectLookupSession getSubjectLookupSessionForId(Id id)
                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subject lookup service for the given Id assigned using the OntologyAssignmentSession .

Parameters:

id - an Id

Returns:

a SubjectLookupSession

Throws:

NotFoundException - id not found

NullArgumentException - id is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getSubjectQuerySession

SubjectQuerySession getSubjectQuerySession()
                                    throws OperationFailedException

Gets the OsidSession associated with the subject query service.

Returns:

a SubjectQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectQuery()} is {@code true} .

getSubjectQuerySessionForOntology

SubjectQuerySession getSubjectQuerySessionForOntology(Id ontologyId)
                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subject query service for the given ontology.

Parameters:

ontologyId - the Id of the ontology

Returns:

a SubjectQuerySession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getSubjectSearchSession

SubjectSearchSession getSubjectSearchSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the subject search service.

Returns:

a SubjectSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectSearch()} is {@code true} .

getSubjectSearchSessionForOntology

SubjectSearchSession getSubjectSearchSessionForOntology(Id ontologyId)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subject search service for the given ontology.

Parameters:

ontologyId - the Id of the ontology

Returns:

a SubjectSearchSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getSubjectAdminSession

SubjectAdminSession getSubjectAdminSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the subject administration service.

Returns:

a SubjectAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectAdmin()} is {@code true} .

getSubjectAdminSessionForOntology

SubjectAdminSession getSubjectAdminSessionForOntology(Id ontologyId)
                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subject admin service for the given ontology.

Parameters:

ontologyId - the Id of the ontology

Returns:

a SubjectAdminSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getSubjectNotificationSession

SubjectNotificationSession getSubjectNotificationSession(SubjectReceiver subjectReceiver)
                                                  throws OperationFailedException

Gets the notification session for notifications pertaining to subject changes.

Parameters:

subjectReceiver - the subject receiver

Returns:

a SubjectNotificationSession

Throws:

NullArgumentException - subjectReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectNotification()} is {@code true} .

getSubjectNotificationSessionForOntology

SubjectNotificationSession getSubjectNotificationSessionForOntology(SubjectReceiver subjectReceiver,
 Id ontologyId)
                                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subject notification service for the given ontology.

Parameters:

subjectReceiver - the subject receiver

ontologyId - the Id of the ontology

Returns:

a SubjectNotificationSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - subjectReceiver or ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getSubjectHierarchySession

SubjectHierarchySession getSubjectHierarchySession()
                                            throws OperationFailedException

Gets the session traversing subject hierarchies.

Returns:

a SubjectHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectHierarchy()} is true.

getSubjectHierarchySessionForOntology

SubjectHierarchySession getSubjectHierarchySessionForOntology(Id ontologyId)
                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subject heirarchy traversal service for the given ontology.

Parameters:

ontologyId - the Id of the ontology

Returns:

a SubjectHierarchySession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectHierarchy() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectHierarchy()} and {@code supportsVisibleFederation()} are {@code true} .

getSubjectHierarchySessionForId

SubjectHierarchySession getSubjectHierarchySessionForId(Id id)
                                                 throws NotFoundException,
OperationFailedException

Gets the hierarchy session for the given Id assigned using the OntologyAssignmentSession .

Parameters:

id - an Id

Returns:

a SubjectHierarchySession

Throws:

NotFoundException - id not found

NullArgumentException - id is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectHierarchy() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectHierarchy()} and {@code supportsVisibleFederation()} are {@code true} .

getSubjectHierarchyDesignSession

SubjectHierarchyDesignSession getSubjectHierarchyDesignSession()
                                                        throws OperationFailedException

Gets the session designing subject hierarchies.

Returns:

a SubjectHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectHierarchyDesign()} is true.

getSubjectHierarchyDesignSessionForOntology

SubjectHierarchyDesignSession getSubjectHierarchyDesignSessionForOntology(Id ontologyId)
                                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subject heirarchy design service for the given ontology.

Parameters:

ontologyId - the Id of the ontology

Returns:

a SubjectHierarchyDesignSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code true} .

getSubjectOntologySession

SubjectOntologySession getSubjectOntologySession()
                                          throws OperationFailedException

Gets the session retrieving subject ontology mappings.

Returns:

a SubjectOntologySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectOntology() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectOntology()} is true.

getSubjectOntologyAssignmentSession

SubjectOntologyAssignmentSession getSubjectOntologyAssignmentSession()
                                                              throws OperationFailedException

Gets the session managing subject ontology mappings.

Returns:

a SubjectOntologyAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectOntologyAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectOntologyAssignment()} is true.

getSubjectSmartOntologySession

SubjectSmartOntologySession getSubjectSmartOntologySession(Id ontologyId)
                                                    throws NotFoundException,
OperationFailedException

Gets the session managing subject smart ontologies.

Parameters:

ontologyId - the Id of the ontology

Returns:

a SubjectSmartOntologySession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectSmartOntology() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectSmartOntology()} is true.

getRelevancyLookupSession

RelevancyLookupSession getRelevancyLookupSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the relevancy lookup service.

Returns:

a RelevancyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyLookup()} is {@code true} .

getRelevancyLookupSessionForOntology

RelevancyLookupSession getRelevancyLookupSessionForOntology(Id ontologyId)
                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relevancy lookup service for the given ontology.

Parameters:

ontologyId - the Id of the ontology

Returns:

a RelevancyLookupSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getRelevancyQuerySession

RelevancyQuerySession getRelevancyQuerySession()
                                        throws OperationFailedException

Gets the OsidSession associated with the relevancy query service.

Returns:

a RelevancyQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyQuery()} is {@code true} .

getRelevancyQuerySessionForOntology

RelevancyQuerySession getRelevancyQuerySessionForOntology(Id ontologyId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relevancy query service for the given ontology.

Parameters:

ontologyId - the Id of the ontology

Returns:

a RelevancyQuerySession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getRelevancySearchSession

RelevancySearchSession getRelevancySearchSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the relevancy search service.

Returns:

a RelevancySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancySearch()} is {@code true} .

getRelevancySearchSessionForOntology

RelevancySearchSession getRelevancySearchSessionForOntology(Id ontologyId)
                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relevancy search service for the given ontology.

Parameters:

ontologyId - the Id of the ontology

Returns:

a RelevancySearchSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancySearch()} and {@code supportsVisibleFederation()} are {@code true} .

getRelevancyAdminSession

RelevancyAdminSession getRelevancyAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the relevancy administration service.

Returns:

a RelvancyAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyAdmin()} is {@code true} .

getRelevancyAdminSessionForOntology

RelevancyAdminSession getRelevancyAdminSessionForOntology(Id ontologyId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relevancy admin service for the given ontology.

Parameters:

ontologyId - the Id of the ontology

Returns:

a RelevancyAdminSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getRelevancyNotificationSession

RelevancyNotificationSession getRelevancyNotificationSession(RelevancyReceiver relevancyReceiver)
                                                      throws OperationFailedException

Gets the notification session for notifications pertaining to relevancy changes.

Parameters:

relevancyReceiver - the relevancy receiver

Returns:

a RelevancyNotificationSession

Throws:

NullArgumentException - relevancyReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyNotification()} is {@code true} .

getRelevancyNotificationSessionForOntology

RelevancyNotificationSession getRelevancyNotificationSessionForOntology(RelevancyReceiver relevancyReceiver,
 Id ontologyId)
                                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the relevancy notification service for the given ontology.

Parameters:

relevancyReceiver - the subject receiver

ontologyId - the Id of the ontology

Returns:

a RelevancyNotificationSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - relevancyReceiver or ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getRelevancyOntologySession

RelevancyOntologySession getRelevancyOntologySession()
                                              throws OperationFailedException

Gets the session retrieving relevancy ontology mappings.

Returns:

a RelevancyOntologySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyOntology() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyOntology()} is true.

getRelevancyOntologyAssignmentSession

RelevancyOntologyAssignmentSession getRelevancyOntologyAssignmentSession()
                                                                  throws OperationFailedException

Gets the session managing relevancy ontology mappings.

Returns:

a RelevancyOntologyAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyOntologyAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancyOntologyAssignment()} is true.

getRelevancySmartOntologySession

RelevancySmartOntologySession getRelevancySmartOntologySession(Id ontologyId)
                                                        throws NotFoundException,
OperationFailedException

Gets the session managing relevancy smart ontologies.

Parameters:

ontologyId - the Id of the ontology

Returns:

a RelevancySmartOntologySession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancySmartOntology() is false

Compliance:

optional - This method must be implemented if {@code supportsRelevancySmartOntology()} is true.

getOntologyLookupSession

OntologyLookupSession getOntologyLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the ontology lookup service.

Returns:

an OntologyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsOntologyLookup()} is true.

getOntologyQuerySession

OntologyQuerySession getOntologyQuerySession()
                                      throws OperationFailedException

Gets the OsidSession associated with the ontology query service.

Returns:

an OntologyQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsOntologyQuery()} is true.

getOntologySearchSession

OntologySearchSession getOntologySearchSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the ontology search service.

Returns:

an OntologySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsOntologySearch()} is true.

getOntologyAdminSession

OntologyAdminSession getOntologyAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the ontology administration service.

Returns:

an OntologyAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsOntologyAdmin()} is true.

getOntologyNotificationSession

OntologyNotificationSession getOntologyNotificationSession(OntologyReceiver ontologyReceiver)
                                                    throws OperationFailedException

Gets the notification session for notifications pertaining to ontology service changes.

Parameters:

ontologyReceiver - the ontology receiver

Returns:

an OntologyNotificationSession

Throws:

NullArgumentException - ontologyReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsOntologyNotification()} is true.

getOntologyHierarchySession

OntologyHierarchySession getOntologyHierarchySession()
                                              throws OperationFailedException

Gets the session traversing ontology hierarchies.

Returns:

an OntologyHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsOntologyHierarchy()} is true.

getOntologyHierarchyDesignSession

OntologyHierarchyDesignSession getOntologyHierarchyDesignSession()
                                                          throws OperationFailedException

Gets the session designing ontology hierarchies.

Returns:

an OntologyHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsOntologyHierarchyDesign()} is true.

getOntologyAssignmentSession

OntologyAssignmentSession getOntologyAssignmentSession()
                                                throws OperationFailedException

Gets the session to assign Ids to ontologies.

Returns:

an OntologyAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsOntologyAssignment()} is true.

getOntologyBatchManager

OntologyBatchManager getOntologyBatchManager()
                                      throws OperationFailedException

Gets the ontology batch service.

Returns:

an OntologyBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsOntologyBatch()} is true.

getOntologyRulesManager

OntologyRulesManager getOntologyRulesManager()
                                      throws OperationFailedException

Gets the ontology rules service.

Returns:

an OntologyRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyRules() is false

Compliance:

optional - This method must be implemented if {@code supportsOntologyRules()} is true.