CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class LinkedLayoutLabelDto

java.lang.Object
  extended by com.intland.codebeamer.persistence.dto.base.IdentifiableDto
      extended by com.intland.codebeamer.persistence.dto.TrackerLayoutLabelDto
          extended by com.intland.codebeamer.persistence.dto.ReadOnlyLayoutLabelDto
              extended by com.intland.codebeamer.persistence.dto.LinkedLayoutLabelDto
All Implemented Interfaces:
BaseDto, ReadOnlyDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class LinkedLayoutLabelDto
extends ReadOnlyLayoutLabelDto

A special read-only TrackerLayoutLabelDto that is linked to a template label

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.TrackerLayoutLabelDto
TrackerLayoutLabelDto.CompiledFormula, TrackerLayoutLabelDto.OffsetComparator
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
IdentifiableDto.IdComparator
 
Field Summary
static java.lang.Integer NULL_ASSOC
          The special value to allow overriding template assoc type ids to null
static java.lang.Integer NULL_RULE
          The special value to allow overriding hierarchy rule ids to null
static java.lang.String NULL_VALUE
          The special value "null" to allow overriding template default values to null
 
Fields inherited from class com.intland.codebeamer.persistence.dto.TrackerLayoutLabelDto
ASSIGNED_AT_LABEL_ID, ASSIGNED_TO_LABEL_ID, BOOLEAN, CATEGORY_LABEL_ID, CHILDREN_LABEL_ID, CLOSED_AT_LABEL_ID, DATE, DECIMAL, DEFAULT_DATE_FORMAT, DEFAULT_DATETIME_FORMAT, DEPENDENCY_LABEL_ID, DESCRIPTION_LABEL_ID, END_DATE_LABEL_ID, ESTIMATED_H_LABEL_ID, ID_LABEL_ID, INTEGER, MILESTONES_LABEL_ID, MODIFIED_AT_LABEL_ID, MODIFIED_BY_LABEL_ID, NAME_LABEL_ID, OP_SYS_LABEL_ID, PARENT_LABEL_ID, PLATFORM_LABEL_ID, PRINCIPAL, PRIORITY_LABEL_ID, PROJECT_NAME_LABEL_ID, REFERERS_LABEL_ID, RESOLUTION_LABEL_ID, SEVERITY_LABEL_ID, SPENT_ESTIMATED_H_LABEL_ID, SPENT_H_LABEL_ID, START_DATE_LABEL_ID, STATUS_LABEL_ID, SUBMITTED_AT_LABEL_ID, SUBMITTED_BY_LABEL_ID, SUPERVISOR_LABEL_ID, TEXT, TRACKER_KEY_NAME_LABEL_ID, TYPE_LABEL_ID, VERSION_LABEL_ID
 
Constructor Summary
LinkedLayoutLabelDto(TrackerLayoutLabelDto field, TrackerLayoutLabelDto template)
          Create a read-only version of the specified TrackerLayoutLabelDto that is linked to the specified template LabelDto
 
Method Summary
 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()
           
 java.lang.Integer getCols()
           
 java.lang.Integer getColspan()
           
 TrackerLayoutLabelDto.CompiledFormula getCompiledFormula()
          Get the compiled script/formula to calculate the field's value
 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
 java.lang.Integer getId()
          Returns its unique identifier.
 java.lang.String getLabel()
           
 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.Boolean getRequired()
           
 java.lang.Integer getRoleId()
           
 java.lang.Integer getRows()
           
 java.lang.Number getSelectionSize()
           
 java.lang.Integer getStatusId()
           
 TrackerLayoutLabelDto getTemplate()
           
 java.lang.String getTitle()
          Get the column title for this field.
 TrackerDto getTracker()
           
 java.lang.Integer getValueType()
           
 java.lang.Boolean getVisible()
          Check if this field should be shown in the item details/editor screen
protected  java.lang.Object writeReplace()
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.ReadOnlyLayoutLabelDto
clone, setAggregationRuleId, setAssocTypeId, setBreakRow, setCols, setColspan, setCompiledFormula, setDefaultValue, setDistributionRuleId, setEditable, setFormula, setId, setInputType, setLabel, setListable, setMaxValue, setMinValue, setMultipleSelection, setOffset, setRequired, setRoleId, setRows, setSelectionSize, setStatusId, setTitle, setTracker, setValueType, setVisible
 
Methods inherited from class com.intland.codebeamer.persistence.dto.TrackerLayoutLabelDto
decodeString, equals, getChoiceFieldId, getChoiceFieldIndex, getCustomFieldId, getCustomFieldIndex, getGMTDateTimeFormat, getHeaderStyleClass, getInputType, getLabelWithoutBR, getProperty, getSortProperty, getStyleClass, getTrackerId, getValue, getValue, getValueClass, isAccessible, isBooleanField, isChoiceField, isChoiceField, isCompatible, isDynamicChoice, isEditableAtAll, isForeignKey, isForeignKey, isMemberChoice, isReferenceFieldConfigurationAllowed, isUserDefined, isUserDefined, isUserReferenceField, isUserReferenceField, setValue, setValue, toString
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
compare, compareInteger, compareTo, equals, hashCode, hashCode
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NULL_VALUE

public static final java.lang.String NULL_VALUE
The special value "null" to allow overriding template default values to null

See Also:
Constant Field Values

NULL_RULE

