oracle.alm.connector.data
Class WorkItemFieldDef

java.lang.Object
  oracle.alm.connector.data.WorkItemFieldDef

public class WorkItemFieldDef
extends java.lang.Object

WorkItemFieldDef is a data structure for holding the defintion of a single work item attribute (a.k.a field.)

Since:

11.1.1.1.0

See Also:

RowDef, WorkItem, WorkItemQuery, WorkItemQueryDef

Field Summary

static java.lang.String	BOOLEAN_DATATYPE
static java.lang.String	CHECKBOX_CONTROL_NAME
static java.lang.String	COMBOBOX_CONTROL_NAME
static java.lang.String	DATE_DATATYPE
static java.lang.String	DOUBLE_DATATYPE
static java.lang.String	INPUT_DATE_CONTROL_NAME
static java.lang.String	INPUT_TEXT_CONTROL_NAME
static java.lang.String	LIST_CONTROL_NAME
static java.lang.String	LISTOFVALUES_CONTROL_NAME
static java.lang.String	LOV_FETCHMODE_MULTIPLE
static java.lang.String	LOV_FETCHMODE_SINGLE
static java.lang.String	NUMBER_DATATYPE
static java.lang.String	PROPERTY_COMBOBOX_EMPTYENTRY
static java.lang.String	PROPERTY_COMBOBOX_EMPTYENTRY_VALUE
static java.lang.String	PROPERTY_DATEFORMAT
static java.lang.String	PROPERTY_HINT
static java.lang.String	PROPERTY_LOV_FETCH_MODE
static java.lang.String	PROPERTY_MAXLENTH
static java.lang.String	PROPERTY_VISIBLE
static java.lang.String	RADIO_CONTROL_NAME
static java.lang.String	STRING_DATATYPE
static java.lang.String	TEXTAREA_CONTROL_NAME
static java.lang.String	WEB_URL

Constructor Summary

WorkItemFieldDef()

Method Summary

WorkItemFieldDef	clone(WorkItemFieldDef source) Makes a copy of WorkItemFieldDef based on current instance
java.lang.String	getColName() Retrieves the field name of the corresponding field in data source
java.lang.String	getControlType() Retrieves the control type of the field
java.lang.Object	getDefaultValue() Retrieves the default value for the field
java.lang.String	getJavaType() Retrieves the Java type of the work item field
java.lang.String	getLabel() Retrieves the label of the WorkItem attribute
java.lang.String	getLovDefName() Retrieves the LOV definition name for the field
java.lang.String	getName() Retrieves the field name.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Retrieves the field properties
java.lang.Object	getProperty(java.lang.String name) Retrieves a single property for the field
ValueResolverDef	getValueResolverDef() Retrieves the value resolver definition object for the field
boolean	isDeletable() Determines if the field can be deleted
boolean	isQueryable() Determine if the field is queryable
boolean	isQueryDisplayable()
boolean	isReadOnly() Determines if the field is readOnly
boolean	isRequired() Determines if the field is required
void	setColName(java.lang.String colname) Sets the back end repository field name that this field object is based on
void	setControlType(java.lang.String controlType) Sets the control type of the the field to be rendered as.
void	setDefaultValue(java.lang.Object defaultValue) Sets the default value for the field
void	setDeletable(boolean isDeletable) Marks the field can be deleted
void	setJavaType(java.lang.String javaType) Sets the Java type of the work item field
void	setLabel(java.lang.String label) Sets the label for the attribute
void	setLovDefName(java.lang.String lovDefname) Sets the LOV definition name for the field
void	setName(java.lang.String name) Sets the field name.
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> properties) Sets the field properties
void	setProperty(java.lang.String name, java.lang.Object value) Sets a single property for the field
void	setQueryable(boolean queryable) Marks the field as Queryable
void	setQueryDisplayable(boolean queryDisplayable) Determine if the field can be displayable in the query result table.
void	setReadOnly(boolean readOnly) Marks the field as read only
void	setRequired(boolean isMandatory) Marks the field as required
void	setValueResolverDef(ValueResolverDef valResolverDef) Sets the value resolver definition object for the field

Methods inherited from class java.lang.Object

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

Field Detail

WEB_URL

public static final java.lang.String WEB_URL

See Also:

Constant Field Values

DATE_DATATYPE

public static final java.lang.String DATE_DATATYPE

See Also:

Constant Field Values

STRING_DATATYPE

public static final java.lang.String STRING_DATATYPE

See Also:

Constant Field Values

NUMBER_DATATYPE

public static final java.lang.String NUMBER_DATATYPE

See Also:

Constant Field Values

BOOLEAN_DATATYPE

public static final java.lang.String BOOLEAN_DATATYPE

See Also:

Constant Field Values

DOUBLE_DATATYPE

public static final java.lang.String DOUBLE_DATATYPE

See Also:

Constant Field Values

INPUT_TEXT_CONTROL_NAME

public static final java.lang.String INPUT_TEXT_CONTROL_NAME

See Also:

Constant Field Values

INPUT_DATE_CONTROL_NAME

public static final java.lang.String INPUT_DATE_CONTROL_NAME

See Also:

Constant Field Values

TEXTAREA_CONTROL_NAME

public static final java.lang.String TEXTAREA_CONTROL_NAME

See Also:

Constant Field Values

LISTOFVALUES_CONTROL_NAME

public static final java.lang.String LISTOFVALUES_CONTROL_NAME

See Also:

Constant Field Values

COMBOBOX_CONTROL_NAME

public static final java.lang.String COMBOBOX_CONTROL_NAME

See Also:

Constant Field Values

RADIO_CONTROL_NAME

public static final java.lang.String RADIO_CONTROL_NAME

See Also:

Constant Field Values

CHECKBOX_CONTROL_NAME

public static final java.lang.String CHECKBOX_CONTROL_NAME

See Also:

Constant Field Values

LIST_CONTROL_NAME

public static final java.lang.String LIST_CONTROL_NAME

See Also:

Constant Field Values

PROPERTY_VISIBLE

public static final java.lang.String PROPERTY_VISIBLE

See Also:

Constant Field Values

PROPERTY_MAXLENTH

public static final java.lang.String PROPERTY_MAXLENTH

See Also:

Constant Field Values

PROPERTY_HINT

public static final java.lang.String PROPERTY_HINT

See Also:

Constant Field Values

PROPERTY_DATEFORMAT

public static final java.lang.String PROPERTY_DATEFORMAT

See Also:

Constant Field Values

PROPERTY_COMBOBOX_EMPTYENTRY

public static final java.lang.String PROPERTY_COMBOBOX_EMPTYENTRY

See Also:

Constant Field Values

PROPERTY_COMBOBOX_EMPTYENTRY_VALUE

public static final java.lang.String PROPERTY_COMBOBOX_EMPTYENTRY_VALUE

See Also:

Constant Field Values

PROPERTY_LOV_FETCH_MODE

public static final java.lang.String PROPERTY_LOV_FETCH_MODE

See Also:

Constant Field Values

LOV_FETCHMODE_SINGLE

public static final java.lang.String LOV_FETCHMODE_SINGLE

See Also:

Constant Field Values

LOV_FETCHMODE_MULTIPLE

public static final java.lang.String LOV_FETCHMODE_MULTIPLE

See Also:

Constant Field Values

Constructor Detail

WorkItemFieldDef

public WorkItemFieldDef()

Method Detail

setName

public void setName(java.lang.String name)

Sets the field name.

Parameters:

name - the name of a single WorkItem field

getName

public java.lang.String getName()

Retrieves the field name.

setColName

public void setColName(java.lang.String colname)

Sets the back end repository field name that this field object is based on

Parameters:

colname - the name of the corresponding field in data source

getColName

public java.lang.String getColName()

Retrieves the field name of the corresponding field in data source

Returns:

the back end repository field name that this field object is based on

setLabel

public void setLabel(java.lang.String label)

Sets the label for the attribute

Parameters:

label -

getLabel

public java.lang.String getLabel()

Retrieves the label of the WorkItem attribute

Returns:

the label of the WorkItem attribute

setJavaType

public void setJavaType(java.lang.String javaType)

Sets the Java type of the work item field

Parameters:

javaType -

getJavaType

public java.lang.String getJavaType()

Retrieves the Java type of the work item field

Returns:

the Java type of the WorkItem field

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

Sets the default value for the field

Parameters:

defaultValue -

getDefaultValue

public java.lang.Object getDefaultValue()

Retrieves the default value for the field

Returns:

The default value of the WorkItem field

setControlType

public void setControlType(java.lang.String controlType)

Sets the control type of the the field to be rendered as. Valid value includes INPUT_TEXT_CONTROL_NAME, INPUT_DATE_CONTROL_NAME

Parameters:

controlType -

getControlType

public java.lang.String getControlType()

Retrieves the control type of the field

Returns:

the control type of the field

setLovDefName

public void setLovDefName(java.lang.String lovDefname)

Sets the LOV definition name for the field

Parameters:

lovDefname -

getLovDefName

public java.lang.String getLovDefName()

Retrieves the LOV definition name for the field

Returns:

the LOV definition name for the field

setRequired

public void setRequired(boolean isMandatory)

Marks the field as required

Parameters:

isMandatory - true if the field is required

isRequired

public boolean isRequired()

Determines if the field is required

Returns:

true if the field is required

setQueryable

public void setQueryable(boolean queryable)

Marks the field as Queryable

Parameters:

queryable - true if the field is queryable

isQueryable

public boolean isQueryable()

Determine if the field is queryable

Returns:

true if the field is queryable

setQueryDisplayable

public void setQueryDisplayable(boolean queryDisplayable)

Determine if the field can be displayable in the query result table.

Parameters:

queryDisplayable - true if the column data for field will be displayed in the query result table, false not.

isQueryDisplayable

public boolean isQueryDisplayable()

Returns:

true if the field is displayable in query result table.

setReadOnly

public void setReadOnly(boolean readOnly)

Marks the field as read only

Parameters:

readOnly - true if the field is read only

isReadOnly

public boolean isReadOnly()

Determines if the field is readOnly

Returns:

true if the field is readOnly

setDeletable

public void setDeletable(boolean isDeletable)

Marks the field can be deleted

Parameters:

isDeletable - true if the field can be deleted

isDeletable

public boolean isDeletable()

Determines if the field can be deleted

Returns:

true if the field can be deleted

setValueResolverDef

public void setValueResolverDef(ValueResolverDef valResolverDef)

Sets the value resolver definition object for the field

Parameters:

valResolverDef - the value resolver definition object to use by the field

getValueResolverDef

public ValueResolverDef getValueResolverDef()

Retrieves the value resolver definition object for the field

Returns:

An ValueResolverDef object

getProperty

public java.lang.Object getProperty(java.lang.String name)

Retrieves a single property for the field

Parameters:

name - property name

Returns:

An object that contains the property value

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Sets a single property for the field

Parameters:

name - property name

value - property value

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

Sets the field properties

Parameters:

properties - a map that contains properties

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Retrieves the field properties

Returns:

a map that contains properties

clone

public WorkItemFieldDef clone(WorkItemFieldDef source)

Makes a copy of WorkItemFieldDef based on current instance

Returns:

WorkItemFieldDef object