org.osid.ontology.rules

Interface OntologyRulesProxyManager

All Superinterfaces:

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

public interface OntologyRulesProxyManager
extends OsidProxyManager, OntologyRulesProfile

The ontology rules proxy manager provides access to ontology rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. The sessions included in this manager are:

• RelevancyEnablerLookupSession: a session to retrieve relevancy enablers
• RelevancyEnablerQuerySession: a session to query for relevancy enablers
• RelevancyEnablerSearchSession: a session to search for relevancy enablers
• RelevancyEnablerAdminSession: a session to create and delete relevancy enablers
• RelevancyEnablerNotificationSession: a session to receive notifications pertaining to relevancy enabler changes
• RelevancyEnablerOntologySession: a session to look up relevancy enabler ontology mappings
• RelevancyEnablerOntologyAssignmentSession: a session to manage relevancy enabler to ontology mappings
• RelevancyEnablerSmartOntologySession: a session to manage dynamic ontologies of relevancy enablers
• RelevancyEnablerRuleLookupSession: a session to look up relevancy enabler to relevancy mappings
• RelevancyEnablerRuleApplicationSession: a session to apply relevancy enablers to relevancies

Method Summary

Methods

Modifier and Type	Method and Description
RelevancyEnablerAdminSession	getRelevancyEnablerAdminSession(Proxy proxy) Gets the OsidSession associated with the relevancy enabler administration service.
RelevancyEnablerAdminSession	getRelevancyEnablerAdminSessionForOntology(Id ontologyId, Proxy proxy) Gets the OsidSession associated with the relevancy enabler administration service for the given ontology.
RelevancyEnablerLookupSession	getRelevancyEnablerLookupSession(Proxy proxy) Gets the OsidSession associated with the relevancy enabler lookup service.
RelevancyEnablerLookupSession	getRelevancyEnablerLookupSessionForOntology(Id ontologyId, Proxy proxy) Gets the OsidSession associated with the relevancy enabler lookup service for the given ontology.
RelevancyEnablerNotificationSession	getRelevancyEnablerNotificationSession(RelevancyEnablerReceiver relevancyEnablerReceiver, Proxy proxy) Gets the OsidSession associated with the relevancy enabler notification service.
RelevancyEnablerNotificationSession	getRelevancyEnablerNotificationSessionForOntology(RelevancyEnablerReceiver relevancyEnablerReceiver, Id ontologyId, Proxy proxy) Gets the OsidSession associated with the relevancy enabler notification service for the given ontology.
RelevancyEnablerOntologyAssignmentSession	getRelevancyEnablerOntologyAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning relevancy enablers to ontologies for relevancy.
RelevancyEnablerOntologySession	getRelevancyEnablerOntologySession(Proxy proxy) Gets the OsidSession to lookup relevancy enabler/ontology mappings for relevancy enablers.
RelevancyEnablerQuerySession	getRelevancyEnablerQuerySession(Proxy proxy) Gets the OsidSession associated with the relevancy enabler query service.
RelevancyEnablerQuerySession	getRelevancyEnablerQuerySessionForOntology(Id ontologyId, Proxy proxy) Gets the OsidSession associated with the relevancy enabler query service for the given ontology.
RelevancyEnablerRuleApplicationSession	getRelevancyEnablerRuleApplicationSession(Proxy proxy) Gets the OsidSession associated with the relevancy enabler assignment service.
RelevancyEnablerRuleApplicationSession	getRelevancyEnablerRuleApplicationSessionForOntology(Id ontologyId, Proxy proxy) Gets the OsidSession associated with the relevancy enabler assignment service.
RelevancyEnablerRuleLookupSession	getRelevancyEnablerRuleLookupSession(Proxy proxy) Gets the OsidSession associated with the relevancy enabler relevancy mapping lookup service.
RelevancyEnablerRuleLookupSession	getRelevancyEnablerRuleLookupSessionForOntology(Id ontologyId, Proxy proxy) Gets the OsidSession associated with the relevancy enabler relevancy mapping lookup service.
RelevancyEnablerSearchSession	getRelevancyEnablerSearchSession(Proxy proxy) Gets the OsidSession associated with the relevancy enabler search service.
RelevancyEnablerSearchSession	getRelevancyEnablerSearchSessionForOntology(Id ontologyId, Proxy proxy) Gets the OsidSession associated with the relevancy enablers earch service for the given ontology.
RelevancyEnablerSmartOntologySession	getRelevancyEnablerSmartOntologySession(Id ontologyId, Proxy proxy) Gets the OsidSession to manage relevancy enabler 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.rules.OntologyRulesProfile

