While ExecuteDeferredRules is still valid, ExecuteDeferredRules2 is the preferred method and should be used instead, whenever possible.
Method
ExecuteDeferredRules(ConfigDeferredRuleType ruleType)
This method executes any deferred rules against the configuration and returns the updated configuration.
Parameters
The ExecuteDeferredRules() method requires a ruleType parameter of type ConfigDeferredRuleType.
ConfigDeferredRuleType
ConfigDeferredRuleType
The ConfigDeferredRuleType class is a public enumeration used to specify deferred rule behavior. Valid values are listed below.
|
Value |
Description |
|---|---|
|
None |
Does not execute deferred rules. |
|
OnSave |
Executes deferred rules when the Configuration is saved. |
Returns
ExecuteDeferredRulesConfigurationResult
An instance of ExecuteDeferredRulesConfigurationResult is returned by the ExecuteDeferredRules and ExecuteDeferredRules2 methods. It does not contain any unique properties.
Inheritance
ConfigurationResult
The returned ConfigurationResult object contains general information about the configuration. It is a base class inherited many of the "result" objects, such as SaveConfigurationResult or CreateConfigurationResult.
Properties
|
Data Type |
Property |
Description |
|---|---|---|
|
Header |
Returns or sets the Config Header (ID + entity type). |
|
|
ResultCode
Possible Values:
|
Returns or sets whether the operation was successful and without errors. |
|
|
ResultMessages |
Returns or sets resulting messages from the configuration action. |
|
|
FailureCode
Possible Values:
|
In the event the ResultCode is Failure, returns a code identifying the type of failure |
|
|
int |
LineItemId |
Returns or sets the line item id of the configuration. This is valid when the ConfigResult instance is a result of the IWebConfig.SaveConfiguration() or the IWebConfig.FixConfiguration() methods, otherwise the value is -1. |
|
Configuration |
Returns or sets a Configuration object containing various properties relating to the current configuration. This will only ever be assigned if the Configuration is relevant to the operation that was executed. |
|
|
StateGraph |
Returns or sets a StateGraph object containing various properties relating to the current configuration. This will only ever be assigned if the ConfigParameters.OperationBehaviors.StateGraphParameters property is provided on the request. |
|
|
DiagnosticData |
Returns the DiagnosticData associated with the operation. This will only ever be assigned if theConfigParameters.DiagnosticOutput property is provided on the request. |
|
|
SessionContext |
Returns a SessionContext object containing server-side properties that pertain to the current configuration session. |