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.common
Class HCustomProperty

java.lang.Object
  extended by com.ibm.hats.common.HCustomProperty

public class HCustomProperty
extends Object

Class defining an individual user-customizable property for an object implementing ICustomPropertySupplier.

See Also:
ICustomPropertySupplier, ICustomPropertyValidator

Field Summary
static String CLASS_NAME
           
static int TYPE_BOOLEAN
          HCustomProperty boolean type
static int TYPE_BUTTON
          HCustomProperty button type
static int TYPE_COLOR
          HCustomProperty color type
static int TYPE_ENUMERATION
          HCustomProperty Enumeration type
static int TYPE_EXCLUSIVE_GROUP
          HCustomProperty exclusive group type
static int TYPE_EXCLUSIVE_OPTION
          HCustomProperty exclusive option type
static int TYPE_FILE
          HCustomProperty file type
static int TYPE_FLOAT
          HCustomProperty float type
static int TYPE_FONT
          HCustomProperty font type
static int TYPE_GLOBAL_VARIABLE
          not currently used
static int TYPE_GROUP
          HCustomProperty group type
static int TYPE_IMAGE
          HCustomProperty image selection type
static int TYPE_INT
          HCustomProperty int type
static int TYPE_INT_GREATER_ZERO
          HCustomProperty positive integer type
static int TYPE_INT_NOT_NEGATIVE
          HCustomProperty non-negative integer type
static int TYPE_PASSWORD
          HCustomProperty password type
static int TYPE_PURE_LABEL
          HCustomProperty pure label type
static int TYPE_REVERSE_PARENT_BOOLEAN
          HCustomProperty reverse parent boolean type
static int TYPE_SEPARATOR
          HCustomProperty separator type
static int TYPE_SHARED_GLOBAL_VARIABLE
          not currently used
static int TYPE_STRING
          HCustomProperty String type
static int TYPE_STYLE
          HCustomProperty CSS style override type
static int TYPE_STYLE_CLASS
          HCustomProperty CSS class mapping type
 
Constructor Summary
HCustomProperty(String name, int type, String label, boolean isRequired, String[] prefilledValues, String[] prefilledCodes, String defaultValue, ICustomPropertyValidator validator, String helpID)
          Constructs an HCustomProperty
 
Method Summary
 String[] getChildEnablementValues()
          Gets the possible values of this property's parent for which this property will be enabled.
 String getDefaultValue()
          Gets this property's default value
 String getHelpID()
          Gets context help ID pointing to description for this property
 String getImageName()
          Gets the name of the image which is displayed with this custom property.
 String getLabel()
          Gets this property's GUI label
 String getName()
          Gets this property's name
 String getParent()
          Gets name of parent property for this custom property
 String[] getPrefilledCodes()
          Gets codes mapped to displayed values for a TYPE_ENUMERATION HCustomProperty
 String[] getPrefilledValues()
          Gets values to display in GUI for a TYPE_ENUMERATION or HCustomProperty.TYPE_STRING HCustomProperty
 int getType()
          Gets this property's type
 ICustomPropertyValidator getValidator()
          Gets this property's validator
 boolean isBold()
          Sets whether this property should be displayed in bold for a TYPE_PURE_LABEL.
 boolean isIndentUnderParent()
           
 boolean isRequired()
          Gets whether or not this property requires a value entered
