Skip navigation links

ilog.rules.studio.res.ruleapp
Interface IlrRulesetArchiveDescriptor

public interface IlrRulesetArchiveDescriptor

Stores the ruleset archive information in a RuleApp descriptor.

Method Summary

String	getDescription() Gets the ruleset archive description.
String	getDisplayName() Gets the ruleset archive display name.
String	getFullPath() Gets the full path of this ruleset archive.
String	getLocation() Gets the location of this ruleset archive.
String	getName() Gets the ruleset archive name.
Set	getProperties() Deprecated. As of JRules 7.0, replaced by getPropertiesAsStrings().
Set<String>	getPropertiesAsStrings() Gets the list of read only key/value in a collection format.
Set<Map.Entry<String,String>>	getPropertySet() Gets the list of read only key/value in a Java collection.
String	getPropertyValue(String key) Gets the property value for the specified key.
IlrRuleAppDescriptor	getRuleAppDescriptor() Gets the parent RuleApp descriptor by which this ruleset archive is referenced.
Collection<IlrRulesetParameter>	getRulesetParameters() Gets the ruleset parameters from the ruleset signature.
IlrRulesetParameter[]	getRulesetSignature() Deprecated. As of ODM 8.5.1, replaced by getRulesetParameters().
String	getVersion() Gets the ruleset archive version.
org.eclipse.jdt.launching.IRuntimeClasspathEntry[]	getXOMPath() Gets the XOM path associated with this ruleset archive.
boolean	isEnabled() Determines whether the ruleset archive is enabled.
boolean	isExported() Determines whether the ruleset archive is to be included if this RuleApp is exported.
Properties	toProperties() Deprecated. As of JRules 7.0, replaced by getPropertySet().

Method Detail

getRuleAppDescriptor

IlrRuleAppDescriptor getRuleAppDescriptor()

Gets the parent RuleApp descriptor by which this ruleset archive is referenced.

Returns:

The parent RuleApp descriptor.

isEnabled

boolean isEnabled()

Determines whether the ruleset archive is enabled.

Returns:

The value of the enable property.

isExported

boolean isExported()

Determines whether the ruleset archive is to be included if this RuleApp is exported. If the value is true, the ruleset archive will be included in the RuleApp archive when it is generated.

Returns:

The value of the export property.

getPropertyValue

String getPropertyValue(String key)

Gets the property value for the specified key.

Parameters:

key - The property name.

Returns:

The property value.

getProperties

@Deprecated
Set getProperties()

Deprecated. As of JRules 7.0, replaced by getPropertiesAsStrings().

Gets the list of read only key/value in a collection format.

Returns:

A list of read only key/value in a collection format.

getPropertiesAsStrings

Set<String> getPropertiesAsStrings()

Gets the list of read only key/value in a collection format.

Since:

JRules 7.0

Returns:

A list of read only key/value in a collection format.

toProperties

@Deprecated
Properties toProperties()

Deprecated. As of JRules 7.0, replaced by getPropertySet().

Gets the list of read only key/value in the Java properties format.

Returns:

A list of read only key/value in the Java properties format.

getPropertySet

Set<Map.Entry<String,String>> getPropertySet()

Gets the list of read only key/value in a Java collection.

Since:

JRules 7.0

Returns:

A list of read only key/value in a Java collection.

getFullPath

String getFullPath()

Gets the full path of this ruleset archive. The full path is relative to the workspace.

Returns:

The ruleset archive full path.

getLocation

String getLocation()

Gets the location of this ruleset archive. The location is an absolute path.

Returns:

The ruleset archive location.

getDescription

String getDescription()

Gets the ruleset archive description.

Returns:

The ruleset archive description.

getDisplayName

String getDisplayName()

Gets the ruleset archive display name.

Returns:

The ruleset archive display name.

getName

String getName()

Gets the ruleset archive name.

Returns:

The ruleset archive name.

getVersion

String getVersion()

Gets the ruleset archive version.

Returns:

The ruleset archive version.

getRulesetParameters

Collection<IlrRulesetParameter> getRulesetParameters()

Gets the ruleset parameters from the ruleset signature.

Since:

ODM 8.5.1

Returns:

The ruleset parameters as a collection of ilog.rules.res.model.IlrRulesetParameter instances.

getRulesetSignature

IlrRulesetParameter[] getRulesetSignature()

Deprecated. As of ODM 8.5.1, replaced by getRulesetParameters().

Gets the ruleset parameters from the ruleset signature. When this descriptor references a ruleset archive produced for the ODM Decision Engine, this method returns null and an error is logged.

Returns:

The ruleset parameters, as an array of ilog.rules.engine.IlrRulesetParameter instances.

getXOMPath

org.eclipse.jdt.launching.IRuntimeClasspathEntry[] getXOMPath()

Gets the XOM path associated with this ruleset archive.

Returns:

The XOM path.