com.starteam
Class IntegerProperty

java.lang.Object
  com.starteam.Property
      com.starteam.ScalarProperty
          com.starteam.IntegerProperty

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Audit.Type.ClassID1Property, Audit.Type.ClassID2Property, Audit.Type.ClassID3Property, Audit.Type.FolderIDProperty, Audit.Type.ObjectID1Property, Audit.Type.ObjectID2Property, Audit.Type.ObjectID3Property, Change.Type.FlagsProperty, ChangeRequest.Type.ChangeNumberProperty, Concept.Type.ConceptIDProperty, File.Type.ContentVersionProperty, File.Type.HiveProperty, File.Type.SyncBranchVersionProperty, File.Type.SyncContentVersionProperty, File.Type.SyncViewVersionProperty, File.Type.VaultVersionProperty, File.Type.ViewVersionProperty, Group.Type.PrivilegeMaskProperty, Group.Type.TenantProperty, Item.Type.NotificationCountProperty, Label.Type.MemberIDProperty, LiveObject.Type.FlagsProperty, Project.Type.CanCreateCheckinChangePackageProperty, Project.Type.CompactionProperty, Project.Type.MailProperty, Project.Type.TenantProperty, PromotionModel.Type.NumberOfStatesProperty, Requirement.Type.AmbiguitiesCountProperty, Requirement.Type.ChildrenCountProperty, Requirement.Type.ChildTypeProperty, Requirement.Type.ExpectedEffortProperty, Requirement.Type.HighEffortProperty, Requirement.Type.LowEffortProperty, Requirement.Type.ParentRequirementIDProperty, Requirement.Type.RequirementNumberProperty, Requirement.Type.ResponsibleCountProperty, Share.Type.FolderIDProperty, Share.Type.ItemIDProperty, Share.Type.NumberOfDerivedSharesProperty, Share.Type.ObjectIDProperty, Sprint.Type.SprintIDProperty, Story.Type.StoryIDProperty, Task.Type.ChildrenCountProperty, Task.Type.EstimatedFinishVarianceProperty, Task.Type.EstimatedStartVarianceProperty, Task.Type.IsReplicatedProperty, Task.Type.NumberProperty, Task.Type.ParentTaskIDProperty, Task.Type.PercentCompleteProperty, Task.Type.ResourceCountProperty, Task.Type.UniqueIDProperty, Task.Type.WorkRecordCountProperty, TaskDependency.Type.LagTimeProperty, TaskDependency.Type.PredecessorProperty, TaskDependency.Type.TaskProperty, Topic.Type.ChildrenCountProperty, Topic.Type.ParentTopicIDProperty, Topic.Type.RecipientCountProperty, Topic.Type.TopicNumberProperty, TrackedObject.Type.TransactionIDProperty, TreeItem.Type.ParentIDProperty, TypedResource.Type.IDProperty, User.Type.AccessRestrictionProperty, User.Type.LicenseProperty, User.Type.TenantProperty, VersionedObject.Type.CommentIDProperty, VersionedObject.Type.RevisionFlagsProperty, VersionedObject.Type.RevisionNumberProperty, View.Type.BaseConfigurationTypeProperty, View.Type.RootFolderIDProperty, View.Type.ShareFlagsProperty, View.Type.TenantProperty, ViewMember.Type.AttachmentCountProperty, ViewMember.Type.ParentBranchLengthProperty, ViewMember.Type.ParentBranchRevisionProperty, ViewMember.Type.ParentObjectIDProperty, ViewMember.Type.RootObjectIDProperty, ViewMember.Type.ViewMemberIDProperty, ViewMemberRevision.Type.ObjectIDProperty, ViewMemberRevision.Type.ParentFolderProperty, ViewMemberRevision.Type.ParentShareProperty, WhiteBoard.Type.WhiteBoardIDProperty, WorkRecord.Type.ParentTaskProperty

public class IntegerProperty
extends ScalarProperty

This class represents a property whose value is an Integer.

Nested Class Summary

static class

IntegerProperty.WebCacheIntegerProperty Base accessor for cached SDK objects encapsulating the statefulness of objects obtained from the artifact cache.

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

ScalarProperty.WebCacheScalarProperty

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

Property.MetaData, Property.WebCacheProperty

Field Summary

static int	MAX_VALUE The integer value constant 2147483647
static int	MIN_VALUE The integer value constant -2147483648

Method Summary

