org.osid.hold.rules

Interface HoldRulesManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, HoldRulesProfile, OsidManager, OsidProfile, Sourceable

public interface HoldRulesManager
extends OsidManager, HoldRulesProfile

The hold rules manager provides access to hold rules sessions and provides interoperability tests for various aspects of this service. 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

Method Summary

Methods

Modifier and Type	Method and Description
HoldEnablerAdminSession	getHoldEnablerAdminSession() Gets the OsidSession associated with the hold enabler administration service.
HoldEnablerAdminSession	getHoldEnablerAdminSessionForOubliette(Id oublietteId) Gets the OsidSession associated with the hold enabler administration service for the given oubliette.
HoldEnablerLookupSession	getHoldEnablerLookupSession() Gets the OsidSession associated with the hold enabler lookup service.
HoldEnablerLookupSession	getHoldEnablerLookupSessionForOubliette(Id oublietteId) Gets the OsidSession associated with the hold enabler lookup service for the given oubliette.
HoldEnablerNotificationSession	getHoldEnablerNotificationSession(HoldEnablerReceiver holdEnablerReceiver) Gets the OsidSession associated with the hold enabler notification service.
HoldEnablerNotificationSession	getHoldEnablerNotificationSessionForOubliette(HoldEnablerReceiver holdEnablerReceiver, Id oublietteId) Gets the OsidSession associated with the hold enabler notification service for the given oubliette.
HoldEnablerOublietteAssignmentSession	getHoldEnablerOublietteAssignmentSession() Gets the OsidSession associated with assigning hold enablers to oubliettes.
HoldEnablerOublietteSession	getHoldEnablerOublietteSession() Gets the OsidSession to lookup hold enableroubliette mappings.
HoldEnablerQuerySession	getHoldEnablerQuerySession() Gets the OsidSession associated with the hold enabler query service.
HoldEnablerQuerySession	getHoldEnablerQuerySessionForOubliette(Id oublietteId) Gets the OsidSession associated with the hold enabler query service for the given oubliette.
HoldEnablerRuleApplicationSession	getHoldEnablerRuleApplicationSession() Gets the OsidSession associated with the hold enabler assignment service to apply enablers to holds.
HoldEnablerRuleApplicationSession	getHoldEnablerRuleApplicationSessionForOubliette(Id oublietteId) Gets the OsidSession associated with the hold enabler assignment service for the given hold to apply enablers to holds.
HoldEnablerRuleLookupSession	getHoldEnablerRuleLookupSession() Gets the OsidSession associated with the hold enabler mapping lookup service for looking up the rules applied to the hold.
HoldEnablerRuleLookupSession	getHoldEnablerRuleLookupSessionForOubliette(Id oublietteId) 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() Gets the OsidSession associated with the hold enabler search service.
HoldEnablerSearchSession	getHoldEnablerSearchSessionForOubliette(Id oublietteId) Gets the OsidSession associated with the hold enablers earch service for the given oubliette.
HoldEnablerSmartOublietteSession	getHoldEnablerSmartOublietteSession(Id oublietteId) Gets the OsidSession to manage hold enabler smart oubliettes.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.hold.rules.HoldRulesProfile

getHoldEnablerRecordTypes, getHoldEnablerSearchRecordTypes, supportsHoldEnablerAdmin, supportsHoldEnablerLookup, supportsHoldEnablerNotification, supportsHoldEnablerOubliette, supportsHoldEnablerOublietteAssignment, supportsHoldEnablerQuery, supportsHoldEnablerRecordType, supportsHoldEnablerRuleApplication, supportsHoldEnablerRuleLookup, supportsHoldEnablerSearch, supportsHoldEnablerSearchRecordType, supportsHoldEnablerSmartHold, 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

getHoldEnablerLookupSession

HoldEnablerLookupSession getHoldEnablerLookupSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the hold enabler lookup service.

Returns:

a HoldEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerLookup() is false

Compliance:

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

getHoldEnablerLookupSessionForOubliette

