Interface CatalogingRulesProxyManager

All Superinterfaces:

AutoCloseable, CatalogingRulesProfile, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface CatalogingRulesProxyManager
extends OsidProxyManager, CatalogingRulesProfile

The cataloging proxy manager provides access to cataloging 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:

• CatalogEnablerLookupSession : a session to retrieve catalog enablers
• CatalogEnablerQuerySession : a session to query for catalog enablers
• CatalogEnablerSearchSession : a session to search for catalog enablers
• CatalogEnablerAdminSession : a session to create and delete catalog enablers
• CatalogEnablerNotificationSession : a session to receive notifications pertaining to catalog enabler changes
• CatalogEnablerCatalogSession : a session to look up catalog enabler catalog mappings
• CatalogEnablerCatalogAssignmentSession : a session to manage catalog enabler to catalog mappings
• CatalogEnablerSmartCatalogSession : a session to manage dynamic catalogs of catalog enablers
• CatalogEnableRuleLookupSession : a session to look up catalog enabler to catalog mappings
• CatalogEnablerRuleApplicationSession : a session to apply catalog enablers to catalogs

Method Summary

Modifier and Type	Method	Description
CatalogEnablerAdminSession	getCatalogEnablerAdminSession(Proxy proxy)	Gets the OsidSession associated with the catalog enabler administration service.
CatalogEnablerAdminSession	getCatalogEnablerAdminSessionForCatalog(Id catalogId, Proxy proxy)	Gets the OsidSession associated with the catalog enabler administration service for the given catalog.
CatalogEnablerCatalogAssignmentSession	getCatalogEnablerCatalogAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning catalog enablers to catalogs for cataloging.
CatalogEnablerCatalogSession	getCatalogEnablerCatalogSession(Proxy proxy)	Gets the OsidSession to lookup catalog enabler/catalog mappings for cataloging enablers.
CatalogEnablerLookupSession	getCatalogEnablerLookupSession(Proxy proxy)	Gets the OsidSession associated with the catalog enabler lookup service.
CatalogEnablerLookupSession	getCatalogEnablerLookupSessionForCatalog(Id catalogId, Proxy proxy)	Gets the OsidSession associated with the catalog enabler lookup service for the given catalog.
CatalogEnablerNotificationSession	getCatalogEnablerNotificationSession(CatalogEnablerReceiver catalogEnablerReceiver, Proxy proxy)	Gets the OsidSession associated with the catalog enabler notification service.
CatalogEnablerNotificationSession	getCatalogEnablerNotificationSessionForCatalog(CatalogEnablerReceiver catalogEnablerReceiver, Id catalogId, Proxy proxy)	Gets the OsidSession associated with the catalog enabler notification service for the given catalog.
CatalogEnablerQuerySession	getCatalogEnablerQuerySession(Proxy proxy)	Gets the OsidSession associated with the catalog enabler query service.
CatalogEnablerQuerySession	getCatalogEnablerQuerySessionForCatalog(Id catalogId, Proxy proxy)	Gets the OsidSession associated with the catalog enabler query service for the given catalog.
CatalogEnablerRuleApplicationSession	getCatalogEnablerRuleApplicationSession(Proxy proxy)	Gets the OsidSession associated with the catalog enabler assignment service to apply enablers to catalogs.
CatalogEnablerRuleApplicationSession	getCatalogEnablerRuleApplicationSessionForCatalog(Id catalogId, Proxy proxy)	Gets the OsidSession associated with the catalog enabler assignment service for the given catalog to apply enablers to catalogs.
CatalogEnablerRuleLookupSession	getCatalogEnablerRuleLookupSession(Proxy proxy)	Gets the OsidSession associated with the catalog enabler mapping lookup service for looking up the rules applied to the catalog.
CatalogEnablerRuleLookupSession	getCatalogEnablerRuleLookupSessionForCatalog(Id catalogId, Proxy proxy)	Gets the OsidSession associated with the catalog enabler mapping lookup service for the given catalog for looking up rules applied to a catalog.
CatalogEnablerSearchSession	getCatalogEnablerSearchSession(Proxy proxy)	Gets the OsidSession associated with the catalog enabler search service.
CatalogEnablerSearchSession	getCatalogEnablerSearchSessionForCatalog(Id catalogId, Proxy proxy)	Gets the OsidSession associated with the catalog enablers earch service for the given catalog.
CatalogEnablerSmartCatalogSession	getCatalogEnablerSmartCatalogSession(Id catalogId, Proxy proxy)	Gets the OsidSession to manage catalog enabler smart catalogs.

