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 Modifier and Type | Method and 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. |
changeBranch, initialize, rollbackService
close
getCatalogEnablerRecordTypes, getCatalogEnablerSearchRecordTypes, supportsCatalogEnablerAdmin, supportsCatalogEnablerCatalog, supportsCatalogEnablerCatalogAssignment, supportsCatalogEnablerLookup, supportsCatalogEnablerNotification, supportsCatalogEnablerQuery, supportsCatalogEnablerRecordType, supportsCatalogEnablerRuleApplication, supportsCatalogEnablerRuleLookup, supportsCatalogEnablerSearch, supportsCatalogEnablerSearchRecordType, supportsCatalogEnablerSmartCatalog, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
CatalogEnablerLookupSession getCatalogEnablerLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalog
enabler lookup service.proxy
- a proxy CatalogEnablerLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerLookup()
is false
optional
- This method must be implemented if
supportsCatalogEnablerLookup()
is true.
CatalogEnablerLookupSession getCatalogEnablerLookupSessionForCatalog(Id catalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the catalog
enabler lookup service for the given catalog.catalogId
- the Id
of the Catalog
proxy
- a proxy CatalogEnablerLookupSession
NotFoundException
- no Catalog
found by
the given Id
NullArgumentException
- catalogId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCatalogEnablerLookup()
and
supportsVisibleFederation()
are true.
CatalogEnablerQuerySession getCatalogEnablerQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalog
enabler query service.proxy
- a proxy CatalogEnablerQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerQuery()
is false
optional
- This method must be implemented if
supportsCatalogEnablerQuery()
is true.
CatalogEnablerQuerySession getCatalogEnablerQuerySessionForCatalog(Id catalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the catalog
enabler query service for the given catalog.catalogId
- the Id
of the Catalog
proxy
- a proxy CatalogEnablerQuerySession
NotFoundException
- no Catalog
found by
the given Id
NullArgumentException
- catalogId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCatalogEnablerQuery()
and
supportsVisibleFederation()
are true.
CatalogEnablerSearchSession getCatalogEnablerSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalog
enabler search service.proxy
- a proxy CatalogEnablerSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerSearch()
is false
optional
- This method must be implemented if
supportsCatalogEnablerSearch()
is true.
CatalogEnablerSearchSession getCatalogEnablerSearchSessionForCatalog(Id catalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the catalog
enablers earch service for the given catalog.catalogId
- the Id
of the Catalog
proxy
- a proxy CatalogEnablerSearchSession
NotFoundException
- no Catalog
found by
the given Id
NullArgumentException
- catalogId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCatalogEnablerSearch()
and
supportsVisibleFederation()
are true.
CatalogEnablerAdminSession getCatalogEnablerAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalog
enabler administration service.proxy
- a proxy CatalogEnablerAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerAdmin()
is false
optional
- This method must be implemented if
supportsCatalogEnablerAdmin()
is true.
CatalogEnablerAdminSession getCatalogEnablerAdminSessionForCatalog(Id catalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the catalog
enabler administration service for the given catalog.catalogId
- the Id
of the Catalog
proxy
- a proxy CatalogEnablerAdminSession
NotFoundException
- no Catalog
found by
the given Id
NullArgumentException
- catalogId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCatalogEnablerAdmin()
and
supportsVisibleFederation()
are true.
CatalogEnablerNotificationSession getCatalogEnablerNotificationSession(CatalogEnablerReceiver catalogEnablerReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalog
enabler notification service.catalogEnablerReceiver
- the notification callbackproxy
- a proxy CatalogEnablerNotificationSession
NullArgumentException
- catalogEnablerReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerNotification()
is false
optional
- This method must be implemented if
supportsCatalogEnablerNotification()
is
true.
CatalogEnablerNotificationSession getCatalogEnablerNotificationSessionForCatalog(CatalogEnablerReceiver catalogEnablerReceiver, Id catalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the catalog
enabler notification service for the given catalog.catalogEnablerReceiver
- the notification callbackcatalogId
- the Id
of the Catalog
proxy
- a proxy CatalogEnablerNotificationSession
NotFoundException
- no catalog found by the given
Id
NullArgumentException
- catalogEnablerReceiver,
catalogId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCatalogEnablerNotification()
and
supportsVisibleFederation()
are true.
CatalogEnablerCatalogSession getCatalogEnablerCatalogSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup catalog enabler/catalog
mappings for cataloging enablers.proxy
- a proxy CatalogEnablerCatalogSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerCatalog()
is false
optional
- This method must be implemented if
supportsCatalogEnablerCatalog()
is true.
CatalogEnablerCatalogAssignmentSession getCatalogEnablerCatalogAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning catalog
enablers to catalogs for cataloging.proxy
- a proxy CatalogEnablerCatalogAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerCatalogAssignment()
is
false
optional
- This method must be implemented if
supportsCatalogEnablerCatalogAssignment()
is
true.
CatalogEnablerSmartCatalogSession getCatalogEnablerSmartCatalogSession(Id catalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage catalog enabler smart
catalogs.catalogId
- the Id
of the Catalog
proxy
- a proxy CatalogEnablerSmartCatalogSession
NotFoundException
- no Catalog
found by
the given Id
NullArgumentException
- catalogId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerSmartCatalog()
is false
optional
- This method must be implemented if
supportsCatalogEnablerSmartCatalog()
is
true.
CatalogEnablerRuleLookupSession getCatalogEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalog
enabler mapping lookup service for looking up the rules applied to the
catalog.proxy
- a proxy CatalogEnablerRuleLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerRuleLookup()
is false
optional
- This method must be implemented if
supportsCatalogEnablerRuleLookup()
is true.
CatalogEnablerRuleLookupSession getCatalogEnablerRuleLookupSessionForCatalog(Id catalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the catalog
enabler mapping lookup service for the given catalog for looking up
rules applied to a catalog.catalogId
- the Id
of the Catalog
proxy
- a proxy CatalogEnablerRuleLookupSession
NotFoundException
- no Catalog
found by
the given Id
NullArgumentException
- catalogId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCatalogEnablerRuleLookup()
and
supportsVisibleFederation()
are true.
CatalogEnablerRuleApplicationSession getCatalogEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalog
enabler assignment service to apply enablers to catalogs.proxy
- a proxy CatalogEnablerRuleApplicationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsCatalogEnablerRuleApplication()
is
true.
CatalogEnablerRuleApplicationSession getCatalogEnablerRuleApplicationSessionForCatalog(Id catalogId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the catalog
enabler assignment service for the given catalog to apply enablers to
catalogs.catalogId
- the Id
of the Catalog
proxy
- a proxy CatalogEnablerRuleApplicationSession
NotFoundException
- no Catalog
found by
the given Id
NullArgumentException
- catalogId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCatalogEnablerRuleApplication()
and
supportsVisibleFederation()
are true