GetStateGraph

Method

GetStateGraph(ConfigStateGraphParameters parameters)

This method retrieves an object that represents the state of the Configurator. It consists of Property values, Categories, selections, Options, rule states, etc. based on the specified values in the parameter.

Parameters

The GetStateGraph method required a parameters parameter of type ConfigStateGraphParameters.

ConfigStateGraphParameters

ConfigStateGraphParameters contains the contextual information that governs the details returned in the state graph.

Constructors

ConfigStateGraphParameters()

ConfigStateGraphParameters(StateGraphSpec spec)

Properties

Data Type	Property	Description
string	Id	Returns or sets the optional designation for the top-level configuration to retrieve. If omitted, the root configuration will be the origin for the graph.
StateGraphSpec	Spec	Returns or sets the specification for what information should be returned in the state graph object. Valid values include: None IncludeSysProps IncludeInboundProps IncludeRules IncludeCategories IncludeCategories_PropDefns IncludeCategories_Options IncludeCategories_Selections IncludeChildConfigs IncludeConfig IncludeFullConfig Default All
string	SpecText	Returns or sets the specification for what information should be returned in the state graph via a concatenated string. This should only be used on platforms that do not support Flags Enum web service properties, such as a Java client.
StateGraphSpec	UsedSpec	Valid values include: None IncludeSysProps IncludeInboundProps IncludeRules IncludeCategories IncludeCategories_PropDefns IncludeCategories_Options IncludeCategories_Selections IncludeChildConfigs IncludeConfig IncludeFullConfig Default All
StateGraphPagingInfo	DefaultPagingInfo	Sets or returns the default paging information to be used when returning the state graph object.
bool	UseExistingSession	If true, returns a state graph based on the current configuration session.
StateGraphType	GraphType	Sets or returns the type of state graph to return. Each of the types is structurally similar, though the minimal version only has the 'core' values populated and lacks much of the superfluous data. Valid values include: Minimal Standard

Inheritance

ParametersBase

The ParametersBase class is the base class for the parameters types that are passed in to various methods on the service. All parameters-derived types have the parameters listed below.

Properties

Data Type	Property	Description
bool	OmitConfigurationXmlFromResult	Returns or sets whether or not the configuration xml should be omitted from the result object. In general, the various methods that interact with the service will cause the configuration XML to be returned to the caller each time. It can be bandwidth and processing intensive to recreate the XML for each call. By setting this property to True, those steps will be skipped resulting in less data being transmitted and less server-side processing.
OperationsBehaviors	OperationBehaviors	This property is used to provide additional contextual behaviors to the service call. Provide an instance of the OperationBehaviors class with properties set to identify whether the configuration should be saved (via the Stateless services) or whether a StateGraph should be returned with the result of the web service call.
DiagnosticOutput	DiagnosticOutput	Specifies the type of diagnostic information that should be returned as a result of the service call. Available values include: None RulesExecuted RulesMessages RulesChanges This provides access to the rules that were executed along with their associated messages and changes. If set to a value other than None, the DiagnosticData property of the various Result objects will be populated.
bool	ValidateRequiredProperties	Returns or sets a value indicating whether the configuration should be validated for required Property values. The default value is true.

Returns

ConfigurationStateGraphBase

An instance of ConfigurationStateGraphBase is returned by the GetStateGraph method. The object represents the root of the configuration state graph. It contains the following properties.

Properties

Data Type	Property	Description
String	Id	Returns the unique identifier for the Configurator engine for the current session.
String	ParentId	Returns the unique identifier for the parent Configurator engine for the current session.
String	GraphType	Returns Minimal or Standard - Indicating the level of detail in the State Graph.
StateGraphSys	Sys	Returns system properties and their values as they pertain to the configuration.
StateGraphContextProperty[]	ContextProperties	Returns context properties (a.k.a. Inbound Properties) that were retrieved from the host integration system and the integrator.
StateGraphRuleBase[]	Rules	Returns the set of rules that apply to the configuration.
StateGraphCategoryBase[]	Categories	Returns the set of Categories, their respective Options, selections, Properties, etc. that apply to the configuration.
StateGraphHierarchy	ConfigHierarchy	Returns the hierarchy of configurations that pertain to the configuration. This object represents the entire configuration graph starting with the top configuration requested, and like Sys and ContextProperties only exists on the root object in the state graph.This information will be returned, if applicable, regardless of whether the StateGraphSpec.IncludeChildConfigs flag is present.