Methods inherited from interface CatalogingRulesProfile

getCatalogEnablerRecordTypes, getCatalogEnablerSearchRecordTypes, supportsCatalogEnablerAdmin, supportsCatalogEnablerCatalog, supportsCatalogEnablerCatalogAssignment, supportsCatalogEnablerLookup, supportsCatalogEnablerNotification, supportsCatalogEnablerQuery, supportsCatalogEnablerRecordType, supportsCatalogEnablerRuleApplication, supportsCatalogEnablerRuleLookup, supportsCatalogEnablerSearch, supportsCatalogEnablerSearchRecordType, supportsCatalogEnablerSmartCatalog, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getCatalogEnablerRecordTypes()	Gets the supported CatalogEnabler record types.
TypeList	getCatalogEnablerSearchRecordTypes()	Gets the supported CatalogEnabler search record types.
boolean	supportsCatalogEnablerAdmin()	Tests if a catalog enabler administrative service is supported.
boolean	supportsCatalogEnablerCatalog()	Tests if a catalog enabler catalog lookup service is supported.
boolean	supportsCatalogEnablerCatalogAssignment()	Tests if a catalog enabler catalog service is supported.
boolean	supportsCatalogEnablerLookup()	Tests if looking up catalog enablers is supported.
boolean	supportsCatalogEnablerNotification()	Tests if a catalog enabler notification service is supported.
boolean	supportsCatalogEnablerQuery()	Tests if querying catalog enablers is supported.
boolean	supportsCatalogEnablerRecordType(Type catalogEnablerRecordType)	Tests if the given CatalogEnabler record type is supported.
boolean	supportsCatalogEnablerRuleApplication()	Tests if a catalog enabler rule application service is supported.
boolean	supportsCatalogEnablerRuleLookup()	Tests if a catalog enabler rule lookup service is supported.
boolean	supportsCatalogEnablerSearch()	Tests if searching catalog enablers is supported.
boolean	supportsCatalogEnablerSearchRecordType(Type catalogEnablerSearchRecordType)	Tests if the given CatalogEnabler search record type is supported.
boolean	supportsCatalogEnablerSmartCatalog()	Tests if a catalog enabler catalog lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Methods inherited from interface Closeable

close

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

getCatalogEnablerLookupSession

CatalogEnablerLookupSession getCatalogEnablerLookupSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the catalog enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a CatalogEnablerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerLookup() is false

Compliance:

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

getCatalogEnablerLookupSessionForCatalog

