com.starteam
Class TextProperty

java.lang.Object
  com.starteam.Property
      com.starteam.VectorProperty
          com.starteam.TextProperty

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Audit.Type.ClassName1Property, Audit.Type.ClassName2Property, Audit.Type.ClassName3Property, Audit.Type.Descriptor1Property, Audit.Type.Descriptor2Property, Audit.Type.Descriptor3Property, Audit.Type.Info1Property, Audit.Type.Info2Property, Audit.Type.Info3Property, Change.Type.ItemTypeProperty, Change.Type.SourceVersionProperty, Change.Type.TargetVersionProperty, ChangeRequest.Type.CategoryProperty, ChangeRequest.Type.ComponentProperty, ChangeRequest.Type.FixProperty, ChangeRequest.Type.SynopsisProperty, ChangeRequest.Type.TestCommandProperty, ChangeRequest.Type.WorkAroundProperty, File.Type.ArchiveNameProperty, File.Type.ExtensionProperty, File.Type.WorkingFileNameProperty, File.Type.WorkingFilePathProperty, File.Type.WorkingFolderPathProperty, Folder.Type.ExcludeSpecProperty, Folder.Type.WorkingFolderPathProperty, Group.Type.DescriptionProperty, Group.Type.NameProperty, Item.Type.ExternalReferenceProperty, Item.Type.FolderProperty, Item.Type.NewRevisionCommentProperty, Item.Type.TeamProperty, LiveObject.Type.DescriptionProperty, LiveObject.Type.NameProperty, LiveObject.Type.WorkingFolderProperty, Project.Type.GUIDProperty, Project.Type.KeywordFileExtensionsProperty, Requirement.Type.CommentsProperty, Requirement.Type.NotesProperty, Requirement.Type.ResponsibleNamesProperty, Requirement.Type.RevisedDescriptionProperty, Share.Type.ItemRevisionProperty, Share.Type.ProjectNameProperty, Share.Type.ViewPathProperty, Story.Type.AcceptanceCriteriaProperty, Story.Type.NotesProperty, Task.Type.AttentionNotesProperty, Task.Type.DescriptionProperty, Task.Type.GUIDProperty, Task.Type.MSProjectFileNameProperty, Task.Type.NameProperty, Task.Type.NotesProperty, Task.Type.ResourceNamesProperty, Task.Type.WBSCodeProperty, Topic.Type.RecipientNamesProperty, Topic.Type.TitleProperty, TrackedObject.Type.FolderPathProperty, TrackedObject.Type.ParentFolderNameProperty, User.Type.AddressProperty, User.Type.DistinguishedNameProperty, User.Type.EmailAddressProperty, User.Type.FaxProperty, User.Type.LoginNameProperty, User.Type.NameProperty, User.Type.PagerProperty, User.Type.PhoneProperty, User.Type.VoiceMailProperty, VersionedObject.Type.ShortCommentProperty, ViewMember.Type.AttachmentNamesProperty, ViewMember.Type.CommentProperty, ViewMember.Type.DotNotationProperty, ViewMember.Type.ExternalIDProperty, ViewMember.Type.ExternalURLProperty, ViewMember.Type.NonExclusiveLockersProperty, WhiteBoard.Type.ColorProperty, WorkRecord.Type.CommentProperty

public class TextProperty
extends VectorProperty

A base interface for all properties of type Text

Nested Class Summary

static class

TextProperty.WebCacheTextProperty Base accessor for cached SDK objects encapsulating the statefulness of objects obtained from the artifact cache.

Nested classes/interfaces inherited from class com.starteam.VectorProperty

VectorProperty.WebCacheVectorProperty

Nested classes/interfaces inherited from class com.starteam.Property

Property.MetaData, Property.WebCacheProperty

Method Summary

java.lang.String	getDefaultValue() Returns the default String value for this property instance
java.lang.String	getDisplayValue(java.lang.Object value) Converts the given property value to a string suitable for display.
boolean	isQueryRelationSupported(QueryPart.Relation operator) Returns true if this property supports the specified query operator.
boolean	isSortByTextValueSupported() Returns true if this property supports Sort by TextValue for the specified Query Operator
QueryPart	newQueryPart(QueryPart.Relation relation, java.lang.String value) Creates a new query expression that tests this property.
QueryPart	newQueryPart(QueryPart.Relation relation, java.lang.String value, boolean bIgnoreCase) Creates a new query expression that tests this property.
void	setDefaultValue(java.lang.String value) Sets the default String value for this property instance

Methods inherited from class com.starteam.VectorProperty

copy, getAbsoluteMaxLength, getMaxLength, getMinLength, isEqualTo, setMaxLength, setMinLength

Methods inherited from class com.starteam.Property

areValuesEqual, equals, getDebugString, getDependentProperties, getDisplayName, getDisplayNameTranslations, getGenericDefaultValue, getID, getName, getServer, getType, hashCode, isAdvanced, isCalculated, isClientCalculated, isDescriptor, isDirty, isDisabled, isEnabled, isGenericCalculated, isHeader, isItemProperty, isLegalValue, isNew, isPrimaryDescriptor, isRequired, isRestricted, isRevisionIndependent, isServerCalculated, isStored, isSysDefined, isUserCustomized, isUserDefined, isUserModifiable, isViewSpecific, resolveAllDependencies, setDescriptor, setDisplayName, setDisplayNameTranslations, setEnabled, setGenericDefaultValue, setPrimaryDescriptor, setRequired, toString, toXml, update

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDefaultValue

public java.lang.String getDefaultValue()

Returns the default String value for this property instance

Returns:

String

setDefaultValue

public void setDefaultValue(java.lang.String value)

Sets the default String value for this property instance

Parameters:

value - String

newQueryPart

public QueryPart newQueryPart(QueryPart.Relation relation,
                              java.lang.String value)

Creates a new query expression that tests this property.

Parameters:

relation - The query relation.

value - The string value to be tested.

Returns:

A new query expression.

newQueryPart

public QueryPart newQueryPart(QueryPart.Relation relation,
                              java.lang.String value,
                              boolean bIgnoreCase)

Creates a new query expression that tests this property.

Parameters:

relation - The query relation.

value - The string value to be tested.

bIgnoreCase - true if case is ignored during comparison.

Returns:

A new query expression.

isQueryRelationSupported

public boolean isQueryRelationSupported(QueryPart.Relation operator)

Returns true if this property supports the specified query operator.

Overrides:

isQueryRelationSupported in class Property

Parameters:

operator - int

Returns:

boolean

isSortByTextValueSupported

public boolean isSortByTextValueSupported()

Returns true if this property supports Sort by TextValue for the specified Query Operator

Overrides:

isSortByTextValueSupported in class Property

Returns:

boolean

getDisplayValue

public java.lang.String getDisplayValue(java.lang.Object value)

Converts the given property value to a string suitable for display.

Specified by:

getDisplayValue in class Property

Parameters:

value - A legal value for this property.

Returns:

A string representation of the value