Rule Execution Server API

ilog.rules.studio.res.ruleapp
Interface IlrRuleAppDescriptor


public interface IlrRuleAppDescriptor

Describes a RuleApp stored in a RuleApp project.


Method Summary
 Date getCreationDate()
          Gets the creation data of this descriptor.
 String getDescription()
          Gets the RuleApp description.
 String getDisplayName()
          Gets the RuleApp display name.
 String getName()
          Gets the RuleApp name.
 IlrRuleAppProject getProject()
          Gets the IlrRuleAppProject where this descriptor is stored.
 Properties getProperties()
          Deprecated. As of JRules 7.0, replaced by getPropertySet().
 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.
 IlrRulesetArchiveDescriptor getRulesetArchive(String name, String version)
          Gets a ruleset archive by its name and version.
 Set<IlrRulesetArchiveDescriptor> getRulesetArchiveDescriptors()
          Gets the ruleset archives.
 Set getRulesetArchives()
          Deprecated. As of JRules 7.0, replaced by getRulesetArchiveDescriptors().
 String getVersion()
          Gets the RuleApp version.
 

Method Detail

getCreationDate

Date getCreationDate()
Gets the creation data of this descriptor.

Returns:
The creation data of this descriptor.

getPropertyValue

String getPropertyValue(String key)
Gets the property value for the specified key.

Parameters:
key - The property name.
Returns:
The property value.

getProperties

@Deprecated
Properties getProperties()
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.

getRulesetArchives

@Deprecated
Set getRulesetArchives()
Deprecated. As of JRules 7.0, replaced by getRulesetArchiveDescriptors().

Gets the ruleset archives.

Returns:
A list of IlrRulesetArchiveDescriptor.

getRulesetArchiveDescriptors

Set<IlrRulesetArchiveDescriptor> getRulesetArchiveDescriptors()
Gets the ruleset archives.

Since:
JRules 7.0
Returns:
A list of IlrRulesetArchiveDescriptor.

getRulesetArchive

IlrRulesetArchiveDescriptor getRulesetArchive(String name,
                                              String version)
Gets a ruleset archive by its name and version.

Returns:
A list of IlrRulesetArchiveDescriptor.

getDescription

String getDescription()
Gets the RuleApp description.

Returns:
The RuleApp description.

getDisplayName

String getDisplayName()
Gets the RuleApp display name. The display name is the project name.

Returns:
The RuleApp display name.

getName

String getName()
Gets the RuleApp name. The name is a valid name for the application servers. The name is calculated from the display name by authorizing only digits, letters, and underscore characters.

Returns:
The RuleApp name.

getVersion

String getVersion()
Gets the RuleApp version.

Returns:
The RuleApp version.

getProject

IlrRuleAppProject getProject()
Gets the IlrRuleAppProject where this descriptor is stored.

Returns:
The IlrRuleAppProject where this descriptor is stored.

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013