com.starteam
Class DateTimeProperty

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

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Audit.Type.RevisionTime1Property, Audit.Type.RevisionTime2Property, Audit.Type.RevisionTime3Property, ChangePackage.Type.CommittedTimeProperty, ChangeRequest.Type.ClosedOnProperty, ChangeRequest.Type.EnteredOnProperty, ChangeRequest.Type.ResolvedOnProperty, ChangeRequest.Type.VerifiedOnProperty, File.Type.ContentModifiedTimeProperty, File.Type.SyncModifiedTimeProperty, File.Type.WorkingFileModifiedTimeProperty, Label.Type.LabelTimeProperty, LiveObject.Type.CreatedTimeProperty, LiveObject.Type.DeletedTimeProperty, Task.Type.ConstraintDateProperty, Task.Type.MSProjectLastUpdateProperty, Task.Type.WorkDependencyLastUpdateProperty, TrackedObject.Type.EndModifiedTimeProperty, TrackedObject.Type.ModifiedTimeProperty, User.Type.FridayAMProperty, User.Type.FridayPMProperty, User.Type.LastPasswordChangeTimeProperty, User.Type.LastWebLogoutTimeProperty, User.Type.LockOutTimeProperty, User.Type.MondayAMProperty, User.Type.MondayPMProperty, User.Type.SaturdayAMProperty, User.Type.SaturdayPMProperty, User.Type.SundayAMProperty, User.Type.SundayPMProperty, User.Type.ThursdayAMProperty, User.Type.ThursdayPMProperty, User.Type.TuesdayAMProperty, User.Type.TuesdayPMProperty, User.Type.WednesdayAMProperty, User.Type.WednesdayPMProperty, View.Type.BaseConfigurationDataProperty, View.Type.EndDateProperty, View.Type.StartDateProperty, ViewMember.Type.ConfigurationTimeProperty, ViewMember.Type.ItemDeletedTimeProperty, ViewMemberRevision.Type.CreatedTimeProperty, ViewMemberRevision.Type.ObjectTimeProperty

public class DateTimeProperty
extends ScalarProperty

This class represents a property whose value is a DateTime.

Nested Class Summary

static class

DateTimeProperty.WebCacheDateTimeProperty 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 DateTime	MAX_VALUE The maxnimum supported value of the DateTime class
static DateTime	MIN_VALUE The minimum supported value of the DateTime class
static DateTime	VALUE_NOT_SET When used as the value of a DateTimeProperty, indicates that the value has not been set.

Method Summary

DateTime	getDefaultValue() Returns the default DateTime 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.
DateTime	getMaxValue() Returns the maximum DateTime value for this Property or MAX_VALUE if none has been specified
DateTime	getMinValue() Returns the minimum DateTime value for this Property or MIN_VALUE if none has been specified
boolean	isQueryRelationSupported(QueryPart.Relation operator) Returns true if this property supports the specified query operator
QueryPart	newQueryPart(QueryPart.Relation relation, DateTime value) Creates a new query expression that tests this property against a DateTime value.
QueryPart	newQueryPart(QueryPart.Relation relation, TimeSpan value) Creates a new query expression that tests this property against a DateTime value.
void	setDefaultValue(DateTime value) Sets the default DateTime value for this Property
void	setMaxValue(DateTime value) Sets the minimum DateTime value for this Property
void	setMinValue(DateTime value) Sets the minimum DateTime value for this 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, 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

VALUE_NOT_SET

public static final DateTime VALUE_NOT_SET

When used as the value of a DateTimeProperty, indicates that the value has not been set.

MIN_VALUE

public static final DateTime MIN_VALUE

The minimum supported value of the DateTime class

MAX_VALUE

public static final DateTime MAX_VALUE

The maxnimum supported value of the DateTime class

Method Detail

getDefaultValue

public DateTime getDefaultValue()

Returns the default DateTime value for this Property

Returns:

the default DateTime value for this Property

setDefaultValue

public void setDefaultValue(DateTime value)

Sets the default DateTime value for this Property

Parameters:

value - the default DateTime value for this Property

getMinValue

public DateTime getMinValue()

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

Returns:

the minimum DateTime value for this Property

setMinValue

public void setMinValue(DateTime value)

Sets the minimum DateTime value for this Property

Parameters:

value - the minimum DateTime value for this Property

getMaxValue

public DateTime getMaxValue()

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

Returns:

the maximum DateTime value for this Property

setMaxValue

public void setMaxValue(DateTime value)

Sets the minimum DateTime value for this Property

Parameters:

value - the minimum DateTime 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()

isQueryRelationSupported

public boolean isQueryRelationSupported(QueryPart.Relation operator)

Returns true if this property supports the specified query operator

Overrides:

isQueryRelationSupported in class Property

Parameters:

operator - the query operator

Returns:

true if this property supports the specified query operator

newQueryPart

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

Creates a new query expression that tests this property against a DateTime value.

Parameters:

relation - The query relation.

value - The DateTime value to be tested.

Returns:

A new query expression.

See Also:

QueryPart.Relation.LESS_THAN, QueryPart.Relation.LESS_THAN_OR_EQUAL_TO, QueryPart.Relation.EQUAL_TO, QueryPart.Relation.GREATER_THAN_OR_EQUAL_TO, QueryPart.Relation.GREATER_THAN, QueryPart.Relation.NOT_EQUAL_TO

newQueryPart

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

Creates a new query expression that tests this property against a DateTime value.

Parameters:

relation - The query relation.

value - The TimeSpan value to be tested.

Returns:

A new query expression.

See Also:

QueryPart.Relation.DATE_WITHIN_LAST_DAYS, QueryPart.Relation.DATE_WITHIN_LAST_WEEKS, QueryPart.Relation.DATE_OLDER_THAN_DAYS, QueryPart.Relation.DATE_OLDER_THAN_WEEKS

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