com.starteam
Class ObjectProperty

java.lang.Object
  com.starteam.Property
      com.starteam.ObjectProperty

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Audit.Type.UserProperty, Change.Type.ChangePackageProperty, ChangePackage.Type.CommittedByProperty, ChangePackage.Type.CommittedInBuildProperty, ChangePackage.Type.PostCommitRevisionLabelProperty, ChangePackage.Type.PostCommitViewLabelProperty, ChangePackage.Type.PreCommitRevisionLabelProperty, ChangePackage.Type.PreCommitViewLabelProperty, ChangePackage.Type.ProcessItemProperty, ChangePackage.Type.SourceViewProperty, ChangePackage.Type.TargetViewProperty, ChangeRequest.Type.AddressedByProperty, ChangeRequest.Type.AddressedInProperty, ChangeRequest.Type.AddressedInViewProperty, ChangeRequest.Type.EnteredByProperty, ChangeRequest.Type.LastBuildTestedProperty, Folder.Type.ProjectProperty, Group.Type.ParentProperty, LiveObject.Type.CreatedByProperty, LiveObject.Type.DeletedByProperty, Project.Type.DefaultViewProperty, PromotionState.Type.LabelProperty, Requirement.Type.OwnerProperty, Share.Type.ProjectProperty, Share.Type.ViewProperty, Sprint.Type.OwnerProperty, Story.Type.SponsorProperty, Story.Type.SprintProperty, Task.Type.ResponsibilityProperty, Task.Type.StoryProperty, TrackedObject.Type.ModifiedByProperty, TypedResource.Type.ProjectProperty, TypedResource.Type.ViewProperty, View.Type.ParentViewProperty, View.Type.PromotionStateProperty, View.Type.ResolvedViewProperty, ViewMember.Type.ExclusiveLockerProperty, ViewMember.Type.ItemDeletedByProperty, ViewMember.Type.ResponsibilityProperty, ViewMemberRevision.Type.CreatedByProperty, WorkRecord.Type.PerformedByProperty

public class ObjectProperty
extends Property

This class represents a property whose value is an Object.

Nested Class Summary

static class

ObjectProperty.WebCacheObjectProperty Base accessor for cached SDK objects encapsulating the statefulness of objects obtained from the artifact cache.

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

Property.MetaData, Property.WebCacheProperty

Field Summary

static int

VALUE_NOT_SET VALUE_NOT_SET

Method Summary

int	getDefaultValue() Returns the default object-id (integer) value for this Property instance
java.lang.String	getDisplayValue(java.lang.Object value) Converts the given property value to a string suitable for display.
Type	getTypeOfValue() Gets the Type object representing the type of a property value.
boolean	isQueryRelationSupported(QueryPart.Relation operator) Returns true if this property supports the given query operator(s)
QueryPart	newQueryPart(QueryPart.Relation relation, int objectID) Creates a new query expression that tests this property.
void	setDefaultValue(int value) Sets the default object-id (integer) value for this Property instance

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 int VALUE_NOT_SET

VALUE_NOT_SET

See Also:

Constant Field Values

Method Detail

isQueryRelationSupported

public boolean isQueryRelationSupported(QueryPart.Relation operator)

Returns true if this property supports the given query operator(s)

Overrides:

isQueryRelationSupported in class Property

Parameters:

operator - a Query relation

Returns:

boolean true if this property supports the given query operator

getDefaultValue

public int getDefaultValue()

Returns the default object-id (integer) value for this Property instance

Returns:

int

setDefaultValue

public void setDefaultValue(int value)

Sets the default object-id (integer) value for this Property instance

Parameters:

value - int

getTypeOfValue

public Type getTypeOfValue()

Gets the Type object representing the type of a property value.

Returns:

Type the Type object representing the type of a property value.

newQueryPart

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

Creates a new query expression that tests this property.

Parameters:

relation - The query relation.

objectID - The object ID 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