CatalogEnablerLookupSession getCatalogEnablerLookupSessionForCatalog(Id catalogId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the catalog enabler lookup service for the given catalog.

Parameters:

catalogId - the Id of the Catalog

proxy - a proxy

Returns:

a CatalogEnablerLookupSession

Throws:

NotFoundException - no Catalog found by the given Id

NullArgumentException - catalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerLookup() or supportsVisibleFederation() is false

Compliance:

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

getCatalogEnablerQuerySession

CatalogEnablerQuerySession getCatalogEnablerQuerySession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the catalog enabler query service.

Parameters:

proxy - a proxy

Returns:

a CatalogEnablerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerQuery() is false

Compliance:

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

getCatalogEnablerQuerySessionForCatalog

CatalogEnablerQuerySession getCatalogEnablerQuerySessionForCatalog(Id catalogId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the catalog enabler query service for the given catalog.

Parameters:

catalogId - the Id of the Catalog

proxy - a proxy

Returns:

a CatalogEnablerQuerySession

Throws:

NotFoundException - no Catalog found by the given Id

NullArgumentException - catalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerQuery() or supportsVisibleFederation() is false

Compliance:

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

getCatalogEnablerSearchSession

CatalogEnablerSearchSession getCatalogEnablerSearchSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the catalog enabler search service.

Parameters:

proxy - a proxy

Returns:

a CatalogEnablerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerSearch() is false

Compliance:

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

getCatalogEnablerSearchSessionForCatalog

CatalogEnablerSearchSession getCatalogEnablerSearchSessionForCatalog(Id catalogId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the catalog enablers earch service for the given catalog.

Parameters:

catalogId - the Id of the Catalog

proxy - a proxy

Returns:

a CatalogEnablerSearchSession

Throws:

NotFoundException - no Catalog found by the given Id

NullArgumentException - catalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerSearch() or supportsVisibleFederation() is false

Compliance:

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

getCatalogEnablerAdminSession

CatalogEnablerAdminSession getCatalogEnablerAdminSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the catalog enabler administration service.

Parameters:

proxy - a proxy

Returns:

a CatalogEnablerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerAdmin() is false

Compliance:

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

getCatalogEnablerAdminSessionForCatalog

CatalogEnablerAdminSession getCatalogEnablerAdminSessionForCatalog(Id catalogId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the catalog enabler administration service for the given catalog.

Parameters:

catalogId - the Id of the Catalog

proxy - a proxy

Returns:

a CatalogEnablerAdminSession

Throws:

NotFoundException - no Catalog found by the given Id

NullArgumentException - catalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCatalogEnablerNotificationSession

CatalogEnablerNotificationSession getCatalogEnablerNotificationSession(CatalogEnablerReceiver catalogEnablerReceiver,
 Proxy proxy)
                                                                throws OperationFailedException

Gets the OsidSession associated with the catalog enabler notification service.

Parameters:

catalogEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a CatalogEnablerNotificationSession

Throws:

NullArgumentException - catalogEnablerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerNotification() is false

Compliance:

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

getCatalogEnablerNotificationSessionForCatalog

CatalogEnablerNotificationSession getCatalogEnablerNotificationSessionForCatalog(CatalogEnablerReceiver catalogEnablerReceiver,
 Id catalogId,
 Proxy proxy)
                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the catalog enabler notification service for the given catalog.

Parameters:

catalogEnablerReceiver - the notification callback

catalogId - the Id of the Catalog

proxy - a proxy

Returns:

a CatalogEnablerNotificationSession

Throws:

NotFoundException - no catalog found by the given Id

NullArgumentException - catalogEnablerReceiver, catalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerNotification() or supportsVisibleFederation() is false

Compliance:

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

getCatalogEnablerCatalogSession

CatalogEnablerCatalogSession getCatalogEnablerCatalogSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession to lookup catalog enabler/catalog mappings for cataloging enablers.

Parameters:

proxy - a proxy

Returns:

a CatalogEnablerCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerCatalog() is false

Compliance:

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

getCatalogEnablerCatalogAssignmentSession

CatalogEnablerCatalogAssignmentSession getCatalogEnablerCatalogAssignmentSession(Proxy proxy)
                                                                          throws OperationFailedException

Gets the OsidSession associated with assigning catalog enablers to catalogs for cataloging.

Parameters:

proxy - a proxy

Returns:

a CatalogEnablerCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerCatalogAssignment() is false

Compliance:

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

getCatalogEnablerSmartCatalogSession

CatalogEnablerSmartCatalogSession getCatalogEnablerSmartCatalogSession(Id catalogId,
 Proxy proxy)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage catalog enabler smart catalogs.

Parameters:

catalogId - the Id of the Catalog

proxy - a proxy

Returns:

a CatalogEnablerSmartCatalogSession

Throws:

NotFoundException - no Catalog found by the given Id

NullArgumentException - catalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerSmartCatalog() is false

Compliance:

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

getCatalogEnablerRuleLookupSession

CatalogEnablerRuleLookupSession getCatalogEnablerRuleLookupSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the catalog enabler mapping lookup service for looking up the rules applied to the catalog.

Parameters:

proxy - a proxy

Returns:

a CatalogEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerRuleLookup() is false

Compliance:

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

getCatalogEnablerRuleLookupSessionForCatalog

CatalogEnablerRuleLookupSession getCatalogEnablerRuleLookupSessionForCatalog(Id catalogId,
 Proxy proxy)
                                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the catalog enabler mapping lookup service for the given catalog for looking up rules applied to a catalog.

Parameters:

catalogId - the Id of the Catalog

proxy - a proxy

Returns:

a CatalogEnablerRuleLookupSession

Throws:

NotFoundException - no Catalog found by the given Id

NullArgumentException - catalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getCatalogEnablerRuleApplicationSession

CatalogEnablerRuleApplicationSession getCatalogEnablerRuleApplicationSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the OsidSession associated with the catalog enabler assignment service to apply enablers to catalogs.

Parameters:

proxy - a proxy

Returns:

a CatalogEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerRuleApplication() is false

Compliance:

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

getCatalogEnablerRuleApplicationSessionForCatalog

CatalogEnablerRuleApplicationSession getCatalogEnablerRuleApplicationSessionForCatalog(Id catalogId,
 Proxy proxy)
                                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the catalog enabler assignment service for the given catalog to apply enablers to catalogs.

Parameters:

catalogId - the Id of the Catalog

proxy - a proxy

Returns:

a CatalogEnablerRuleApplicationSession

Throws:

NotFoundException - no Catalog found by the given Id

NullArgumentException - catalogId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

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