com.microfocus.silkcentral.webservices.executionplanning

Class PropertyMetaInfo

java.lang.Object

com.microfocus.silkcentral.webservices.executionplanning.PropertyMetaInfo

public class PropertyMetaInfo
extends java.lang.Object

An instance of this class holds general information about a property. This information includes the type of the value, if the property is required, a default value, and more.

See Also:

ExecutionPlanningService

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROPERTY_TYPE_BOOLEAN value 3.
static int	PROPERTY_TYPE_CALCULATED value 14.
static int	PROPERTY_TYPE_CHAR value 9.
static int	PROPERTY_TYPE_DATE value 4.
static int	PROPERTY_TYPE_DOUBLE value 6.
static int	PROPERTY_TYPE_EDIT value 13.
static int	PROPERTY_TYPE_FLOAT value 10.
static int	PROPERTY_TYPE_LIST value 7.
static int	PROPERTY_TYPE_NORMAL value 11.
static int	PROPERTY_TYPE_NUMBER value 5.
static int	PROPERTY_TYPE_PASSWORD value 8.
static int	PROPERTY_TYPE_SET value 12.
static int	PROPERTY_TYPE_STRING value 1.
static int	PROPERTY_TYPE_TEXT value 2.

Constructor Summary

Constructors

Constructor and Description
PropertyMetaInfo()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAllListValues() Returns all possible values for this property.
java.lang.String	getDefaultValue() Gets the default value of this property.
java.lang.String	getDescription() Gets a description of the property.
java.lang.String	getFormatString() Gets a string representing any required format for this property, or null if no format is defined.
java.lang.String	getId() Gets the ID of this meta information.
boolean	getIsEditable() Returns true if property can be changed, otherwise false.
boolean	getIsMultiSelect() Returns true if this is a multi-select property.
boolean	getIsOptional() Returns true if this is an optional property.
java.lang.String	getName() Gets the name of the property that this meta information describes.
java.lang.String	getPropertyTypeId() Gets the ID of a property type, such as parameter, attribute, junit, etc.
int	getType() Gets the type of this property.
java.lang.String	getTypeLabel() Gets the string label of this type, for example "List", "SET", etc.
void	setAllListValues(java.lang.String[] listValues)
void	setDefaultValue(java.lang.String defaultValue) Sets the default value information.
void	setDescription(java.lang.String description) Sets the description for this property.
void	setFormatString(java.lang.String formatString) Sets the required format for this property.
void	setId(java.lang.String id) Sets the ID of this property meta information.
void	setIsEditable(boolean isEditable)
void	setIsMultiSelect(boolean isMultiSelect)
void	setIsOptional(boolean isOptional) A property is optional if an object can be created without specifying a value for this property.
void	setName(java.lang.String name) Sets the name of the property that this meta information describes.
void	setPropertyTypeId(java.lang.String propertyTypeId)
void	setType(int type) Sets the type information.
void	setTypeLabel(java.lang.String typeLabel) Sets the label of the required type of this property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_TYPE_STRING

public static final int PROPERTY_TYPE_STRING

value 1. A text

See Also:

Constant Field Values

PROPERTY_TYPE_TEXT

public static final int PROPERTY_TYPE_TEXT

value 2. A long text

See Also:

Constant Field Values

PROPERTY_TYPE_BOOLEAN

public static final int PROPERTY_TYPE_BOOLEAN

value 3. A boolean true or false

See Also:

Constant Field Values

PROPERTY_TYPE_DATE

public static final int PROPERTY_TYPE_DATE

value 4. A date

See Also:

Constant Field Values

PROPERTY_TYPE_NUMBER

public static final int PROPERTY_TYPE_NUMBER

value 5. A non decimal number

See Also:

Constant Field Values

PROPERTY_TYPE_DOUBLE

public static final int PROPERTY_TYPE_DOUBLE

value 6. A double precision decimal value

See Also:

Constant Field Values

PROPERTY_TYPE_LIST

public static final int PROPERTY_TYPE_LIST

value 7. A list of values

See Also:

Constant Field Values

PROPERTY_TYPE_PASSWORD

public static final int PROPERTY_TYPE_PASSWORD

value 8. A text that has to be stored encrypted

See Also:

Constant Field Values

PROPERTY_TYPE_CHAR

public static final int PROPERTY_TYPE_CHAR

value 9. A single character

See Also:

Constant Field Values

PROPERTY_TYPE_FLOAT

public static final int PROPERTY_TYPE_FLOAT

value 10. A single precision decimal value

See Also:

Constant Field Values

PROPERTY_TYPE_NORMAL

public static final int PROPERTY_TYPE_NORMAL

value 11. A single value of a predefined set of values