int	getDefaultValue() Returns the default integer value for this Property
java.lang.String	getDisplayValue(java.lang.Object value) Converts the given property value to a string suitable for display.
java.lang.Object	getGenericMaxValue() Gets the maximum allowable value of this property.
java.lang.Object	getGenericMinValue() Gets the minimum allowable value of this property.
int	getMaxValue() Returns the maximum integer value for this Property or MAX_VALUE if none has been specified
int	getMinValue() Returns the minimum integer value for this Property or MIN_VALUE if none has been specified
boolean	isRollupProperty() Returns true if this Integer Property is a rollup property The value of this property on a parent tree item would be the summation of the values of all its children This feature was introduced in the 14.0 server
QueryPart	newQueryPart(QueryPart.Relation relation, int value) Creates a new query expression that tests this property.
void	setDefaultValue(int value) Sets the default integer value for this Property
void	setMaxValue(int value) Sets the maximum integer value for this Property
void	setMinValue(int value) Sets the minimum integer value for this Property
void	setRollupProperty(boolean enable) set this property to be a rollup property

Methods inherited from class com.starteam.ScalarProperty

setGenericMaxValue, setGenericMinValue

Methods inherited from class com.starteam.Property

areValuesEqual, copy, equals, getDebugString, getDependentProperties, getDisplayName, getDisplayNameTranslations, getGenericDefaultValue, getID, getName, getServer, getType, hashCode, isAdvanced, isCalculated, isClientCalculated, isDescriptor, isDirty, isDisabled, isEnabled, isEqualTo, isGenericCalculated, isHeader, isItemProperty, isLegalValue, isNew, isPrimaryDescriptor, isQueryRelationSupported, isRequired, isRestricted, isRevisionIndependent, isServerCalculated, isSortByTextValueSupported, 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

Field Detail

MIN_VALUE

public static final int MIN_VALUE

The integer value constant -2147483648

See Also:

Constant Field Values

MAX_VALUE

public static final int MAX_VALUE

The integer value constant 2147483647

See Also:

Constant Field Values

Method Detail

getDefaultValue

public int getDefaultValue()

Returns the default integer value for this Property

Returns:

int the default integer value

setDefaultValue

public void setDefaultValue(int value)

Sets the default integer value for this Property

Parameters:

value - int the default integer value

getMinValue

public int getMinValue()

Returns the minimum integer value for this Property or MIN_VALUE if none has been specified

Returns:

int the minimum integer value for this Property

setMinValue

public void setMinValue(int value)

Sets the minimum integer value for this Property

Parameters:

value - int the minimum integer value for this Property

getMaxValue

public int getMaxValue()

Returns the maximum integer value for this Property or MAX_VALUE if none has been specified

Returns:

int the maximum integer value

isRollupProperty

public boolean isRollupProperty()

Returns true if this Integer Property is a rollup property The value of this property on a parent tree item would be the summation of the values of all its children This feature was introduced in the 14.0 server

Returns:

true if this Integer Property can be rolled up

setRollupProperty

public void setRollupProperty(boolean enable)

set this property to be a rollup property

Parameters:

enable - true to set this property to be a rollup property

setMaxValue

public void setMaxValue(int value)

Sets the maximum integer value for this Property

Parameters:

value - int the maximum integer value for this Property

getGenericMinValue

public java.lang.Object getGenericMinValue()

Gets the minimum allowable value of this property.

Overrides:

getGenericMinValue in class ScalarProperty

Returns:

The minimum allowable value of this property.

See Also:

IntegerProperty.getMinValue(), DoubleProperty.getMinValue(), DateProperty.getMinValue(), DateTimeProperty.getMinValue(), LongIntegerProperty.getMinValue(), TimeSpanProperty.getMinValue()

getGenericMaxValue

public java.lang.Object getGenericMaxValue()

Gets the maximum allowable value of this property.

Overrides:

getGenericMaxValue in class ScalarProperty

Returns:

The maximum allowable value of this property.

See Also:

IntegerProperty.getMaxValue(), DoubleProperty.getMaxValue(), DateProperty.getMaxValue(), DateTimeProperty.getMaxValue(), LongIntegerProperty.getMaxValue(), TimeSpanProperty.getMaxValue()

newQueryPart

public QueryPart newQueryPart(QueryPart.Relation relation,
                              int value)

Creates a new query expression that tests this property.

Parameters:

relation - The query relation.

value - The value to be tested.

Returns:

A new query expression.

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