HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform
Interface IRenderingRule

All Known Implementing Classes:
RenderingRule

public interface IRenderingRule


Field Summary
static String COPYRIGHT
          The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.
 
Method Summary
 String getAssociatedScreen()
          Gets the name of the associated screen capture.
 String getComponentClassName()
          Gets the name of the PatternComponent for this rule.
 Properties getComponentSettings()
          Gets the settings for the PatternComponent in this rule.
 String getDescription()
          Gets the description.
 String getName()
          Gets the name of this rule.
 BlockScreenRegion getRegion()
          Not currently used.
 String getTransformationFragment()
          Gets the name of the associated transformation fragment for this rule.
 boolean isEnabled()
          Gets whether or not this rule is enabled.
 

Field Detail

COPYRIGHT

static final String COPYRIGHT
The HsrCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.

See Also:
Constant Field Values
Method Detail

getAssociatedScreen

String getAssociatedScreen()
Gets the name of the associated screen capture.

Returns:
The name of the associated screen capture.

getDescription

String getDescription()
Gets the description.

Returns:
The description.

getRegion

BlockScreenRegion getRegion()
Not currently used.

Returns:
The block screen region.

isEnabled

boolean isEnabled()
Gets whether or not this rule is enabled.

Returns:
A boolean value indicating whether or not this rule is enabled.

getTransformationFragment

String getTransformationFragment()
Gets the name of the associated transformation fragment for this rule.

Returns:
The name of the associated transformation fragment for this rule.

getComponentClassName

String getComponentClassName()
Gets the name of the PatternComponent for this rule.

Returns:
The name of the PatternComponent for this rule.

getComponentSettings

Properties getComponentSettings()
Gets the settings for the PatternComponent in this rule.

Returns:
The settings for the PatternComponent in this rule.

getName

String getName()
Gets the name of this rule.

Returns:
The name of this rule.

HATS 7.5.1 (201005110649)