org.osid.configuration.rules

Interface ConfigurationRulesManager

All Superinterfaces:

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

public interface ConfigurationRulesManager
extends OsidManager, ConfigurationRulesProfile

The configuration rules manager provides access to configuration rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• ValueEnablerLookupSession: a session to retrieve value enablers
• ValueEnablerQuerySession: a session to query for value enablers
• ValueEnablerSearchSession: a session to search for value enablers
• ValueEnablerAdminSession: a session to create and delete value enablers
• ValueEnablerNotificationSession: a session to receive notifications pertaining to value enabler changes
• ValueEnablerConfigurationSession: a session to look up value enabler configuration mappings
• ValueEnablerConfigurationAssignmentSession: a session to manage value enabler to configuration mappings
• ValueEnablerSmartConfigurationSession: a session to manage dynamic configurations of value enablers
• ValuerEnablerRuleLookupSession: a session to look up value enabler mappings
• ValueEnablerRuleApplicationSession: a session to apply value enablers

• ParameterProcessorLookupSession: a session to retrieve parameter processor
• ParameterProcessorQuerySession: a session to query for parameter processor
• ParameterProcessorSearchSession: a session to search for parameter processor
• ParameterProcessorAdminSession: a session to create and delete parameter processor
• ParameterProcessorNotificationSession: a session to receive notifications pertaining to parameter processor changes
• ParameterProcessorConfigurationSession: a session to look up parameter processor configuration mappings
• ParameterProcessorConfigurationAssignmentSession: a session to manage parameter processor to configuration mappings
• ParameterProcessorSmartConfigurationSession: a session to manage dynamic configurations of parameter processor
• ParameterProcessorRuleLookupSession: a session to look up parameter processor to parameter mappings
• ParameterProcessorRuleApplicationSession: a session to apply parameter processor to parameters

• ParameterProcessorEnablerLookupSession: a session to retrieve parameter processor enablers
• ParameterProcessorEnablerQuerySession: a session to query for parameter processor enablers
• ParameterProcessorEnablerSearchSession: a session to search for parameter processor enablers
• ParameterProcessorEnablerAdminSession: a session to create and delete parameter processor enablers
• ParameterProcessorEnablerNotificationSession: a session to receive notifications pertaining to parameter processor enabler changes
• ParameterProcessorEnablerConfigurationSession: a session to look up parameter processor enabler configuration mappings
• ParameterProcessorEnablerConfigurationAssignmentSession: a session to manage parameter processor enabler to configuration mappings
• ParameterProcessorEnablerSmartConfigurationSession: a session to manage dynamic configurations of parameter processor enablers
• ParameterProcessorEnablerRuleLookupSession: a session to look up parameter processor enabler mappings
• ParameterProcessorEnablerRuleApplicationSession: a session to apply parameter processor enablers

Method Summary

Methods