public static final java.lang.Integer NULL_RULE
The special value to allow overriding hierarchy rule ids to null


NULL_ASSOC

public static final java.lang.Integer NULL_ASSOC
The special value to allow overriding template assoc type ids to null

Constructor Detail

LinkedLayoutLabelDto

public LinkedLayoutLabelDto(TrackerLayoutLabelDto field,
                            TrackerLayoutLabelDto template)
Create a read-only version of the specified TrackerLayoutLabelDto that is linked to the specified template LabelDto

Parameters:
field - contains override definitions of the field
template - to get missing definitions from
Method Detail

getTemplate

public TrackerLayoutLabelDto getTemplate()

writeReplace

protected java.lang.Object writeReplace()

getTracker

public TrackerDto getTracker()
Overrides:
getTracker in class TrackerLayoutLabelDto

getId

public java.lang.Integer getId()
Description copied from class: IdentifiableDto
Returns its unique identifier.

Overrides:
getId in class IdentifiableDto

getOffset

public java.lang.Integer getOffset()
Overrides:
getOffset in class TrackerLayoutLabelDto

getLabel

public java.lang.String getLabel()
Overrides:
getLabel in class TrackerLayoutLabelDto

getListable

public java.lang.Boolean getListable()
Description copied from class: TrackerLayoutLabelDto
Check if this field should also be shown as a column in item lists/tables

Overrides:
getListable in class TrackerLayoutLabelDto
Returns:
whether this field should also be shown as a column in item lists/tables, or null (use visible setting)

getTitle

public java.lang.String getTitle()
Description copied from class: TrackerLayoutLabelDto
Get the column title for this field. The title (if set) is a shorter form of the label to be used as column header.

Overrides:
getTitle in class TrackerLayoutLabelDto
Returns:
the title (short label) for this field

getAggregationRuleId

public java.lang.Integer getAggregationRuleId()
Description copied from class: TrackerLayoutLabelDto
Get the ID of the rule, how to aggregate child field values to parent field values

Overrides:
getAggregationRuleId in class TrackerLayoutLabelDto
Returns:
the ID of the rule, how to aggregate child field values to parent field values, or null (no aggregation)

getDistributionRuleId

public java.lang.Integer getDistributionRuleId()
Description copied from class: TrackerLayoutLabelDto
Get the ID of the rule, how to distribute parent field values down the hierarchy

Overrides:
getDistributionRuleId in class TrackerLayoutLabelDto
Returns:
the ID of the rule, how to distribute parent field values down the hierarchy, or null (no distribution)

getAssocTypeId

public java.lang.Integer getAssocTypeId()
Overrides:
getAssocTypeId in class TrackerLayoutLabelDto

getMultipleSelection

public java.lang.Boolean getMultipleSelection()
Overrides:
getMultipleSelection in class TrackerLayoutLabelDto

getSelectionSize

public java.lang.Number getSelectionSize()
Overrides:
getSelectionSize in class TrackerLayoutLabelDto

getRows

public java.lang.Integer getRows()
Overrides:
getRows in class TrackerLayoutLabelDto

getCols

public java.lang.Integer getCols()
Overrides:
getCols in class TrackerLayoutLabelDto

getColspan

public java.lang.Integer getColspan()
Overrides:
getColspan in class TrackerLayoutLabelDto

getBreakRow

public java.lang.Boolean getBreakRow()
Overrides:
getBreakRow in class TrackerLayoutLabelDto

getValueType

public java.lang.Integer getValueType()
Overrides:
getValueType in class TrackerLayoutLabelDto

getFormula

public java.lang.String getFormula()
Description copied from class: TrackerLayoutLabelDto
Get the script/formula code to calculate the field's value

Overrides:
getFormula in class TrackerLayoutLabelDto
Returns:
the script/formula code to calculate the field's value, or null if the field is not calculated

getCompiledFormula

public TrackerLayoutLabelDto.CompiledFormula getCompiledFormula()
Description copied from class: TrackerLayoutLabelDto
Get the compiled script/formula to calculate the field's value

Overrides:
getCompiledFormula in class TrackerLayoutLabelDto
Returns:
the compiled script/formula to calculate the field's value, or null if the field is not calculated

getMaxValue

public java.lang.String getMaxValue()
Overrides:
getMaxValue in class TrackerLayoutLabelDto

getMinValue

public java.lang.String getMinValue()
Overrides:
getMinValue in class TrackerLayoutLabelDto

getDefaultValue

public java.lang.String getDefaultValue()
Overrides:
getDefaultValue in class TrackerLayoutLabelDto

getRequired

public java.lang.Boolean getRequired()
Overrides:
getRequired in class TrackerLayoutLabelDto

getStatusId

public java.lang.Integer getStatusId()
Overrides:
getStatusId in class TrackerLayoutLabelDto

getRoleId

public java.lang.Integer getRoleId()
Overrides:
getRoleId in class TrackerLayoutLabelDto

getVisible

public java.lang.Boolean getVisible()
Description copied from class: TrackerLayoutLabelDto
Check if this field should be shown in the item details/editor screen

Overrides:
getVisible in class TrackerLayoutLabelDto
Returns:
whether this field should be shown in the item details/editor screen

getEditable

public java.lang.Boolean getEditable()
Overrides:
getEditable in class TrackerLayoutLabelDto

CodeBeamer 5.4.0.1-RC API

Copyright © 2006-2009 Intland Software. All rights reserved.