getRelevancyEnablerRecordTypes, getRelevancyEnablerSearchRecordTypes, supportsRelevancyEnablerAdmin, supportsRelevancyEnablerLookup, supportsRelevancyEnablerNotification, supportsRelevancyEnablerOntology, supportsRelevancyEnablerOntologyAssignment, supportsRelevancyEnablerQuery, supportsRelevancyEnablerRecordType, supportsRelevancyEnablerRuleApplication, supportsRelevancyEnablerRuleLookup, supportsRelevancyEnablerSearch, supportsRelevancyEnablerSearchRecordType, supportsRelevancyEnablerSmartOntology, 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

getRelevancyEnablerLookupSession

RelevancyEnablerLookupSession getRelevancyEnablerLookupSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the relevancy enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a RelevancyEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerLookup() is false

Compliance:

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

getRelevancyEnablerLookupSessionForOntology

RelevancyEnablerLookupSession getRelevancyEnablerLookupSessionForOntology(Id ontologyId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

ontologyId - the Id of the Ontology

proxy - a proxy

Returns:

a RelevancyEnablerLookupSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerLookup() or supportsVisibleFederation() is false

Compliance:

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

getRelevancyEnablerQuerySession

RelevancyEnablerQuerySession getRelevancyEnablerQuerySession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the relevancy enabler query service.

Parameters:

proxy - a proxy

Returns:

a RelevancyEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerQuery() is false

Compliance:

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

getRelevancyEnablerQuerySessionForOntology

RelevancyEnablerQuerySession getRelevancyEnablerQuerySessionForOntology(Id ontologyId,
                                                                      Proxy proxy)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

ontologyId - the Id of the Ontology

proxy - a proxy

Returns:

a RelevancyEnablerQuerySession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerQuery() or supportsVisibleFederation() is false

Compliance:

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

getRelevancyEnablerSearchSession

RelevancyEnablerSearchSession getRelevancyEnablerSearchSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the relevancy enabler search service.

Parameters:

proxy - a proxy

Returns:

a RelevancyEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerSearch() is false

Compliance:

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

getRelevancyEnablerSearchSessionForOntology

RelevancyEnablerSearchSession getRelevancyEnablerSearchSessionForOntology(Id ontologyId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

Gets the OsidSession associated with the relevancy enablers earch service for the given ontology.

Parameters:

ontologyId - the Id of the Ontology

proxy - a proxy

Returns:

a RelevancyEnablerSearchSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerSearch() or supportsVisibleFederation() is false

Compliance:

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

getRelevancyEnablerAdminSession

RelevancyEnablerAdminSession getRelevancyEnablerAdminSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the relevancy enabler administration service.

Parameters:

proxy - a proxy

Returns:

a RelevancyEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerAdmin() is false

Compliance:

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

getRelevancyEnablerAdminSessionForOntology

RelevancyEnablerAdminSession getRelevancyEnablerAdminSessionForOntology(Id ontologyId,
                                                                      Proxy proxy)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

Gets the OsidSession associated with the relevancy enabler administration service for the given ontology.

Parameters:

ontologyId - the Id of the Ontology

proxy - a proxy

Returns:

a RelevancyEnablerAdminSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getRelevancyEnablerNotificationSession

RelevancyEnablerNotificationSession getRelevancyEnablerNotificationSession(RelevancyEnablerReceiver relevancyEnablerReceiver,
                                                                         Proxy proxy)
                                                                           throws OperationFailedException

Gets the OsidSession associated with the relevancy enabler notification service.

Parameters:

relevancyEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a RelevancyEnablerNotificationSession

Throws:

NullArgumentException - relevancyEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerNotification() is false

Compliance:

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

getRelevancyEnablerNotificationSessionForOntology

RelevancyEnablerNotificationSession getRelevancyEnablerNotificationSessionForOntology(RelevancyEnablerReceiver relevancyEnablerReceiver,
                                                                                    Id ontologyId,
                                                                                    Proxy proxy)
                                                                                      throws NotFoundException,
                                                                                             OperationFailedException

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

Parameters:

relevancyEnablerReceiver - the notification callback

ontologyId - the Id of the Ontology

proxy - a proxy

Returns:

a RelevancyEnablerNotificationSession

Throws:

NotFoundException - no ontology found by the given Id

NullArgumentException - relevancyEnablerReceiver, ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerNotification() or supportsVisibleFederation() is false

Compliance:

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

getRelevancyEnablerOntologySession

RelevancyEnablerOntologySession getRelevancyEnablerOntologySession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession to lookup relevancy enabler/ontology mappings for relevancy enablers.

Parameters:

proxy - a proxy

Returns:

a RelevancyEnablerOntologySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerOntology() is false

Compliance:

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

getRelevancyEnablerOntologyAssignmentSession

RelevancyEnablerOntologyAssignmentSession getRelevancyEnablerOntologyAssignmentSession(Proxy proxy)
                                                                                       throws OperationFailedException

Gets the OsidSession associated with assigning relevancy enablers to ontologies for relevancy.

Parameters:

proxy - a proxy

Returns:

a RelevancyEnablerOntologyAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerOntologyAssignment() is false

Compliance:

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

getRelevancyEnablerSmartOntologySession

RelevancyEnablerSmartOntologySession getRelevancyEnablerSmartOntologySession(Id ontologyId,
                                                                           Proxy proxy)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

Gets the OsidSession to manage relevancy enabler smart ontologies.

Parameters:

ontologyId - the Id of the Ontology

proxy - a proxy

Returns:

a RelevancyEnablerSmartOntologySession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerSmartOntology() is false

Compliance:

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

getRelevancyEnablerRuleLookupSession

RelevancyEnablerRuleLookupSession getRelevancyEnablerRuleLookupSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the relevancy enabler relevancy mapping lookup service.

Parameters:

proxy - a proxy

Returns:

a RelevancyEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerRuleLookup() is false

Compliance:

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

getRelevancyEnablerRuleLookupSessionForOntology

RelevancyEnablerRuleLookupSession getRelevancyEnablerRuleLookupSessionForOntology(Id ontologyId,
                                                                                Proxy proxy)
                                                                                  throws NotFoundException,
                                                                                         OperationFailedException

Gets the OsidSession associated with the relevancy enabler relevancy mapping lookup service.

Parameters:

ontologyId - the Id of the Ontology

proxy - a proxy

Returns:

a RelevancyEnablerRuleLookupSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getRelevancyEnablerRuleApplicationSession

RelevancyEnablerRuleApplicationSession getRelevancyEnablerRuleApplicationSession(Proxy proxy)
                                                                                 throws OperationFailedException

Gets the OsidSession associated with the relevancy enabler assignment service.

Parameters:

proxy - a proxy

Returns:

a RelevancyEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerRuleApplication() is false

Compliance:

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

getRelevancyEnablerRuleApplicationSessionForOntology

RelevancyEnablerRuleApplicationSession getRelevancyEnablerRuleApplicationSessionForOntology(Id ontologyId,
                                                                                          Proxy proxy)
                                                                                            throws NotFoundException,
                                                                                                   OperationFailedException

Gets the OsidSession associated with the relevancy enabler assignment service.

Parameters:

ontologyId - the Id of the Ontology

proxy - a proxy

Returns:

a RelevancyEnablerRuleApplicationSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

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