public interface HoldRulesProxyManager extends OsidProxyManager, HoldRulesProfile
The hold rules proxy manager provides access to hold 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:
HoldEnablerLookupSession:
a session to retrieve
hold enablers HoldEnablerQuerySession:
a session to query for
hold enablers HoldEnablerSearchSession:
a session to search for
hold enablers HoldEnablerAdminSession:
a session to create and
delete hold enablers HoldEnablerNotificationSession:
a session to
receive notifications pertaining to hold enabler changes HoldEnablerOublietteSession:
a session to look up
hold enabler oubliette mappings HoldEnablerOublietteAssignmentSession:
a session
to manage hold enabler to oubliette mappings HoldEnablerSmartOublietteSession:
a session to
manage dynamic oubliettes of hold enablers HoldEnablerRuleLookupSession:
a session to look up
hold enabler to hold mappings HoldEnablerRuleApplicationSession:
a session to
apply hold enablers to holds Modifier and Type | Method and Description |
---|---|
HoldEnablerAdminSession |
getHoldEnablerAdminSession(Proxy proxy)
Gets the
OsidSession associated with the hold enabler
administration service. |
HoldEnablerAdminSession |
getHoldEnablerAdminSessionForOubliette(Id oublietteId,
Proxy proxy)
Gets the
OsidSession associated with the hold enabler
administration service for the given oubliette. |
HoldEnablerLookupSession |
getHoldEnablerLookupSession(Proxy proxy)
Gets the
OsidSession associated with the hold enabler
lookup service. |
HoldEnablerLookupSession |
getHoldEnablerLookupSessionForOubliette(Id oublietteId,
Proxy proxy)
Gets the
OsidSession associated with the hold enabler
lookup service for the given oubliette. |
HoldEnablerNotificationSession |
getHoldEnablerNotificationSession(HoldEnablerReceiver holdEnablerReceiver,
Proxy proxy)
Gets the
OsidSession associated with the hold enabler
notification service. |
HoldEnablerNotificationSession |
getHoldEnablerNotificationSessionForOubliette(HoldEnablerReceiver holdEnablerReceiver,
Id oublietteId,
Proxy proxy)
Gets the
OsidSession associated with the hold enabler
notification service for the given oubliette. |
HoldEnablerOublietteAssignmentSession |
getHoldEnablerOublietteAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning hold
enablers to oubliettes |
HoldEnablerOublietteSession |
getHoldEnablerOublietteSession(Proxy proxy)
Gets the
OsidSession to lookup hold enabler/oubliette
mappings for hold enablers. |
HoldEnablerQuerySession |
getHoldEnablerQuerySession(Proxy proxy)
Gets the
OsidSession associated with the hold enabler
query service. |
HoldEnablerQuerySession |
getHoldEnablerQuerySessionForOubliette(Id oublietteId,
Proxy proxy)
Gets the
OsidSession associated with the hold enabler
query service for the given oubliette. |
HoldEnablerRuleApplicationSession |
getHoldEnablerRuleApplicationSession(Proxy proxy)
Gets the
OsidSession associated with the hold enabler
assignment service to apply enablers to holds. |
HoldEnablerRuleApplicationSession |
getHoldEnablerRuleApplicationSessionForOubliette(Id oublietteId,
Proxy proxy)
Gets the
OsidSession associated with the hold enabler
assignment service for the given hold to apply enablers to holds. |
HoldEnablerRuleLookupSession |
getHoldEnablerRuleLookupSession(Proxy proxy)
Gets the
OsidSession associated with the hold enabler
mapping lookup service for looking up the rules applied to the hold. |
HoldEnablerRuleLookupSession |
getHoldEnablerRuleLookupSessionForOubliette(Id oublietteId,
Proxy proxy)
Gets the
OsidSession associated with the hold enabler
mapping lookup service for the given hold for looking up rules applied
to a hold. |
HoldEnablerSearchSession |
getHoldEnablerSearchSession(Proxy proxy)
Gets the
OsidSession associated with the hold enabler
search service. |
HoldEnablerSearchSession |
getHoldEnablerSearchSessionForOubliette(Id oublietteId,
Proxy proxy)
Gets the
OsidSession associated with the hold enablers
earch service for the given oubliette. |
HoldEnablerSmartOublietteSession |
getHoldEnablerSmartOublietteSession(Id oublietteId,
Proxy proxy)
Gets the
OsidSession to manage hold enabler smart
oubliettes. |
changeBranch, initialize, rollbackService
close
getHoldEnablerRecordTypes, getHoldEnablerSearchRecordTypes, supportsHoldEnablerAdmin, supportsHoldEnablerLookup, supportsHoldEnablerNotification, supportsHoldEnablerOubliette, supportsHoldEnablerOublietteAssignment, supportsHoldEnablerQuery, supportsHoldEnablerRecordType, supportsHoldEnablerRuleApplication, supportsHoldEnablerRuleLookup, supportsHoldEnablerSearch, supportsHoldEnablerSearchRecordType, supportsHoldEnablerSmartHold, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
HoldEnablerLookupSession getHoldEnablerLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hold enabler
lookup service.proxy
- a proxy HoldEnablerLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerLookup()
is false
optional
- This method must be implemented if
supportsHoldEnablerLookup()
is true.
HoldEnablerLookupSession getHoldEnablerLookupSessionForOubliette(Id oublietteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold enabler
lookup service for the given oubliette.oublietteId
- the Id
of the Oubliette
proxy
- a proxy HoldEnablerLookupSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHoldEnablerLookup()
and
supportsVisibleFederation()
are true.
HoldEnablerQuerySession getHoldEnablerQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hold enabler
query service.proxy
- a proxy HoldEnablerQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerQuery()
is false
optional
- This method must be implemented if
supportsHoldEnablerQuery()
is true.
HoldEnablerQuerySession getHoldEnablerQuerySessionForOubliette(Id oublietteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold enabler
query service for the given oubliette.oublietteId
- the Id
of the Oubliette
proxy
- a proxy HoldEnablerQuerySession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHoldEnablerQuery()
and
supportsVisibleFederation()
are true.
HoldEnablerSearchSession getHoldEnablerSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hold enabler
search service.proxy
- a proxy HoldEnablerSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerSearch()
is false
optional
- This method must be implemented if
supportsHoldEnablerSearch()
is true.
HoldEnablerSearchSession getHoldEnablerSearchSessionForOubliette(Id oublietteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold enablers
earch service for the given oubliette.oublietteId
- the Id
of the Oubliette
proxy
- a proxy HoldEnablerSearchSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHoldEnablerSearch()
and
supportsVisibleFederation()
are true.
HoldEnablerAdminSession getHoldEnablerAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hold enabler
administration service.proxy
- a proxy HoldEnablerAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerAdmin()
is false
optional
- This method must be implemented if
supportsHoldEnablerAdmin()
is true.
HoldEnablerAdminSession getHoldEnablerAdminSessionForOubliette(Id oublietteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold enabler
administration service for the given oubliette.oublietteId
- the Id
of the Oubliette
proxy
- a proxy HoldEnablerAdminSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId or proxy is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHoldEnablerAdmin()
and
supportsVisibleFederation()
are true.
HoldEnablerNotificationSession getHoldEnablerNotificationSession(HoldEnablerReceiver holdEnablerReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the hold enabler
notification service.holdEnablerReceiver
- the notification callbackproxy
- a proxy HoldEnablerNotificationSession
NullArgumentException
- holdEnablerReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerNotification()
is false
optional
- This method must be implemented if
supportsHoldEnablerNotification()
is true.
HoldEnablerNotificationSession getHoldEnablerNotificationSessionForOubliette(HoldEnablerReceiver holdEnablerReceiver, Id oublietteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold enabler
notification service for the given oubliette.holdEnablerReceiver
- the notification callbackoublietteId
- the Id
of the Oubliette
proxy
- a proxy HoldEnablerNotificationSession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- holdEnablerReceiver,
oublietteId,
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHoldEnablerNotification()
and
supportsVisibleFederation()
are true.
HoldEnablerOublietteSession getHoldEnablerOublietteSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup hold enabler/oubliette
mappings for hold enablers.proxy
- a proxy HoldEnablerSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerOubliette()
is false
optional
- This method must be implemented if
supportsHoldEnablerOubliette()
is true.
HoldEnablerOublietteAssignmentSession getHoldEnablerOublietteAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning hold
enablers to oubliettesproxy
- a proxy HoldEnablerOublietteAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerOublietteAssignment()
is
false
optional
- This method must be implemented if
supportsHoldEnablerOublietteAssignment()
is
true.
HoldEnablerSmartOublietteSession getHoldEnablerSmartOublietteSession(Id oublietteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage hold enabler smart
oubliettes.oublietteId
- the Id
of the Oubliette
proxy
- a proxy HoldEnablerSmartOublietteSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerSmartOubliette()
is false
optional
- This method must be implemented if
supportsHoldEnablerSmarOubliette()
is true.
HoldEnablerRuleLookupSession getHoldEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hold enabler
mapping lookup service for looking up the rules applied to the hold.proxy
- a proxy HoldEnablerRuleLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerRuleLookup()
is false
optional
- This method must be implemented if
supportsHoldEnablerRuleLookup()
is true.
HoldEnablerRuleLookupSession getHoldEnablerRuleLookupSessionForOubliette(Id oublietteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold enabler
mapping lookup service for the given hold for looking up rules applied
to a hold.oublietteId
- the Id
of the Oubliette
proxy
- a proxy HoldEnablerRuleLookupSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHoldEnablerRuleLookup()
and
supportsVisibleFederation()
are true.
HoldEnablerRuleApplicationSession getHoldEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hold enabler
assignment service to apply enablers to holds.proxy
- a proxy HoldEnablerRuleApplicationSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerRuleApplication()
is false
optional
- This method must be implemented if
supportsHoldEnablerRuleApplication()
is
true.
HoldEnablerRuleApplicationSession getHoldEnablerRuleApplicationSessionForOubliette(Id oublietteId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold enabler
assignment service for the given hold to apply enablers to holds.oublietteId
- the Id
of the Oubliette
proxy
- a proxy HoldEnablerRuleApplicationSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHoldEnablerRuleApplication()
and
supportsVisibleFederation()
are true.