Interface OntologyRulesProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OntologyRulesProfile, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OntologyRulesProfile

getRelevancyEnablerRecordTypes, getRelevancyEnablerSearchRecordTypes, supportsRelevancyEnablerAdmin, supportsRelevancyEnablerLookup, supportsRelevancyEnablerNotification, supportsRelevancyEnablerOntology, supportsRelevancyEnablerOntologyAssignment, supportsRelevancyEnablerQuery, supportsRelevancyEnablerRecordType, supportsRelevancyEnablerRuleApplication, supportsRelevancyEnablerRuleLookup, supportsRelevancyEnablerSearch, supportsRelevancyEnablerSearchRecordType, supportsRelevancyEnablerSmartOntology, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getRelevancyEnablerRecordTypes()	Gets the supported RelevancyEnabler record types.
TypeList	getRelevancyEnablerSearchRecordTypes()	Gets the supported RelevancyEnabler search record types.
boolean	supportsRelevancyEnablerAdmin()	Tests if a relevancy enabler administrative service is supported.
boolean	supportsRelevancyEnablerLookup()	Tests if looking up relevancy enablers is supported.
boolean	supportsRelevancyEnablerNotification()	Tests if a relevancy enabler notification service is supported.
boolean	supportsRelevancyEnablerOntology()	Tests if a relevancy enabler ontology lookup service is supported.
boolean	supportsRelevancyEnablerOntologyAssignment()	Tests if a relevancy enabler ontology service is supported.
boolean	supportsRelevancyEnablerQuery()	Tests if querying relevancy enablers is supported.
boolean	supportsRelevancyEnablerRecordType(Type relevancyEnablerRecordType)	Tests if the given RelevancyEnabler record type is supported.
boolean	supportsRelevancyEnablerRuleApplication()	Tests if a relevancy enabler rule application service is supported.
boolean	supportsRelevancyEnablerRuleLookup()	Tests if a relevancy enabler rule lookup service is supported.
boolean	supportsRelevancyEnablerSearch()	Tests if searching relevancy enablers is supported.
boolean	supportsRelevancyEnablerSearchRecordType(Type relevancyEnablerSearchRecordType)	Tests if the given RelevancyEnabler search record type is supported.
boolean	supportsRelevancyEnablerSmartOntology()	Tests if a relevancy enabler ontology lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

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

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 {@code supportsRelevancyEnablerLookup()} is {@code 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 {@code supportsRelevancyEnablerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelevancyEnablerQuery()} is {@code 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 {@code supportsRelevancyEnablerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelevancyEnablerSearch()} is {@code 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 {@code supportsRelevancyEnablerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelevancyEnablerAdmin()} is {@code 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 {@code supportsRelevancyEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelevancyEnablerNotification()} is {@code 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 {@code supportsRelevancyEnablerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelevancyEnablerOntology()} is {@code 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 {@code supportsRelevancyEnablerOntologyAssignment()} is {@code 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 {@code supportsRelevancyEnablerSmartOntology()} is {@code 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 {@code supportsRelevancyEnablerRuleLookup()} is {@code 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 {@code supportsRelevancyEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelevancyEnablerRuleApplication()} is {@code 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 {@code supportsRelevancyEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .