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

All Superinterfaces:
java.lang.Comparable

public interface FieldDefinition
extends java.lang.Comparable

Represents the attributes of a Field.

Since:
TEE-SDK-10.1

Method Summary
 AllowedValuesCollection getAllowedValues()
           
 FieldType getFieldType()
           
 int getID()
           
 java.lang.String getName()
           
 java.lang.String getReferenceName()
           
 java.lang.Class getSystemType()
           
 FieldUsages getUsage()
           
 boolean isComputed()
           
 boolean isIndexed()
           
 boolean isLongText()
           
 boolean isQueryable()
           
 boolean isSortable()
           
 boolean supportsTextQuery()
           
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getName

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

getReferenceName

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

getID

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

getFieldType

FieldType getFieldType()
Returns:
the data type that is stored by a Field that uses this field definition.

isQueryable

boolean isQueryable()
Returns:
true if work items can be queried by a Field that uses this field definition, false otherwise.

isSortable

boolean isSortable()
Returns:
true if WorkItems can be sorted by Fields that use this field definition.

getAllowedValues

AllowedValuesCollection getAllowedValues()
Returns:
the collection of valid values for a Field that uses this field definition.

isComputed

boolean isComputed()
Returns:
true if the value of the Field that uses this field definition is computed.

getSystemType

java.lang.Class getSystemType()
Returns:
the underlying Class which implements this field definition.

isIndexed

boolean isIndexed()
Returns:
true if a Field that uses this field definition is indexed on the server.

isLongText

boolean isLongText()
Returns:
true if a Field that uses this field definition is a long text field type.

supportsTextQuery

boolean supportsTextQuery()
Returns:
true if a Field that uses this field definition supports text queries.

getUsage

FieldUsages getUsage()
Returns:
the intended usage of this field definition.


© 2015 Microsoft. All rights reserved.