See Also:

Constant Field Values

PROPERTY_TYPE_SET

public static final int PROPERTY_TYPE_SET

value 12. A subset of a predefined value set

See Also:

Constant Field Values

PROPERTY_TYPE_EDIT

public static final int PROPERTY_TYPE_EDIT

value 13. Any text

See Also:

Constant Field Values

PROPERTY_TYPE_CALCULATED

public static final int PROPERTY_TYPE_CALCULATED

value 14. A property calculated with an expression using other properties

See Also:

Constant Field Values

Constructor Detail

PropertyMetaInfo

public PropertyMetaInfo()

Method Detail

getId

public java.lang.String getId()

Gets the ID of this meta information.

Returns:

Unique id of this meta information

getDescription

public java.lang.String getDescription()

Gets a description of the property.

Returns:

description of the property

getName

public java.lang.String getName()

Gets the name of the property that this meta information describes.

Returns:

name of the property

getIsOptional

public boolean getIsOptional()

Returns true if this is an optional property. A property is optional if an object can be created without specifying a value for this property. Even if a property is internally required, it is optional if set internally. For example an entity ID is optional because it is set internally.

Returns:

true if this property is optional

getDefaultValue

public java.lang.String getDefaultValue()

Gets the default value of this property.

Returns:

a default value of null, if no default value exists.

getType

public int getType()

Gets the type of this property.

Returns:

type of this property. Possible types: PROPERTY_TYPE_STRING, PROPERTY_TYPE_TEXT, PROPERTY_TYPE_BOOLEAN, PROPERTY_TYPE_DATE, PROPERTY_TYPE_NUMBER, PROPERTY_TYPE_DOUBLE, PROPERTY_TYPE_LIST, PROPERTY_TYPE_PASSWORD, PROPERTY_TYPE_CHAR, PROPERTY_TYPE_FLOAT, PROPERTY_TYPE_CALCULATED, PROPERTY_TYPE_NORMAL, PROPERTY_TYPE_SET, PROPERTY_TYPE_EDIT

getTypeLabel

public java.lang.String getTypeLabel()

Gets the string label of this type, for example "List", "SET", etc.

Returns:

the String label of this type, for example "List", "SET", etc.

getFormatString

public java.lang.String getFormatString()

Gets a string representing any required format for this property, or null if no format is defined.

Returns:

String representing any required format for this property

getIsMultiSelect

public boolean getIsMultiSelect()

Returns true if this is a multi-select property.

Returns:

true if property is a list and can have more than one item selected, otherwise false

getAllListValues

public java.lang.String[] getAllListValues()

Returns all possible values for this property.

Returns:

all possible values for this property if property is a list

getIsEditable

public boolean getIsEditable()

Returns true if property can be changed, otherwise false.

Returns:

true if property can be changed, otherwise false

getPropertyTypeId

public java.lang.String getPropertyTypeId()

Gets the ID of a property type, such as parameter, attribute, junit, etc.

Returns:

the type ID of a PropertyValue

setName

public void setName(java.lang.String name)

Sets the name of the property that this meta information describes.

Parameters:

name - new name for property meta information

setDescription

public void setDescription(java.lang.String description)

Sets the description for this property.

Parameters:

description - new description for this property meta information

setId

public void setId(java.lang.String id)

Sets the ID of this property meta information.

Parameters:

id - ID of this property meta information

setIsOptional

public void setIsOptional(boolean isOptional)

A property is optional if an object can be created without specifying a value for this property. Even if a property is internally required, it is optional, if set internally. For example an entity ID is optional, because it is set internally.

Parameters:

isOptional - true, if optional

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Sets the default value information.

Parameters:

defaultValue - new default value for this property meta info

setType

public void setType(int type)

Sets the type information.

Parameters:

type - new default type for this property meta info

setFormatString

public void setFormatString(java.lang.String formatString)

Sets the required format for this property.

Parameters:

formatString - New format string for this property meta info

setAllListValues

public void setAllListValues(java.lang.String[] listValues)

Parameters:

listValues - array of new values for selection for this property

setIsMultiSelect

public void setIsMultiSelect(boolean isMultiSelect)

Parameters:

isMultiSelect - true if list shall support multi-selection

setIsEditable

public void setIsEditable(boolean isEditable)

Parameters:

isEditable - true if property value can be changed

setTypeLabel

public void setTypeLabel(java.lang.String typeLabel)

Sets the label of the required type of this property.

Parameters:

typeLabel - the String label of the type, for example "List" or "Set"

setPropertyTypeId

public void setPropertyTypeId(java.lang.String propertyTypeId)

Parameters:

propertyTypeId - the type ID of a PropertyValue