Modifier and Type	Method and Description
ParameterProcessorAdminSession	getParameterProcessorAdminSession() Gets the OsidSession associated with the parameter processor administration service.
ParameterProcessorAdminSession	getParameterProcessorAdminSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor administration service for the given configuration.
ParameterProcessorConfigurationAssignmentSession	getParameterProcessorConfigurationAssignmentSession() Gets the OsidSession associated with assigning parameter processor to configurations.
ParameterProcessorConfigurationSession	getParameterProcessorConfigurationSession() Gets the OsidSession to lookup parameter processor/configuration mappings for parameter processors.
ParameterProcessorEnablerAdminSession	getParameterProcessorEnablerAdminSession() Gets the OsidSession associated with the parameter processor enabler administration service.
ParameterProcessorEnablerAdminSession	getParameterProcessorEnablerAdminSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor enabler administration service for the given configuration.
ParameterProcessorEnablerConfigurationAssignmentSession	getParameterProcessorEnablerConfigurationAssignmentSession() Gets the OsidSession associated with assigning parameter processor enablers to configurations.
ParameterProcessorEnablerConfigurationSession	getParameterProcessorEnablerConfigurationSession() Gets the OsidSession to lookup parameter processor enabler/configuration mappings for parameter processor enablers.
ParameterProcessorEnablerLookupSession	getParameterProcessorEnablerLookupSession() Gets the OsidSession associated with the parameter processor enabler lookup service.
ParameterProcessorEnablerLookupSession	getParameterProcessorEnablerLookupSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor enabler lookup service for the given configuration.
ParameterProcessorEnablerNotificationSession	getParameterProcessorEnablerNotificationSession(ParameterProcessorEnablerReceiver parameterProcessorEnablerReceiver) Gets the OsidSession associated with the parameter processor enabler notification service.
ParameterProcessorEnablerNotificationSession	getParameterProcessorEnablerNotificationSessionForConfiguration(ParameterProcessorEnablerReceiver parameterProcessorEnablerReceiver, Id configurationId) Gets the OsidSession associated with the parameter processor enabler notification service for the given configuration.
ParameterProcessorEnablerQuerySession	getParameterProcessorEnablerQuerySession() Gets the OsidSession associated with the parameter processor enabler query service.
ParameterProcessorEnablerQuerySession	getParameterProcessorEnablerQuerySessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor enabler query service for the given configuration.
ParameterProcessorEnablerRuleApplicationSession	getParameterProcessorEnablerRuleApplicationSession() Gets the OsidSession associated with the parameter processor enabler assignment service.
ParameterProcessorEnablerRuleApplicationSession	getParameterProcessorEnablerRuleApplicationSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor enabler assignment service for the given configuration.
ParameterProcessorEnablerRuleLookupSession	getParameterProcessorEnablerRuleLookupSession() Gets the OsidSession associated with the parameter processor enabler mapping lookup service.
ParameterProcessorEnablerRuleLookupSession	getParameterProcessorEnablerRuleLookupSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor enabler mapping lookup service.
ParameterProcessorEnablerSearchSession	getParameterProcessorEnablerSearchSession() Gets the OsidSession associated with the parameter processor enabler search service.
ParameterProcessorEnablerSearchSession	getParameterProcessorEnablerSearchSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor enablers earch service for the given configuration.
ParameterProcessorEnablerSmartConfigurationSession	getParameterProcessorEnablerSmartConfigurationSession(Id configurationId) Gets the OsidSession to manage parameter processor enabler smart configurations.
ParameterProcessorLookupSession	getParameterProcessorLookupSession() Gets the OsidSession associated with the parameter processor lookup service.
ParameterProcessorLookupSession	getParameterProcessorLookupSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor lookup service for the given configuration.
ParameterProcessorNotificationSession	getParameterProcessorNotificationSession(ParameterProcessorReceiver parameterProcessorReceiver) Gets the OsidSession associated with the parameter processor notification service.
ParameterProcessorNotificationSession	getParameterProcessorNotificationSessionForConfiguration(ParameterProcessorReceiver parameterProcessorReceiver, Id configurationId) Gets the OsidSession associated with the parameter processor notification service for the given configuration.
ParameterProcessorQuerySession	getParameterProcessorQuerySession() Gets the OsidSession associated with the parameter processor query service.
ParameterProcessorQuerySession	getParameterProcessorQuerySessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor query service for the given configuration.
ParameterProcessorRuleApplicationSession	getParameterProcessorRuleApplicationSession() Gets the OsidSession associated with the parameter processor assignment service.
ParameterProcessorRuleApplicationSession	getParameterProcessorRuleApplicationSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor assignment service for the given configuration.
ParameterProcessorRuleLookupSession	getParameterProcessorRuleLookupSession() Gets the OsidSession associated with the parameter processor mapping lookup service for looking up the rules applied to the configuration.
ParameterProcessorRuleLookupSession	getParameterProcessorRuleLookupSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor mapping lookup service for the given configuration for looking up rules applied to an configuration.
ParameterProcessorSearchSession	getParameterProcessorSearchSession() Gets the OsidSession associated with the parameter processor search service.
ParameterProcessorSearchSession	getParameterProcessorSearchSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the parameter processor earch service for the given configuration.
ParameterProcessorSmartConfigurationSession	getParameterProcessorSmartConfigurationSession(Id configurationId) Gets the OsidSession to manage parameter processor smart configurations.
ValueEnablerAdminSession	getValueEnablerAdminSession() Gets the OsidSession associated with the value enabler administration service.
ValueEnablerAdminSession	getValueEnablerAdminSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the value enabler administration service for the given configuration.
ValueEnablerConfigurationAssignmentSession	getValueEnablerConfigurationAssignmentSession() Gets the OsidSession associated with assigning value enablers to configurations.
ValueEnablerConfigurationSession	getValueEnablerConfigurationSession() Gets the OsidSession to lookup value enabler/configuration mappings for value enablers.
ValueEnablerLookupSession	getValueEnablerLookupSession() Gets the OsidSession associated with the value enabler lookup service.
ValueEnablerLookupSession	getValueEnablerLookupSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the value enabler lookup service for the given configuration.
ValueEnablerNotificationSession	getValueEnablerNotificationSession(ValueEnablerReceiver valueEnablerReceiver) Gets the OsidSession associated with the value enabler notification service.
ValueEnablerNotificationSession	getValueEnablerNotificationSessionForConfiguration(ValueEnablerReceiver valueEnablerReceiver, Id configurationId) Gets the OsidSession associated with the value enabler notification service for the given configuration.
ValueEnablerQuerySession	getValueEnablerQuerySession() Gets the OsidSession associated with the value enabler query service.
ValueEnablerQuerySession	getValueEnablerQuerySessionForConfiguration(Id configurationId) Gets the OsidSession associated with the value enabler query service for the given configuration.
ValueEnablerRuleApplicationSession	getValueEnablerRuleApplicationSession() Gets the OsidSession associated with the value enabler assignment service.
ValueEnablerRuleApplicationSession	getValueEnablerRuleApplicationSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the value enabler assignment service for the given configuration.
ValueEnablerRuleLookupSession	getValueEnablerRuleLookupSession() Gets the OsidSession associated with the value enabler mapping lookup service.
ValueEnablerRuleLookupSession	getValueEnablerRuleLookupSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the value enabler mapping lookup service for the given configuration.
ValueEnablerSearchSession	getValueEnablerSearchSession() Gets the OsidSession associated with the value enabler search service.
ValueEnablerSearchSession	getValueEnablerSearchSessionForConfiguration(Id configurationId) Gets the OsidSession associated with the value enablers earch service for the given configuration.
ValueEnablerSmartConfigurationSession	getValueEnablerSmartConfigurationSession(Id configurationId) Gets the OsidSession to manage value enabler smart configurations.

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.configuration.rules.ConfigurationRulesProfile

getParameterProcessorEnablerRecordTypes, getParameterProcessorEnablerSearchRecordTypes, getParameterProcessorRecordTypes, getParameterProcessorSearchRecordTypes, getValueEnablerRecordTypes, getValueEnablerSearchRecordTypes, supportsParameterProcessorAdmin, supportsParameterProcessorConfiguration, supportsParameterProcessorConfigurationAssignment, supportsParameterProcessorEnablerAdmin, supportsParameterProcessorEnablerConfiguration, supportsParameterProcessorEnablerConfigurationAssignment, supportsParameterProcessorEnablerLookup, supportsParameterProcessorEnablerNotification, supportsParameterProcessorEnablerQuery, supportsParameterProcessorEnablerRecordType, supportsParameterProcessorEnablerRuleApplication, supportsParameterProcessorEnablerRuleLookup, supportsParameterProcessorEnablerSearch, supportsParameterProcessorEnablerSearchRecordType, supportsParameterProcessorEnablerSmartConfiguration, supportsParameterProcessorLookup, supportsParameterProcessorNotification, supportsParameterProcessorQuery, supportsParameterProcessorRecordType, supportsParameterProcessorRuleApplication, supportsParameterProcessorRuleLookup, supportsParameterProcessorSearch, supportsParameterProcessorSearchRecordType, supportsParameterProcessorSmartConfiguration, supportsValueEnablerAdmin, supportsValueEnablerConfiguration, supportsValueEnablerConfigurationAssignment, supportsValueEnablerLookup, supportsValueEnablerNotification, supportsValueEnablerQuery, supportsValueEnablerRecordType, supportsValueEnablerRuleApplication, supportsValueEnablerRuleLookup, supportsValueEnablerSearch, supportsValueEnablerSearchRecordType, supportsValueEnablerSmartConfiguration, 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

getValueEnablerLookupSession

ValueEnablerLookupSession getValueEnablerLookupSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the value enabler lookup service.

Returns:

a ValueEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerLookup() is false

Compliance:

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

getValueEnablerLookupSessionForConfiguration

