|
CodeBeamer 5.4.0.1-RC API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.intland.codebeamer.persistence.dto.base.IdentifiableDto
com.intland.codebeamer.persistence.dto.TrackerLayoutLabelDto
public class TrackerLayoutLabelDto
Represents a field in a tracker layout.
Nested Class Summary | |
---|---|
static interface |
TrackerLayoutLabelDto.CompiledFormula
The interface of a compiled representation of a calculated field's formula |
static class |
TrackerLayoutLabelDto.OffsetComparator
A special Comparator to compare/sort TrackerLayoutLabelDto by offset |
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto |
---|
IdentifiableDto.IdComparator |
Constructor Summary | |
---|---|
TrackerLayoutLabelDto()
|
|
TrackerLayoutLabelDto(int id)
|
|
TrackerLayoutLabelDto(TrackerLayoutLabelDto field)
|
Method Summary | |
---|---|
static java.lang.Comparable |
decodeString(java.lang.String strval,
int valueType)
Decode the specified String value to an internal value according to the specified value type |
boolean |
equals(java.lang.Object obj)
|
java.lang.Integer |
getAggregationRuleId()
Get the ID of the rule, how to aggregate child field values to parent field values |
java.lang.Integer |
getAssocTypeId()
|
java.lang.Boolean |
getBreakRow()
|
static int |
getChoiceFieldId(int fld_idx)
Get the id of the idx.th user defined choice field |
static int |
getChoiceFieldIndex(int fld_id)
Get the index [0 .. |
java.lang.Integer |
getCols()
|
java.lang.Integer |
getColspan()
|
TrackerLayoutLabelDto.CompiledFormula |
getCompiledFormula()
Get the compiled script/formula to calculate the field's value |
static int |
getCustomFieldId(int fld_idx)
Get the id of the idx.th user defined/custom field |
static int |
getCustomFieldIndex(int fld_id)
Get the index [0 .. |
java.lang.String |
getDefaultValue()
|
java.lang.Integer |
getDistributionRuleId()
Get the ID of the rule, how to distribute parent field values down the hierarchy |
java.lang.Boolean |
getEditable()
|
java.lang.String |
getFormula()
Get the script/formula code to calculate the field's value |
static java.text.DateFormat |
getGMTDateTimeFormat()
Get the thread-local GMT date and time formatter (no need to synchronize access) |
java.lang.String |
getHeaderStyleClass()
|
int |
getInputType()
|
java.lang.String |
getLabel()
|
java.lang.String |
getLabelWithoutBR()
|
java.lang.Boolean |
getListable()
Check if this field should also be shown as a column in item lists/tables |
java.lang.String |
getMaxValue()
|
java.lang.String |
getMinValue()
|
java.lang.Boolean |
getMultipleSelection()
|
java.lang.Integer |
getOffset()
|
java.lang.String |
getProperty()
This web tier related method should never be called in a remote API application. |
java.lang.Boolean |
getRequired()
|
java.lang.Integer |
getRoleId()
|
java.lang.Integer |
getRows()
|
java.lang.Number |
getSelectionSize()
|
java.lang.String |
getSortProperty()
This web tier related method should never be called in a remote API application. |
java.lang.Integer |
getStatusId()
|
java.lang.String |
getStyleClass()
|
java.lang.String |
getTitle()
Get the column title for this field. |
TrackerDto |
getTracker()
|
java.lang.Integer |
getTrackerId()
Shortcut for getTracker().getId() that takes care about NULL tracker |
java.lang.Object |
getValue(TrackerItemDto item)
Get the value of this field from the specified TrackerItemDto |
static java.lang.Object |
getValue(TrackerItemDto item,
int fieldId)
Get the value of the label from the specified TrackerItemDto This method does not use reflection because of performance !! |
java.lang.Class<?> |
getValueClass()
|
java.lang.Integer |
getValueType()
|
java.lang.Boolean |
getVisible()
Check if this field should be shown in the item details/editor screen |
boolean |
isAccessible(TrackerItemDto item,
boolean writable)
Check if the value of this field in the specified item is accessible in the specified mode |
boolean |
isBooleanField()
|
boolean |
isChoiceField()
|
static boolean |
isChoiceField(int lbl_id)
|
boolean |
isCompatible(TrackerLayoutLabelDto field)
Check if the specified field is value compatible to this field |
boolean |
isDynamicChoice()
Check if the field is configured for dynamic choice. |
static boolean |
isEditableAtAll(java.lang.Integer id)
|
boolean |
isForeignKey()
|
static boolean |
isForeignKey(int fldId)
Check if the specified choice/reference field is a foreign key |
boolean |
isMemberChoice()
Check if the field is configured for member (user or role) choice. |
boolean |
isReferenceFieldConfigurationAllowed()
Is if this is a choice field where reference/dynamic choices are allowed ? |
boolean |
isUserDefined()
|
static boolean |
isUserDefined(int fld_id)
Check if the specified field is a user defined custom field |
boolean |
isUserReferenceField()
If this field is a reference to users or roles. |
static boolean |
isUserReferenceField(int fldId)
Check if the field with the specified ID is a User reference field |
void |
setAggregationRuleId(java.lang.Integer aggregationRuleId)
Set the ID of the rule, how to aggregate child field values to parent field values |
void |
setAssocTypeId(java.lang.Integer assocTypeId)
|
void |
setBreakRow(java.lang.Boolean value)
|
void |
setCols(java.lang.Integer cols)
|
void |
setColspan(java.lang.Integer colspan)
|
void |
setCompiledFormula(TrackerLayoutLabelDto.CompiledFormula compiledFormula)
Set the compiled script/formula to calculate the field's value |
void |
setDefaultValue(java.lang.String defaultValue)
|
void |
setDistributionRuleId(java.lang.Integer distributionRuleId)
Set the ID of the rule, how to distribute parent field values down the hierarchy |
void |
setEditable(java.lang.Boolean value)
|
void |
setFormula(java.lang.String formula)
Set the script/formula code to calculate the field's value |
void |
setInputType(int inputType)
|
void |
setLabel(java.lang.String label)
|
void |
setListable(java.lang.Boolean listable)
Set whether this field should also be shown as a column in item lists/tables |
void |
setMaxValue(java.lang.String value)
|
void |
setMinValue(java.lang.String value)
|
void |
setMultipleSelection(java.lang.Boolean multipleSelection)
|
void |
setOffset(java.lang.Integer offset)
|
void |
setRequired(java.lang.Boolean value)
|
void |
setRoleId(java.lang.Integer roleId)
|
void |
setRows(java.lang.Integer rows)
|
void |
setSelectionSize(java.lang.Number selectionSize)
|
void |
setStatusId(java.lang.Integer statusId)
|
void |
setTitle(java.lang.String title)
Set the column title for this field. |
void |
setTracker(TrackerDto tracker)
|
static void |
setValue(TrackerItemDto item,
int fieldId,
java.lang.Object value)
Set the value of this field in the specified TrackerItemDto |
void |
setValue(TrackerItemDto item,
java.lang.Object value)
Set the value of this field in the specified TrackerItemDto |
void |
setValueType(java.lang.Integer type)
|
void |
setVisible(java.lang.Boolean value)
Set whether this field should be shown in the item details/editor screen |
java.lang.String |
toString()
|
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto |
---|
clone, compare, compareInteger, compareTo, equals, getId, hashCode, hashCode, setId |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int TEXT
public static final int INTEGER
public static final int DECIMAL
public static final int DATE
public static final int BOOLEAN
public static final int PRINCIPAL
public static final int ID_LABEL_ID
public static final int TYPE_LABEL_ID
public static final int PRIORITY_LABEL_ID
public static final int NAME_LABEL_ID
public static final int SUBMITTED_AT_LABEL_ID
public static final int ASSIGNED_TO_LABEL_ID
public static final int SUBMITTED_BY_LABEL_ID
public static final int STATUS_LABEL_ID
public static final int START_DATE_LABEL_ID
public static final int END_DATE_LABEL_ID
public static final int ESTIMATED_H_LABEL_ID
public static final int SPENT_H_LABEL_ID
public static final int SPENT_ESTIMATED_H_LABEL_ID
public static final int CATEGORY_LABEL_ID
public static final int SEVERITY_LABEL_ID
public static final int RESOLUTION_LABEL_ID
public static final int PLATFORM_LABEL_ID
public static final int OP_SYS_LABEL_ID
public static final int ASSIGNED_AT_LABEL_ID
public static final int MILESTONES_LABEL_ID
public static final int VERSION_LABEL_ID
public static final int SUPERVISOR_LABEL_ID
public static final int PROJECT_NAME_LABEL_ID
public static final int TRACKER_KEY_NAME_LABEL_ID
public static final int MODIFIED_AT_LABEL_ID
public static final int MODIFIED_BY_LABEL_ID
public static final int PARENT_LABEL_ID
public static final int DEPENDENCY_LABEL_ID
public static final int REFERERS_LABEL_ID
public static final int CHILDREN_LABEL_ID
public static final int DESCRIPTION_LABEL_ID
public static final int CLOSED_AT_LABEL_ID
public static final java.lang.String DEFAULT_DATETIME_FORMAT
public static final java.lang.String DEFAULT_DATE_FORMAT
Constructor Detail |
---|
public TrackerLayoutLabelDto()
public TrackerLayoutLabelDto(int id)
public TrackerLayoutLabelDto(TrackerLayoutLabelDto field)
Method Detail |
---|
public static java.text.DateFormat getGMTDateTimeFormat()
public static boolean isEditableAtAll(java.lang.Integer id)
public boolean equals(java.lang.Object obj)
equals
in class IdentifiableDto
public java.lang.String toString()
toString
in class IdentifiableDto
public java.lang.String getLabelWithoutBR()
public java.lang.Boolean getBreakRow()
public void setBreakRow(java.lang.Boolean value)
public java.lang.Integer getCols()
public void setCols(java.lang.Integer cols)
public java.lang.Integer getColspan()
public void setColspan(java.lang.Integer colspan)
public java.lang.Boolean getEditable()
public void setEditable(java.lang.Boolean value)
public java.lang.String getLabel()
public void setLabel(java.lang.String label)
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
title
- is a shorter form of the label, for use in column headers, or null (use label also for title)public java.lang.String getMaxValue()
public void setMaxValue(java.lang.String value)
public java.lang.String getMinValue()
public void setMinValue(java.lang.String value)
public java.lang.Boolean getRequired()
public void setRequired(java.lang.Boolean value)
public java.lang.Integer getRows()
public void setRows(java.lang.Integer rows)
public java.lang.Boolean getVisible()
public void setVisible(java.lang.Boolean value)
value
- true/false to show/not show the field in the item details/editor screenpublic java.lang.Boolean getListable()
public void setListable(java.lang.Boolean listable)
listable
- true/false to show/not show the field in item lists/tables, or null (show column according to visible setting)public void setInputType(int inputType)
public int getInputType()
public java.lang.Integer getValueType()
public void setValueType(java.lang.Integer type)
public java.lang.String getDefaultValue()
public void setDefaultValue(java.lang.String defaultValue)
public java.lang.Integer getOffset()
public void setOffset(java.lang.Integer offset)
public java.lang.Integer getStatusId()
public void setStatusId(java.lang.Integer statusId)
public boolean isChoiceField()
public boolean isUserDefined()
public static int getChoiceFieldIndex(int fld_id)
fld_id
- of the user defined choice field [1000 ... 9999]
public static int getChoiceFieldId(int fld_idx)
fld_idx
- of the user defined choice field [0 .. 8999]
public static boolean isChoiceField(int lbl_id)
public static boolean isUserDefined(int fld_id)
fld_id
- of the field to check
public static int getCustomFieldIndex(int fld_id)
fld_id
- of the custom field
public static int getCustomFieldId(int fld_idx)
fld_idx
- of the custom field [0 .. n]
public boolean isReferenceFieldConfigurationAllowed()
public boolean isDynamicChoice()
public boolean isMemberChoice()
public boolean isUserReferenceField()
public static boolean isUserReferenceField(int fldId)
fldId
- is the ID of the field to check
public static boolean isForeignKey(int fldId)
fldId
- of the choice/reference field
public boolean isForeignKey()
public boolean isBooleanField()
public java.lang.Integer getRoleId()
public void setRoleId(java.lang.Integer roleId)
public java.lang.Integer getAssocTypeId()
public void setAssocTypeId(java.lang.Integer assocTypeId)
public java.lang.Boolean getMultipleSelection()
public void setMultipleSelection(java.lang.Boolean multipleSelection)
public java.lang.Number getSelectionSize()
public void setSelectionSize(java.lang.Number selectionSize)
public java.lang.Integer getAggregationRuleId()
public void setAggregationRuleId(java.lang.Integer aggregationRuleId)
aggregationRuleId
- is the ID of the rule, how to aggregate child field values to parent field values, or null (no aggregation)public java.lang.Integer getDistributionRuleId()
public void setDistributionRuleId(java.lang.Integer distributionRuleId)
distributionRuleId
- is the ID of the rule, how to distribute parent field values down the hierarchy, or null (no distribution)public java.lang.String getProperty()
public java.lang.String getSortProperty()
public java.lang.Class<?> getValueClass()
public java.lang.String getHeaderStyleClass()
public java.lang.String getStyleClass()
public TrackerDto getTracker()
public void setTracker(TrackerDto tracker)
public java.lang.Integer getTrackerId()
public java.lang.String getFormula()
public void setFormula(java.lang.String formula)
formula
- is the script/code to calculate the field's value, or null if the field is not calculatedpublic TrackerLayoutLabelDto.CompiledFormula getCompiledFormula()
public void setCompiledFormula(TrackerLayoutLabelDto.CompiledFormula compiledFormula)
compiledFormula
- is the compiled script/formula to calculate the field's value, or null if the field is not calculatedpublic boolean isAccessible(TrackerItemDto item, boolean writable)
item
- whose field value access to checkwritable
- true to check write access, false to check read access
public boolean isCompatible(TrackerLayoutLabelDto field)
field
- whose value compatibility to check
public static java.lang.Object getValue(TrackerItemDto item, int fieldId)
item
- whose value to getfieldId
- id of the field whose value to get
public static void setValue(TrackerItemDto item, int fieldId, java.lang.Object value)
item
- where to set the field valuefieldId
- id of the field whose value to setvalue
- to set, or null
java.lang.ClassCastException
- if the value is not compatible to the fieldpublic static java.lang.Comparable decodeString(java.lang.String strval, int valueType) throws java.text.ParseException
strval
- is the String to decodevalueType
- is one of {}
java.text.ParseException
public java.lang.Object getValue(TrackerItemDto item)
item
- where to get the field value from
java.util.ConcurrentModificationException
- if the computed field value is recurrently requested from within the field formula evaluationpublic void setValue(TrackerItemDto item, java.lang.Object value) throws java.text.ParseException
item
- where to set the field valuevalue
- to set, or null
java.text.ParseException
- if value is a String that cannot be decoded into an appropriate field value
java.lang.ClassCastException
- if the value is not compatible to the field
|
CodeBeamer 5.4.0.1-RC API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |