com.microsoft.tfs.core.clients.workitem.fields
Interface Field


public interface Field

Represents a field in a WorkItem.

Since:
TEE-SDK-10.1

Method Summary
 void addFieldChangeListener(FieldChangeListener listener)
          Adds a listener for field change events.
 AllowedValuesCollection getAllowedValues()
           
 FieldDefinition getFieldDefinition()
           
 java.lang.String getHelpText()
           
 int getID()
           
 java.lang.String getName()
           
 java.lang.Object getOriginalValue()
           
 ValuesCollection getProhibitedValues()
           
 java.lang.String getReferenceName()
           
 FieldStatus getStatus()
           
 java.lang.Object getValue()
           
 WorkItem getWorkItem()
           
 boolean isDirty()
           
 boolean isEditable()
           
 void overrideStatus(FieldStatus status)
          This method allows custom controls to override the status that was set by the WIT rules engine (e.g.
 void removeFieldChangeListener(FieldChangeListener listener)
          Remvoes a listener for field change events.
 void setValue(java.lang.Object value)
          Sets he value of this field.
 void setValue(java.lang.Object source, java.lang.Object value)
          Sets he value of this field.
 

Method Detail

getName

java.lang.String getName()
Returns:
the name of this field.

getReferenceName

java.lang.String getReferenceName()
Returns:
the reference name of this field.

getID

int getID()
Returns:
the ID of this field.

getValue

java.lang.Object getValue()
Returns:
the current value of this field.

getOriginalValue

java.lang.Object getOriginalValue()
Returns:
the value of this field as it existed when the work item was saved most recently.

setValue

void setValue(java.lang.Object value)
Sets he value of this field.

Parameters:
value - the new value

setValue

void setValue(java.lang.Object source,
              java.lang.Object value)
Sets he value of this field.

Parameters:
source - the object which is the source of this modification (may be null)
value - the new value

isDirty

boolean isDirty()
Returns:
true if this field has unsaved changes, false if it does not

getStatus

FieldStatus getStatus()
Returns:
a description of the current state of this field.

overrideStatus

void overrideStatus(FieldStatus status)
This method allows custom controls to override the status that was set by the WIT rules engine (e.g. to mark a field as invalid). This fires all necessary field changed events. Note that this status can be later changed by the RuleEngine, so it may be necessary for a custom control to listen for field changes and reset the status after the value has changed.

Parameters:
status - FieldStatus value to set (Invalid fields will be highlighted in the Work Item Editor)

isEditable

boolean isEditable()
Returns:
true if this field can be edited in the current state of the work item, false otherwise

getAllowedValues

AllowedValuesCollection getAllowedValues()
Returns:
a collection of values that are valid for this field.

getProhibitedValues

ValuesCollection getProhibitedValues()
Returns:
a collection of values that are not allowed for this field.

getWorkItem

WorkItem getWorkItem()
Returns:
the WorkItem that contains this field.

addFieldChangeListener

void addFieldChangeListener(FieldChangeListener listener)
Adds a listener for field change events.

Parameters:
listener - the listener to add (must not be null)

removeFieldChangeListener

void removeFieldChangeListener(FieldChangeListener listener)
Remvoes a listener for field change events.

Parameters:
listener - the listener to remove (must not be null)

getFieldDefinition

FieldDefinition getFieldDefinition()
Returns:
the FieldDefinition that defines this field.

getHelpText

java.lang.String getHelpText()
Returns:
help text for this field.


© 2015 Microsoft. All rights reserved.