ValueEnablerLookupSession getValueEnablerLookupSessionForConfiguration(Id configurationId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the value enabler lookup service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ValueEnablerLookupSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerLookup() or supportsVisibleFederation() is false

Compliance:

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

getValueEnablerQuerySession

ValueEnablerQuerySession getValueEnablerQuerySession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the value enabler query service.

Returns:

a ValueEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerQuery() is false

Compliance:

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

getValueEnablerQuerySessionForConfiguration

ValueEnablerQuerySession getValueEnablerQuerySessionForConfiguration(Id configurationId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the OsidSession associated with the value enabler query service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ValueEnablerQuerySession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerQuery() or supportsVisibleFederation() is false

Compliance:

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

getValueEnablerSearchSession

ValueEnablerSearchSession getValueEnablerSearchSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the value enabler search service.

Returns:

a ValueEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerSearch() is false

Compliance:

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

getValueEnablerSearchSessionForConfiguration

ValueEnablerSearchSession getValueEnablerSearchSessionForConfiguration(Id configurationId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the value enablers earch service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ValueEnablerSearchSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerSearch() or supportsVisibleFederation() is false

Compliance:

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

getValueEnablerAdminSession

ValueEnablerAdminSession getValueEnablerAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the value enabler administration service.

Returns:

a ValueEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerAdmin() is false

Compliance:

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

getValueEnablerAdminSessionForConfiguration

ValueEnablerAdminSession getValueEnablerAdminSessionForConfiguration(Id configurationId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the OsidSession associated with the value enabler administration service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ValueEnablerAdminSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getValueEnablerNotificationSession

ValueEnablerNotificationSession getValueEnablerNotificationSession(ValueEnablerReceiver valueEnablerReceiver)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the value enabler notification service.

Parameters:

valueEnablerReceiver - the notification callback

Returns:

a ValueEnablerNotificationSession

Throws:

NullArgumentException - valueEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerNotification() is false

Compliance:

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

getValueEnablerNotificationSessionForConfiguration

ValueEnablerNotificationSession getValueEnablerNotificationSessionForConfiguration(ValueEnablerReceiver valueEnablerReceiver,
                                                                                 Id configurationId)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

Gets the OsidSession associated with the value enabler notification service for the given configuration.

Parameters:

valueEnablerReceiver - the notification callback

configurationId - the Id of the Configuration

Returns:

a ValueEnablerNotificationSession

Throws:

NotFoundException - no configuration found by the given Id

NullArgumentException - valueEnablerReceiver or configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerNotification() or supportsVisibleFederation() is false

Compliance:

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

getValueEnablerConfigurationSession

ValueEnablerConfigurationSession getValueEnablerConfigurationSession()
                                                                     throws OperationFailedException

Gets the OsidSession to lookup value enabler/configuration mappings for value enablers.

Returns:

a ValueEnablerConfigurationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerConfiguration() is false

Compliance:

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

getValueEnablerConfigurationAssignmentSession

ValueEnablerConfigurationAssignmentSession getValueEnablerConfigurationAssignmentSession()
                                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning value enablers to configurations.

Returns:

a ValueEnablerConfigurationAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerConfigurationAssignment() is false

Compliance:

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

getValueEnablerSmartConfigurationSession

ValueEnablerSmartConfigurationSession getValueEnablerSmartConfigurationSession(Id configurationId)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession to manage value enabler smart configurations.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ValueEnablerSmartConfigurationSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerSmartConfiguration() is false

Compliance:

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

getValueEnablerRuleLookupSession

ValueEnablerRuleLookupSession getValueEnablerRuleLookupSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the value enabler mapping lookup service.

Returns:

a ValueEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerRuleLookup() is false

Compliance:

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

getValueEnablerRuleLookupSessionForConfiguration

ValueEnablerRuleLookupSession getValueEnablerRuleLookupSessionForConfiguration(Id configurationId)
                                                                               throws NotFoundException,
                                                                                      OperationFailedException

Gets the OsidSession associated with the value enabler mapping lookup service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ValueEnablerRuleLookupSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getValueEnablerRuleApplicationSession

ValueEnablerRuleApplicationSession getValueEnablerRuleApplicationSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with the value enabler assignment service.

Returns:

a ValueEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerRuleApplication() is false

Compliance:

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

getValueEnablerRuleApplicationSessionForConfiguration

ValueEnablerRuleApplicationSession getValueEnablerRuleApplicationSessionForConfiguration(Id configurationId)
                                                                                         throws NotFoundException,
                                                                                                OperationFailedException

Gets the OsidSession associated with the value enabler assignment service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ValueEnablerRuleApplicationSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsValueEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorLookupSession

ParameterProcessorLookupSession getParameterProcessorLookupSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the parameter processor lookup service.

Returns:

a ParameterProcessorLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorLookup() is false

Compliance:

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

getParameterProcessorLookupSessionForConfiguration

ParameterProcessorLookupSession getParameterProcessorLookupSessionForConfiguration(Id configurationId)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

Gets the OsidSession associated with the parameter processor lookup service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorLookupSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorLookup() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorQuerySession

ParameterProcessorQuerySession getParameterProcessorQuerySession()
                                                                 throws OperationFailedException

Gets the OsidSession associated with the parameter processor query service.

Returns:

a ParameterProcessorQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorQuery() is false

Compliance:

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

getParameterProcessorQuerySessionForConfiguration

ParameterProcessorQuerySession getParameterProcessorQuerySessionForConfiguration(Id configurationId)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession associated with the parameter processor query service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorQuerySession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorQuery() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorSearchSession

ParameterProcessorSearchSession getParameterProcessorSearchSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the parameter processor search service.

Returns:

a ParameterProcessorSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorSearch() is false

Compliance:

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

getParameterProcessorSearchSessionForConfiguration

ParameterProcessorSearchSession getParameterProcessorSearchSessionForConfiguration(Id configurationId)
                                                                                   throws NotFoundException,
                                                                                          OperationFailedException

Gets the OsidSession associated with the parameter processor earch service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorSearchSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorSearch() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorAdminSession

ParameterProcessorAdminSession getParameterProcessorAdminSession()
                                                                 throws OperationFailedException

Gets the OsidSession associated with the parameter processor administration service.

Returns:

a ParameterProcessorAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorAdmin() is false

Compliance:

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

getParameterProcessorAdminSessionForConfiguration

ParameterProcessorAdminSession getParameterProcessorAdminSessionForConfiguration(Id configurationId)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

Gets the OsidSession associated with the parameter processor administration service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorAdminSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorAdmin() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorNotificationSession

ParameterProcessorNotificationSession getParameterProcessorNotificationSession(ParameterProcessorReceiver parameterProcessorReceiver)
                                                                               throws OperationFailedException

Gets the OsidSession associated with the parameter processor notification service.

Parameters:

parameterProcessorReceiver - the notification callback

Returns:

a ParameterProcessorNotificationSession

Throws:

NullArgumentException - parameterProcessorReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorNotification() is false

Compliance:

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

getParameterProcessorNotificationSessionForConfiguration

ParameterProcessorNotificationSession getParameterProcessorNotificationSessionForConfiguration(ParameterProcessorReceiver parameterProcessorReceiver,
                                                                                             Id configurationId)
                                                                                               throws NotFoundException,
                                                                                                      OperationFailedException

Gets the OsidSession associated with the parameter processor notification service for the given configuration.

Parameters:

parameterProcessorReceiver - the notification callback

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorNotificationSession

Throws:

NotFoundException - no configuration found by the given Id

NullArgumentException - parameterProcessorReceiver or configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorNotification() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorConfigurationSession

ParameterProcessorConfigurationSession getParameterProcessorConfigurationSession()
                                                                                 throws OperationFailedException

Gets the OsidSession to lookup parameter processor/configuration mappings for parameter processors.

Returns:

a ParameterProcessorConfigurationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorConfiguration() is false

Compliance:

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

getParameterProcessorConfigurationAssignmentSession

ParameterProcessorConfigurationAssignmentSession getParameterProcessorConfigurationAssignmentSession()
                                                                                                     throws OperationFailedException

Gets the OsidSession associated with assigning parameter processor to configurations.

Returns:

a ParameterProcessorConfigurationAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorConfigurationAssignment() is false

Compliance:

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

getParameterProcessorSmartConfigurationSession

ParameterProcessorSmartConfigurationSession getParameterProcessorSmartConfigurationSession(Id configurationId)
                                                                                           throws NotFoundException,
                                                                                                  OperationFailedException

Gets the OsidSession to manage parameter processor smart configurations.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorSmartConfigurationSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorSmartConfiguration() is false

Compliance:

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

getParameterProcessorRuleLookupSession

ParameterProcessorRuleLookupSession getParameterProcessorRuleLookupSession()
                                                                           throws OperationFailedException

Gets the OsidSession associated with the parameter processor mapping lookup service for looking up the rules applied to the configuration.

Returns:

a ParameterProcessorRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorRuleLookup() is false

Compliance:

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

getParameterProcessorRuleLookupSessionForConfiguration

ParameterProcessorRuleLookupSession getParameterProcessorRuleLookupSessionForConfiguration(Id configurationId)
                                                                                           throws NotFoundException,
                                                                                                  OperationFailedException

Gets the OsidSession associated with the parameter processor mapping lookup service for the given configuration for looking up rules applied to an configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorRuleLookupSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorRuleApplicationSession

ParameterProcessorRuleApplicationSession getParameterProcessorRuleApplicationSession()
                                                                                     throws OperationFailedException

Gets the OsidSession associated with the parameter processor assignment service.

Returns:

a ParameterProcessorRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorRuleApplication() is false

Compliance:

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

getParameterProcessorRuleApplicationSessionForConfiguration

ParameterProcessorRuleApplicationSession getParameterProcessorRuleApplicationSessionForConfiguration(Id configurationId)
                                                                                                     throws NotFoundException,
                                                                                                            OperationFailedException

Gets the OsidSession associated with the parameter processor assignment service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorRuleApplicationSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorRuleApplication() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorEnablerLookupSession

ParameterProcessorEnablerLookupSession getParameterProcessorEnablerLookupSession()
                                                                                 throws OperationFailedException

Gets the OsidSession associated with the parameter processor enabler lookup service.

Returns:

a ParameterProcessorEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerLookup() is false

Compliance:

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

getParameterProcessorEnablerLookupSessionForConfiguration

ParameterProcessorEnablerLookupSession getParameterProcessorEnablerLookupSessionForConfiguration(Id configurationId)
                                                                                                 throws NotFoundException,
                                                                                                        OperationFailedException

Gets the OsidSession associated with the parameter processor enabler lookup service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorEnablerLookupSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerLookup() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorEnablerQuerySession

ParameterProcessorEnablerQuerySession getParameterProcessorEnablerQuerySession()
                                                                               throws OperationFailedException

Gets the OsidSession associated with the parameter processor enabler query service.

Returns:

a ParameterProcessorEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerQuery() is false

Compliance:

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

getParameterProcessorEnablerQuerySessionForConfiguration

ParameterProcessorEnablerQuerySession getParameterProcessorEnablerQuerySessionForConfiguration(Id configurationId)
                                                                                               throws NotFoundException,
                                                                                                      OperationFailedException

Gets the OsidSession associated with the parameter processor enabler query service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorEnablerQuerySession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerQuery() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorEnablerSearchSession

ParameterProcessorEnablerSearchSession getParameterProcessorEnablerSearchSession()
                                                                                 throws OperationFailedException

Gets the OsidSession associated with the parameter processor enabler search service.

Returns:

a ParameterProcessorEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerSearch() is false

Compliance:

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

getParameterProcessorEnablerSearchSessionForConfiguration

ParameterProcessorEnablerSearchSession getParameterProcessorEnablerSearchSessionForConfiguration(Id configurationId)
                                                                                                 throws NotFoundException,
                                                                                                        OperationFailedException

Gets the OsidSession associated with the parameter processor enablers earch service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorEnablerSearchSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerSearch() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorEnablerAdminSession

ParameterProcessorEnablerAdminSession getParameterProcessorEnablerAdminSession()
                                                                               throws OperationFailedException

Gets the OsidSession associated with the parameter processor enabler administration service.

Returns:

a ParameterProcessorEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerAdmin() is false

Compliance:

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

getParameterProcessorEnablerAdminSessionForConfiguration

ParameterProcessorEnablerAdminSession getParameterProcessorEnablerAdminSessionForConfiguration(Id configurationId)
                                                                                               throws NotFoundException,
                                                                                                      OperationFailedException

Gets the OsidSession associated with the parameter processor enabler administration service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorEnablerAdminSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorEnablerNotificationSession

ParameterProcessorEnablerNotificationSession getParameterProcessorEnablerNotificationSession(ParameterProcessorEnablerReceiver parameterProcessorEnablerReceiver)
                                                                                             throws OperationFailedException

Gets the OsidSession associated with the parameter processor enabler notification service.

Parameters:

parameterProcessorEnablerReceiver - the notification callback

Returns:

a ParameterProcessorEnablerNotificationSession

Throws:

NullArgumentException - parameterProcessorEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerNotification() is false

Compliance:

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

getParameterProcessorEnablerNotificationSessionForConfiguration

ParameterProcessorEnablerNotificationSession getParameterProcessorEnablerNotificationSessionForConfiguration(ParameterProcessorEnablerReceiver parameterProcessorEnablerReceiver,
                                                                                                           Id configurationId)
                                                                                                             throws NotFoundException,
                                                                                                                    OperationFailedException

Gets the OsidSession associated with the parameter processor enabler notification service for the given configuration.

Parameters:

parameterProcessorEnablerReceiver - the notification callback

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorEnablerNotificationSession

Throws:

NotFoundException - no configuration found by the given Id

NullArgumentException - parameterProcessorEnablerReceiver or configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerNotification() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorEnablerConfigurationSession

ParameterProcessorEnablerConfigurationSession getParameterProcessorEnablerConfigurationSession()
                                                                                               throws OperationFailedException

Gets the OsidSession to lookup parameter processor enabler/configuration mappings for parameter processor enablers.

Returns:

a ParameterProcessorEnablerConfigurationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerConfiguration() is false

Compliance:

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

getParameterProcessorEnablerConfigurationAssignmentSession

ParameterProcessorEnablerConfigurationAssignmentSession getParameterProcessorEnablerConfigurationAssignmentSession()
                                                                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning parameter processor enablers to configurations.

Returns:

a ParameterProcessorEnablerConfigurationAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerConfigurationAssignment() is false

Compliance:

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

getParameterProcessorEnablerSmartConfigurationSession

ParameterProcessorEnablerSmartConfigurationSession getParameterProcessorEnablerSmartConfigurationSession(Id configurationId)
                                                                                                         throws NotFoundException,
                                                                                                                OperationFailedException

Gets the OsidSession to manage parameter processor enabler smart configurations.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorEnablerSmartConfigurationSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerSmartConfiguration() is false

Compliance:

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

getParameterProcessorEnablerRuleLookupSession

ParameterProcessorEnablerRuleLookupSession getParameterProcessorEnablerRuleLookupSession()
                                                                                         throws OperationFailedException

Gets the OsidSession associated with the parameter processor enabler mapping lookup service.

Returns:

a ParameterProcessorEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerRuleLookup() is false

Compliance:

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

getParameterProcessorEnablerRuleLookupSessionForConfiguration

ParameterProcessorEnablerRuleLookupSession getParameterProcessorEnablerRuleLookupSessionForConfiguration(Id configurationId)
                                                                                                         throws NotFoundException,
                                                                                                                OperationFailedException

Gets the OsidSession associated with the parameter processor enabler mapping lookup service.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorEnablerRuleLookupSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

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

getParameterProcessorEnablerRuleApplicationSession

ParameterProcessorEnablerRuleApplicationSession getParameterProcessorEnablerRuleApplicationSession()
                                                                                                   throws OperationFailedException

Gets the OsidSession associated with the parameter processor enabler assignment service.

Returns:

a ParameterProcessorEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerRuleApplication() is false

Compliance:

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

getParameterProcessorEnablerRuleApplicationSessionForConfiguration

ParameterProcessorEnablerRuleApplicationSession getParameterProcessorEnablerRuleApplicationSessionForConfiguration(Id configurationId)
                                                                                                                   throws NotFoundException,
                                                                                                                          OperationFailedException

Gets the OsidSession associated with the parameter processor enabler assignment service for the given configuration.

Parameters:

configurationId - the Id of the Configuration

Returns:

a ParameterProcessorEnablerRuleApplicationSession

Throws:

NotFoundException - no Configuration found by the given Id

NullArgumentException - configurationId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParameterProcessorEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

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