static HCustomProperty new_Boolean(String name, String label, boolean defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_BOOLEAN HCustomProperty
static HCustomProperty new_Color(String name, String label, boolean isRequired, String defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_COLOR HCustomProperty
static HCustomProperty new_Enumeration(String name, String label, boolean isRequired, String[] prefilledValues, String[] prefilledCodes, String defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_ENUMERATION HCustomProperty
static HCustomProperty new_Exclusive_Group(String name, String label, boolean defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_EXCLUSIVE_GROUP HCustomProperty
static HCustomProperty new_Exclusive_Option(String name, String label, String defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_EXCLUSIVE_OPTION HCustomProperty
static HCustomProperty new_Float(String name, String label, boolean isRequired, float defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_FLOAT HCustomProperty
static HCustomProperty new_Group(String name, String label, boolean defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_GROUP HCustomProperty
static HCustomProperty new_Image(String name, String label, ICustomPropertyValidator validator, String helpID)
           
static HCustomProperty new_ImageLabel(String caption, String imageName)
          Convenience method for constructing TYPE_PURE_LABEL HCustomProperty with the specified image for display.
static HCustomProperty new_Int(String name, String label, boolean isRequired, int defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_INT HCustomProperty
static HCustomProperty new_IntGreaterZero(String name, String label, boolean isRequired, int defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_INT_GREATER_ZERO HCustomProperty
static HCustomProperty new_IntNotNegative(String name, String label, boolean isRequired, int defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_INT_NOT_NEGATIVE HCustomProperty
static HCustomProperty new_Label(String caption)
          Convenience method for constructing TYPE_PURE_LABEL HCustomProperty
static HCustomProperty new_Password(String name, String label, boolean isRequired, String defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_PASSWORD HCustomProperty
static HCustomProperty new_ReverseParentBoolean(String name, String label, boolean defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_REVERSE_PARENT_BOOLEAN HCustomProperty
static HCustomProperty new_Separator()
          Convenience method for constructing TYPE_SEPARATOR HCustomProperty
static HCustomProperty new_Separator(String parentName)
          Convenience method for constructing TYPE_SEPARATOR HCustomProperty and setting its parent to the specified property.
static HCustomProperty new_String(String name, String label, boolean isRequired, String[] prefilledValues, String defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_STRING HCustomProperty
static HCustomProperty new_Style(String name, String label, boolean isRequired, String defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_STYLE HCustomProperty
static HCustomProperty new_StyleClass(String name, String label, boolean isRequired, String defaultValue, ICustomPropertyValidator validator, String helpID)
          Convenience method for constructing TYPE_STYLE_CLASS HCustomProperty
 void setBold(boolean b)
          Sets whether this property should be displayed in bold for a TYPE_PURE_LABEL.
 void setChildEnablementValues(String[] values)
          Sets the possible values of this property's parent for which this property will be enabled.
 void setDefaultValue(String newDefaultValue)
          Sets this property's default value
 void setHelpID(String newHelpID)
          Sets context help ID pointing to description for this property
 void setImageName(String string)
          Sets the name of the image which is displayed with this custom property.
 void setIndentUnderParent(boolean indentUnderParent)
           
 void setIsRequired(boolean newIsRequired)
          Sets whether or not this property requires a value entered
 void setLabel(String newLabel)
          Sets this property's GUI label
 void setName(String newName)
          Sets this property's name
 void setParent(String newParentName)
          Sets parent property for this custom property.
 void setPrefilledCodes(String[] newPrefilledCodes)
          Sets codes mapped to displayed values for a TYPE_ENUMERATION HCustomProperty
 void setPrefilledValues(String[] newPrefilledValues)
          Sets values to display in GUI for a TYPE_ENUMERATION or TYPE_STRING HCustomProperty.
 void setType(int newType)
          Sets this property's type
 void setValidator(ICustomPropertyValidator newValidator)
          Sets this property's validator
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values

TYPE_STRING

public static final int TYPE_STRING
HCustomProperty String type

See Also:
Constant Field Values

TYPE_INT

public static final int TYPE_INT
HCustomProperty int type

See Also:
Constant Field Values

TYPE_FLOAT

public static final int TYPE_FLOAT
HCustomProperty float type

See Also:
Constant Field Values

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN
HCustomProperty boolean type

See Also:
Constant Field Values

TYPE_ENUMERATION

public static final int TYPE_ENUMERATION
HCustomProperty Enumeration type

See Also:
Constant Field Values

TYPE_PASSWORD

public static final int TYPE_PASSWORD
HCustomProperty password type

See Also:
Constant Field Values

TYPE_FILE

public static final int TYPE_FILE
HCustomProperty file type

See Also:
Constant Field Values

TYPE_COLOR

public static final int TYPE_COLOR
HCustomProperty color type

See Also:
Constant Field Values

TYPE_INT_GREATER_ZERO

public static final int TYPE_INT_GREATER_ZERO
HCustomProperty positive integer type

See Also:
Constant Field Values

TYPE_INT_NOT_NEGATIVE

public static final int TYPE_INT_NOT_NEGATIVE
HCustomProperty non-negative integer type

See Also:
Constant Field Values

TYPE_SEPARATOR

public static final int TYPE_SEPARATOR
HCustomProperty separator type

See Also:
Constant Field Values

TYPE_GROUP

public static final int TYPE_GROUP
HCustomProperty group type

See Also:
Constant Field Values

TYPE_EXCLUSIVE_OPTION

public static final int TYPE_EXCLUSIVE_OPTION
HCustomProperty exclusive option type

See Also:
Constant Field Values

TYPE_EXCLUSIVE_GROUP

public static final int TYPE_EXCLUSIVE_GROUP
HCustomProperty exclusive group type

See Also:
Constant Field Values

TYPE_REVERSE_PARENT_BOOLEAN

public static final int TYPE_REVERSE_PARENT_BOOLEAN
HCustomProperty reverse parent boolean type

See Also:
Constant Field Values

TYPE_PURE_LABEL

public static final int TYPE_PURE_LABEL
HCustomProperty pure label type

See Also:
Constant Field Values

TYPE_STYLE_CLASS

public static final int TYPE_STYLE_CLASS
HCustomProperty CSS class mapping type

See Also:
Constant Field Values

TYPE_STYLE

public static final int TYPE_STYLE
HCustomProperty CSS style override type

See Also:
Constant Field Values

TYPE_GLOBAL_VARIABLE

public static final int TYPE_GLOBAL_VARIABLE
not currently used

See Also:
Constant Field Values

TYPE_SHARED_GLOBAL_VARIABLE

public static final int TYPE_SHARED_GLOBAL_VARIABLE
not currently used

See Also:
Constant Field Values

TYPE_FONT

public static final int TYPE_FONT
HCustomProperty font type

See Also:
Constant Field Values

TYPE_BUTTON

public static final int TYPE_BUTTON
HCustomProperty button type

See Also:
Constant Field Values

TYPE_IMAGE

public static final int TYPE_IMAGE
HCustomProperty image selection type

See Also:
Constant Field Values
Constructor Detail

HCustomProperty

public HCustomProperty(String name,
                       int type,
                       String label,
                       boolean isRequired,
                       String[] prefilledValues,
                       String[] prefilledCodes,
                       String defaultValue,
                       ICustomPropertyValidator validator,
                       String helpID)
Constructs an HCustomProperty

Parameters:
name - name of this custom property
type - type of this custom property, ie HCustomProperty.TYPE_COLOR
label - label for this custom property, to be displayed in the GUI
isRequired - whether or not this property requires a value entered
prefilledValues - array of values to display for an HCustomProperty.TYPE_ENUMERATION or HCustomProperty.TYPE_STRING
prefilledCodes - array of codes for an HCustomProperty.TYPE_ENUMERATION
defaultValue - default value for this custom property
validator - property validator for this custom property
helpID - context help ID pointing to infopop for field corresponding to this property in the GUI
Method Detail

getName

public String getName()
Gets this property's name

Returns:
property name

setName

public void setName(String newName)
Sets this property's name

Parameters:
newName - name for this property

getType

public int getType()
Gets this property's type

Returns:
property type

setType

public void setType(int newType)
Sets this property's type

Parameters:
newType - type for this property

getLabel

public String getLabel()
Gets this property's GUI label

Returns:
property GUI label

setLabel

public void setLabel(String newLabel)
Sets this property's GUI label

Parameters:
newLabel - GUI label for this property, or null for empty String

isRequired

public boolean isRequired()
Gets whether or not this property requires a value entered

Returns:
whether or not this property is required

setIsRequired

public void setIsRequired(boolean newIsRequired)
Sets whether or not this property requires a value entered

Parameters:
newIsRequired - whether or not this property is required

getPrefilledValues

public String[] getPrefilledValues()
Gets values to display in GUI for a TYPE_ENUMERATION or HCustomProperty.TYPE_STRING HCustomProperty

Returns:
array of values, or null if no prefilled values are defined

setPrefilledValues

public void setPrefilledValues(String[] newPrefilledValues)
Sets values to display in GUI for a TYPE_ENUMERATION or TYPE_STRING HCustomProperty. If non-null in TYPE_STRING, these are displayed in an editable combo box. If non-null in TYPE_ENUMERATION, these are displayed in a non-editable combo box.

Parameters:
newPrefilledValues - array of values for this property, or null if no prefilled values are to be defined

getPrefilledCodes

public String[] getPrefilledCodes()
Gets codes mapped to displayed values for a TYPE_ENUMERATION HCustomProperty

Returns:
array of codes null if not TYPE_ENUMERATION

setPrefilledCodes

public void setPrefilledCodes(String[] newPrefilledCodes)
Sets codes mapped to displayed values for a TYPE_ENUMERATION HCustomProperty

Parameters:
newPrefilledCodes - array of codes for this property, null if not TYPE_ENUMERATION

getDefaultValue

public String getDefaultValue()
Gets this property's default value

Returns:
property default value

setDefaultValue

public void setDefaultValue(String newDefaultValue)
Sets this property's default value

Parameters:
newDefaultValue - default value for this property

getValidator

public ICustomPropertyValidator getValidator()
Gets this property's validator

Returns:
property validator, or null if none

setValidator

public void setValidator(ICustomPropertyValidator newValidator)
Sets this property's validator

Parameters:
newValidator - validator for this property, or null if no validation is required

getHelpID

public String getHelpID()
Gets context help ID pointing to description for this property

Returns:
property help ID, or null if no associated context help

setHelpID

public void setHelpID(String newHelpID)
Sets context help ID pointing to description for this property

Parameters:
newHelpID - context help ID for this property, or null if none is available

new_String

public static HCustomProperty new_String(String name,
                                         String label,
                                         boolean isRequired,
                                         String[] prefilledValues,
                                         String defaultValue,
                                         ICustomPropertyValidator validator,
                                         String helpID)
Convenience method for constructing TYPE_STRING HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Int

public static HCustomProperty new_Int(String name,
                                      String label,
                                      boolean isRequired,
                                      int defaultValue,
                                      ICustomPropertyValidator validator,
                                      String helpID)
Convenience method for constructing TYPE_INT HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_IntGreaterZero

public static HCustomProperty new_IntGreaterZero(String name,
                                                 String label,
                                                 boolean isRequired,
                                                 int defaultValue,
                                                 ICustomPropertyValidator validator,
                                                 String helpID)
Convenience method for constructing TYPE_INT_GREATER_ZERO HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_IntNotNegative

public static HCustomProperty new_IntNotNegative(String name,
                                                 String label,
                                                 boolean isRequired,
                                                 int defaultValue,
                                                 ICustomPropertyValidator validator,
                                                 String helpID)
Convenience method for constructing TYPE_INT_NOT_NEGATIVE HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Float

public static HCustomProperty new_Float(String name,
                                        String label,
                                        boolean isRequired,
                                        float defaultValue,
                                        ICustomPropertyValidator validator,
                                        String helpID)
Convenience method for constructing TYPE_FLOAT HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Boolean

public static HCustomProperty new_Boolean(String name,
                                          String label,
                                          boolean defaultValue,
                                          ICustomPropertyValidator validator,
                                          String helpID)
Convenience method for constructing TYPE_BOOLEAN HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_ReverseParentBoolean

public static HCustomProperty new_ReverseParentBoolean(String name,
                                                       String label,
                                                       boolean defaultValue,
                                                       ICustomPropertyValidator validator,
                                                       String helpID)
Convenience method for constructing TYPE_REVERSE_PARENT_BOOLEAN HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Enumeration

public static HCustomProperty new_Enumeration(String name,
                                              String label,
                                              boolean isRequired,
                                              String[] prefilledValues,
                                              String[] prefilledCodes,
                                              String defaultValue,
                                              ICustomPropertyValidator validator,
                                              String helpID)
Convenience method for constructing TYPE_ENUMERATION HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Password

public static HCustomProperty new_Password(String name,
                                           String label,
                                           boolean isRequired,
                                           String defaultValue,
                                           ICustomPropertyValidator validator,
                                           String helpID)
Convenience method for constructing TYPE_PASSWORD HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Color

public static HCustomProperty new_Color(String name,
                                        String label,
                                        boolean isRequired,
                                        String defaultValue,
                                        ICustomPropertyValidator validator,
                                        String helpID)
Convenience method for constructing TYPE_COLOR HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Separator

public static HCustomProperty new_Separator()
Convenience method for constructing TYPE_SEPARATOR HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Separator

public static HCustomProperty new_Separator(String parentName)
Convenience method for constructing TYPE_SEPARATOR HCustomProperty and setting its parent to the specified property.

Parameters:
parentName - name of the parent property
See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Exclusive_Option

public static HCustomProperty new_Exclusive_Option(String name,
                                                   String label,
                                                   String defaultValue,
                                                   ICustomPropertyValidator validator,
                                                   String helpID)
Convenience method for constructing TYPE_EXCLUSIVE_OPTION HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Group

public static HCustomProperty new_Group(String name,
                                        String label,
                                        boolean defaultValue,
                                        ICustomPropertyValidator validator,
                                        String helpID)
Convenience method for constructing TYPE_GROUP HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Exclusive_Group

public static HCustomProperty new_Exclusive_Group(String name,
                                                  String label,
                                                  boolean defaultValue,
                                                  ICustomPropertyValidator validator,
                                                  String helpID)
Convenience method for constructing TYPE_EXCLUSIVE_GROUP HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String)

new_Style

public static HCustomProperty new_Style(String name,
                                        String label,
                                        boolean isRequired,
                                        String defaultValue,
                                        ICustomPropertyValidator validator,
                                        String helpID)
Convenience method for constructing TYPE_STYLE HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String), HCustomProperty.TYPE_STYLE

new_StyleClass

public static HCustomProperty new_StyleClass(String name,
                                             String label,
                                             boolean isRequired,
                                             String defaultValue,
                                             ICustomPropertyValidator validator,
                                             String helpID)
Convenience method for constructing TYPE_STYLE_CLASS HCustomProperty

See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String), HCustomProperty.TYPE_STYLE_CLASS

new_ImageLabel

public static HCustomProperty new_ImageLabel(String caption,
                                             String imageName)
Convenience method for constructing TYPE_PURE_LABEL HCustomProperty with the specified image for display.

Parameters:
caption - label content
imageName - image to display
See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String), HCustomProperty.TYPE_PURE_LABEL

new_Label

public static HCustomProperty new_Label(String caption)
Convenience method for constructing TYPE_PURE_LABEL HCustomProperty

Parameters:
caption - label content
See Also:
HCustomProperty.HCustomProperty(String, int, String, boolean, String[], String[], String, ICustomPropertyValidator, String), HCustomProperty.TYPE_PURE_LABEL

new_Image

public static HCustomProperty new_Image(String name,
                                        String label,
                                        ICustomPropertyValidator validator,
                                        String helpID)

getParent

public String getParent()
Gets name of parent property for this custom property

Returns:
parent's name, or null if no parent

setParent

public void setParent(String newParentName)
Sets parent property for this custom property. Used for relative indentation and group enable/disable when properties are displayed in the autogui.

Parameters:
newParentName - new parent for this property, or null if property has no parent

getChildEnablementValues

public String[] getChildEnablementValues()
Gets the possible values of this property's parent for which this property will be enabled.

Returns:
values needed for enablement

setChildEnablementValues

public void setChildEnablementValues(String[] values)
Sets the possible values of this property's parent for which this property will be enabled.

Parameters:
values - values needed for enablement

getImageName

public String getImageName()
Gets the name of the image which is displayed with this custom property.

Returns:
image name

setImageName

public void setImageName(String string)
Sets the name of the image which is displayed with this custom property.

Parameters:
string -

isBold

public boolean isBold()
Sets whether this property should be displayed in bold for a TYPE_PURE_LABEL.

Returns:
true for bold, false for normal

setBold

public void setBold(boolean b)
Sets whether this property should be displayed in bold for a TYPE_PURE_LABEL.


isIndentUnderParent

public boolean isIndentUnderParent()
Returns:
Returns the indentUnderParent.

setIndentUnderParent

public void setIndentUnderParent(boolean indentUnderParent)
Parameters:
indentUnderParent - The indentUnderParent to set.

HATS 7.5.1 (201005110649)