org.osid.ontology

Interface OntologyProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OntologyProfile, OsidProfile, OsidProxyManager, Sourceable

public interface OntologyProxyManager
extends OsidProxyManager, OntologyProfile

The authentication manager provides access to ontology sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy. 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

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.ontology.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getSubjectLookupSession

SubjectLookupSession getSubjectLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the subject lookup service.

Parameters:

proxy - a proxy

Returns:

a SubjectLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectLookup() is false

Compliance:

optional - This method must be implemented if supportsSubjectLookup() is true.

getSubjectLookupSessionForOntology

SubjectLookupSession getSubjectLookupSessionForOntology(Id ontologyId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a SubjectLookupSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectLookup() or supportsVisibleFederation() is false

Compliance:

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

getSubjectLookupSessionForId

SubjectLookupSession getSubjectLookupSessionForId(Id id,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

id - an Id

proxy - a proxy

Returns:

a SubjectLookupSession

Throws:

NotFoundException - id not found

NullArgumentException - id or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectLookup() or supportsVisibleFederation() is false

Compliance:

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

getSubjectQuerySession

SubjectQuerySession getSubjectQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the subject query service.

Parameters:

proxy - a proxy

Returns:

a SubjectQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjecQuery() is false

Compliance:

optional - This method must be implemented if supportsSubjectQuery() is true.

getSubjectQuerySessionForOntology

SubjectQuerySession getSubjectQuerySessionForOntology(Id ontologyId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a SubjectQuerySession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectQuery() or supportsVisibleFederation() is false

Compliance:

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

getSubjectSearchSession

SubjectSearchSession getSubjectSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the subject search service.

Parameters:

proxy - a proxy

Returns:

a SubjectSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectSearch() is false

Compliance:

optional - This method must be implemented if supportsSubjectSearch() is true.

getSubjectSearchSessionForOntology

SubjectSearchSession getSubjectSearchSessionForOntology(Id ontologyId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a SubjectSearchSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectSearch() or supportsVisibleFederation() is false

Compliance:

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

getSubjectAdminSession

SubjectAdminSession getSubjectAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the subject administration service.

Parameters:

proxy - a proxy

Returns:

a SubjectAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectAdmin() is false

Compliance:

optional - This method must be implemented if supportsSubjectAdmin() is true.

getSubjectAdminSessionForOntology

SubjectAdminSession getSubjectAdminSessionForOntology(Id ontologyId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a SubjectAdminSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectAdmin() or supportsVisibleFederation() is false

Compliance:

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

getSubjectNotificationSession

SubjectNotificationSession getSubjectNotificationSession(SubjectReceiver subjectReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the notification session for notifications pertaining to subject changes.

Parameters:

subjectReceiver - the subject receiver

proxy - a proxy

Returns:

a SubjectNotificationSession

Throws:

NullArgumentException - subjectReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectNotification() is false

Compliance:

optional - This method must be implemented if supportsSubjectNotification() is true.

getSubjectNotificationSessionForOntology

SubjectNotificationSession getSubjectNotificationSessionForOntology(SubjectReceiver subjectReceiver,
                                                                  Id ontologyId,
                                                                  Proxy proxy)
                                                                    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

proxy - a proxy

Returns:

a SubjectNotificationSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - subjectReceiver, ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectNotification() or supportsVisibleFederation() is false

Compliance:

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

getSubjectHierarchySession

SubjectHierarchySession getSubjectHierarchySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the session traversing subject hierarchies.

Parameters:

proxy - a proxy

Returns:

a SubjectHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectHierarchy() is false

Compliance:

optional - This method must be implemented if supportsSubjectHierarchy() is true.

getSubjectHierarchySessionForOntology

SubjectHierarchySession getSubjectHierarchySessionForOntology(Id ontologyId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a SubjectHierarchySession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectHierarchy() or supportsVisibleFederation() is false

Compliance:

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

getSubjectHierarchySessionForId

SubjectHierarchySession getSubjectHierarchySessionForId(Id id,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

id - an Id

proxy - a proxy

Returns:

a SubjectHierarchySession

Throws:

NotFoundException - id not found

NullArgumentException - id or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectHierarchy() or supportsVisibleFederation() is false

Compliance:

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

getSubjectHierarchyDesignSession

SubjectHierarchyDesignSession getSubjectHierarchyDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the session designing subject hierarchies.

Parameters:

proxy - a proxy

Returns:

a SubjectHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsSubjectHierarchyDesign() is true.

getSubjectHierarchyDesignSessionForOntology

SubjectHierarchyDesignSession getSubjectHierarchyDesignSessionForOntology(Id ontologyId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a SubjectHierarchyDesignSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

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

getSubjectOntologySession

SubjectOntologySession getSubjectOntologySession(Proxy proxy)
                                                 throws OperationFailedException

Gets the session retrieving subject ontology mappings.

Parameters:

proxy - a proxy

Returns:

a SubjectOntologySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectOntology() is false

Compliance:

optional - This method must be implemented if supportsSubjectOntology() is true.

getSubjectOntologyAssignmentSession

SubjectOntologyAssignmentSession getSubjectOntologyAssignmentSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the session managing subject ontology mappings.

Parameters:

proxy - a proxy

Returns:

a SubjectOntologyAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectOntologyAssignment() is false

Compliance:

optional - This method must be implemented if supportsSubjectOntologyAssignment() is true.

getSubjectSmartOntologySession

SubjectOntologySession getSubjectSmartOntologySession(Id ontologyId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the session managing subject smart ontologies.

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a SubjectSmartOntologySession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectSmartOntology() is false

Compliance:

optional - This method must be implemented if supportsSubjectSmartOntology() is true.

getRelevancyLookupSession

RelevancyLookupSession getRelevancyLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the relevancy lookup service.

Parameters:

proxy - a proxy

Returns:

a RelevancyLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyLookup() is false

Compliance:

optional - This method must be implemented if supportsRelevancyLookup() is true.

getRelevancyLookupSessionForOntology

RelevancyLookupSession getRelevancyLookupSessionForOntology(Id ontologyId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a RelevancyLookupSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyLookup() or supportsVisibleFederation() is false

Compliance:

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

getRelevancyQuerySession

RelevancyQuerySession getRelevancyQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the relevancy query service.

Parameters:

proxy - a proxy

Returns:

a RelevancyQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyQuery() is false

Compliance:

optional - This method must be implemented if supportsRelevancyQuery() is true.

getRelevancyQuerySessionForOntology

RelevancyQuerySession getRelevancyQuerySessionForOntology(Id ontologyId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a RelevancyQuerySession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyQuery() or supportsVisibleFederation() is false

Compliance:

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

getRelevancySearchSession

RelevancySearchSession getRelevancySearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the relevancy search service.

Parameters:

proxy - a proxy

Returns:

a RelevanctSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancySearch() is false

Compliance:

optional - This method must be implemented if supportsRelevancySearch() is true.

getRelevancySearchSessionForOntology

RelevancySearchSession getRelevancySearchSessionForOntology(Id ontologyId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a RelevancySearchSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancySearch() or supportsVisibleFederation() is false

Compliance:

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

getRelevancyAdminSession

RelevancyAdminSession getRelevancyAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the relevancy administration service.

Parameters:

proxy - a proxy

Returns:

a RelvancyAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyAdmin() is false

Compliance:

optional - This method must be implemented if supportsRelevancyAdmin() is true.

getRelevancyAdminSessionForOntology

RelevancyAdminSession getRelevancyAdminSessionForOntology(Id ontologyId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a RelevancyAdminSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyAdmin() or supportsVisibleFederation() is false

Compliance:

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

getRelevancyNotificationSession

RelevancyNotificationSession getRelevancyNotificationSession(RelevancyReceiver relevancyReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the notification session for notifications pertaining to relevancy changes.

Parameters:

relevancyReceiver - the relevancy receiver

proxy - a proxy

Returns:

a RelevancyNotificationSession

Throws:

NullArgumentException - relevancyReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyNotification() is false

Compliance:

optional - This method must be implemented if supportsRelevancyNotification() is true.

getRelevancyNotificationSessionForOntology

RelevancyNotificationSession getRelevancyNotificationSessionForOntology(RelevancyReceiver relevancyReceiver,
                                                                      Id ontologyId,
                                                                      Proxy proxy)
                                                                        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

proxy - a proxy

Returns:

a RelevancyNotificationSession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - relevancyReceiver, ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyNotification() or supportsVisibleFederation() is false

Compliance:

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

getRelevancyOntologySession

RelevancyOntologySession getRelevancyOntologySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the session retrieving relevancy ontology mappings.

Parameters:

proxy - a proxy

Returns:

a RelevancyOntologySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyOntology() is false

Compliance:

optional - This method must be implemented if supportsRelevancyOntology() is true.

getRelevancyOntologyAssignmentSession

RelevancyOntologyAssignmentSession getRelevancyOntologyAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

Gets the session managing relevancy ontology mappings.

Parameters:

proxy - a proxy

Returns:

a RelevancyOntologyAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyOntologyAssignment() is false

Compliance:

optional - This method must be implemented if supportsRelevancyOntologyAssignment() is true.

getRelevancySmartOntologySession

RelevancySmartOntologySession getRelevancySmartOntologySession(Id ontologyId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the session managing relevancy smart ontologies.

Parameters:

ontologyId - the Id of the ontology

proxy - a proxy

Returns:

a RelevancySmartOntologySession

Throws:

NotFoundException - ontologyId not found

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancySmartOntology() is false

Compliance:

optional - This method must be implemented if supportsRelevancySmartOntology() is true.

getOntologyLookupSession

OntologyLookupSession getOntologyLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the ontology lookup service.

Parameters:

proxy - a proxy

Returns:

an OntologyLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyLookup() is false

Compliance:

optional - This method must be implemented if supportsOntologyLookup() is true.

getOntologyQuerySession

OntologyQuerySession getOntologyQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the ontology query service.

Parameters:

proxy - a proxy

Returns:

an OntologyQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyQuery() is false

Compliance:

optional - This method must be implemented if supportsOntologyQuery() is true.

getOntologySearchSession

OntologySearchSession getOntologySearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the ontology search service.

Parameters:

proxy - a proxy

Returns:

an OntologySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologySearch() is false

Compliance:

optional - This method must be implemented if supportsOntologySearch() is true.

getOntologyAdminSession

OntologyAdminSession getOntologyAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the ontology administration service.

Parameters:

proxy - a proxy

Returns:

an OntologyAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyAdmin() is false

Compliance:

optional - This method must be implemented if supportsOntologyAdmin() is true.

getOntologyNotificationSession

OntologyNotificationSession getOntologyNotificationSession(OntologyReceiver ontologyReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

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

Parameters:

ontologyReceiver - the ontology receiver

proxy - a proxy

Returns:

an OntologyNotificationSession

Throws:

NullArgumentException - ontologyReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyNotification() is false

Compliance:

optional - This method must be implemented if supportsOntologyNotification() is true.

getOntologyHierarchySession

OntologyHierarchySession getOntologyHierarchySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the session traversing ontology hierarchies.

Parameters:

proxy - a proxy

Returns:

an OntologyHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyHierarchy() is false

Compliance:

optional - This method must be implemented if supportsOntologyHierarchy() is true.

getOntologyHierarchyDesignSession

OntologyHierarchyDesignSession getOntologyHierarchyDesignSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the session designing ontology hierarchies.

Parameters:

proxy - a proxy

Returns:

an OntologyHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsOntologyHierarchyDesign() is true.

getOntologyAssignmentSession

OntologyAssignmentSession getOntologyAssignmentSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the session to assign Ids to ontologies.

Parameters:

proxy - a proxy

Returns:

an OntologyAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyAssignment() is false

Compliance:

optional - This method must be implemented if supportsOntologyAssignment() is true.

getOntologyBatchProxyManager

OntologyBatchProxyManager getOntologyBatchProxyManager()
                                                       throws OperationFailedException

Gets the ontology batch service.

Returns:

an OntologyBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyBatch() is false

Compliance:

optional - This method must be implemented if supportsOntologyBatch() is true.

getOntologyRulesProxyManager

OntologyRulesProxyManager getOntologyRulesProxyManager()
                                                       throws OperationFailedException

Gets the ontology rules service.

Returns:

an OntologyRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyRules() is false

Compliance:

optional - This method must be implemented if supportsOntologyRules() is true.