HoldEnablerLookupSession getHoldEnablerLookupSessionForOubliette(Id oublietteId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the hold enabler lookup service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

a HoldEnablerLookupSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerLookup() or supportsVisibleFederation() is false

Compliance:

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

getHoldEnablerQuerySession

HoldEnablerQuerySession getHoldEnablerQuerySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the hold enabler query service.

Returns:

a HoldEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerQuery() is false

Compliance:

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

getHoldEnablerQuerySessionForOubliette

HoldEnablerQuerySession getHoldEnablerQuerySessionForOubliette(Id oublietteId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the hold enabler query service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

a HoldEnablerQuerySession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerQuery() or supportsVisibleFederation() is false

Compliance:

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

getHoldEnablerSearchSession

HoldEnablerSearchSession getHoldEnablerSearchSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the hold enabler search service.

Returns:

a HoldEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerSearch() is false

Compliance:

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

getHoldEnablerSearchSessionForOubliette

HoldEnablerSearchSession getHoldEnablerSearchSessionForOubliette(Id oublietteId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the hold enablers earch service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

a HoldEnablerSearchSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerSearch() or supportsVisibleFederation() is false

Compliance:

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

getHoldEnablerAdminSession

HoldEnablerAdminSession getHoldEnablerAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the hold enabler administration service.

Returns:

a HoldEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerAdmin() is false

Compliance:

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

getHoldEnablerAdminSessionForOubliette

HoldEnablerAdminSession getHoldEnablerAdminSessionForOubliette(Id oublietteId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the hold enabler administration service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

a HoldEnablerAdminSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getHoldEnablerNotificationSession

HoldEnablerNotificationSession getHoldEnablerNotificationSession(HoldEnablerReceiver holdEnablerReceiver)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the hold enabler notification service.

Parameters:

holdEnablerReceiver - the notification callback

Returns:

a HoldEnablerNotificationSession

Throws:

NullArgumentException - holdEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerNotification() is false

Compliance:

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

getHoldEnablerNotificationSessionForOubliette

HoldEnablerNotificationSession getHoldEnablerNotificationSessionForOubliette(HoldEnablerReceiver holdEnablerReceiver,
                                                                           Id oublietteId)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

Gets the OsidSession associated with the hold enabler notification service for the given oubliette.

Parameters:

holdEnablerReceiver - the notification callback

oublietteId - the Id of the Oubliette

Returns:

a HoldEnablerNotificationSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - holdEnablerReceiver or oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerNotification() or supportsVisibleFederation() is false

Compliance:

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

getHoldEnablerOublietteSession

HoldEnablerOublietteSession getHoldEnablerOublietteSession()
                                                           throws OperationFailedException

Gets the OsidSession to lookup hold enableroubliette mappings.

Returns:

a HoldEnablerOublietteSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerOubliette() is false

Compliance:

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

getHoldEnablerOublietteAssignmentSession

HoldEnablerOublietteAssignmentSession getHoldEnablerOublietteAssignmentSession()
                                                                               throws OperationFailedException

Gets the OsidSession associated with assigning hold enablers to oubliettes.

Returns:

a HoldEnablerOublietteAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerOublietteAssignment() is false

Compliance:

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

getHoldEnablerSmartOublietteSession

HoldEnablerSmartOublietteSession getHoldEnablerSmartOublietteSession(Id oublietteId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the OsidSession to manage hold enabler smart oubliettes.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

a HoldEnablerSmartOublietteSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerSmartOubliette() is false

Compliance:

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

getHoldEnablerRuleLookupSession

HoldEnablerRuleLookupSession getHoldEnablerRuleLookupSession()
                                                             throws OperationFailedException

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

Returns:

a HoldEnablerRuleSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerRuleLookup() is false

Compliance:

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

getHoldEnablerRuleLookupSessionForOubliette

HoldEnablerRuleLookupSession getHoldEnablerRuleLookupSessionForOubliette(Id oublietteId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

oublietteId - the Id of the Oubliette

Returns:

a HoldEnablerRuleLookupSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getHoldEnablerRuleApplicationSession

HoldEnablerRuleApplicationSession getHoldEnablerRuleApplicationSession()
                                                                       throws OperationFailedException

Gets the OsidSession associated with the hold enabler assignment service to apply enablers to holds.

Returns:

a HoldEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerRuleApplication() is false

Compliance:

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

getHoldEnablerRuleApplicationSessionForOubliette

HoldEnablerRuleApplicationSession getHoldEnablerRuleApplicationSessionForOubliette(Id oublietteId)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

Gets the OsidSession associated with the hold enabler assignment service for the given hold to apply enablers to holds.

Parameters:

oublietteId - the Id of the Oubliette

Returns:

a HoldEnablerRuleApplicationSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

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