com.starteam
Class TimeSpanProperty

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

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Task.Type.ActualHoursProperty, Task.Type.DurationProperty, Task.Type.EstimatedHoursProperty, User.Type.TimeZoneShiftProperty, WorkRecord.Type.TimeRemainingProperty, WorkRecord.Type.TimeWorkedProperty

public class TimeSpanProperty
extends ScalarProperty

Description: Represents a TimeSpan Property

Nested Class Summary

static class

TimeSpanProperty.WebCacheTimeSpanProperty 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 java.lang.String	DEFAULT_TIMESPAN_DISPLAYFORMAT
static TimeSpan	DEFAULT_TIMESPAN_UNITS
static TimeSpan	MAX_VALUE
static TimeSpan	MIN_VALUE
static TimeSpan	ZERO

Method Summary

TimeSpan	getDefaultValue() Returns the default TimeSpan value for this Property
java.lang.String	getDisplayFormat() returns the DisplayFormat for this TimeSpan 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.
TimeSpan	getMaxValue() Returns the maximum TimeSpan value for this Property or MAX_VALUE if none has been specified
TimeSpan	getMinValue() Returns the minimum TimeSpan value for this Property or MIN_VALUE if none has been specified
TimeSpan	getUnits() returns the unit of measurement for this TimeSpan property
QueryPart	newQueryPart(QueryPart.Relation relation, TimeSpan value) Creates a new query expression that tests this property.
void	setDefaultValue(TimeSpan value) Sets the default TimeSpan value for this Property
void	setDisplayFormat(java.lang.String format) sets the DisplayFormat for this TimeSpan property
void	setMaxValue(TimeSpan value) Sets the maximum TimeSpan value for this Property
void	setMinValue(TimeSpan value) Sets the minimum TimeSpan value for this Property
void	setUnits(TimeSpan units) sets the unit of measurement for this TimeSpan 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

ZERO

public static final TimeSpan ZERO

MIN_VALUE

public static final TimeSpan MIN_VALUE

MAX_VALUE

public static final TimeSpan MAX_VALUE

DEFAULT_TIMESPAN_UNITS

public static final TimeSpan DEFAULT_TIMESPAN_UNITS

DEFAULT_TIMESPAN_DISPLAYFORMAT

public static final java.lang.String DEFAULT_TIMESPAN_DISPLAYFORMAT

See Also:

Constant Field Values

Method Detail

getDefaultValue

public TimeSpan getDefaultValue()

Returns the default TimeSpan value for this Property

Returns:

TimeSpan

setDefaultValue

public void setDefaultValue(TimeSpan value)

Sets the default TimeSpan value for this Property

Parameters:

value - TimeSpan

getMinValue

public TimeSpan getMinValue()

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

Returns:

TimeSpan

setMinValue

public void setMinValue(TimeSpan value)

Sets the minimum TimeSpan value for this Property

Parameters:

value - TimeSpan

getMaxValue

public TimeSpan getMaxValue()

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

Returns:

TimeSpan

setMaxValue

public void setMaxValue(TimeSpan value)

Sets the maximum TimeSpan value for this Property

Parameters:

value - TimeSpan

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()

getUnits

public TimeSpan getUnits()

returns the unit of measurement for this TimeSpan property

Returns:

TimeSpan

setUnits

public void setUnits(TimeSpan units)

sets the unit of measurement for this TimeSpan property

Parameters:

units - TimeSpan

getDisplayFormat

public java.lang.String getDisplayFormat()

returns the DisplayFormat for this TimeSpan property

Returns:

String

setDisplayFormat

public void setDisplayFormat(java.lang.String format)

sets the DisplayFormat for this TimeSpan property

Parameters:

format - String

newQueryPart

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

Creates a new query expression that tests this property.

Parameters:

relation - The query relation.

value - The TimeSpan 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