com.starteam
Class ObjectArrayProperty

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

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Item.Type.NotificationIDsProperty, Project.Type.DefaultTypesProperty, PromotionModel.Type.PromotionStatesProperty, Requirement.Type.ResponsibleUsersProperty, Requirement.Type.ReviewedByProperty, Sprint.Type.TargetReleasesProperty, Story.Type.TargetReleasesProperty, Task.Type.ResourcesProperty, Topic.Type.RecipientsProperty, User.Type.FavoriteProjectsProperty, ViewMember.Type.AttachmentIDsProperty, ViewMember.Type.FlaggedByUsersProperty, ViewMember.Type.UnreadByUsersProperty

public class ObjectArrayProperty
extends VectorProperty

This class represents a property whose value is an Object Array. Custom Object Array Properties can be created starting from Server Release 12.0 However, they are restricted to User and Group Arrays

Nested Class Summary

static class

ObjectArrayProperty.WebCacheObjectArrayProperty 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

int[]	getDefaultValue() returns the default 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	getTypeOfMembers() Gets the type of member object referenced by this property value.
boolean	isQueryRelationSupported(QueryPart.Relation operator) Returns true if this property supports the specified query operator(s)
QueryPart	newQueryPart(QueryPart.Relation relation, int[] value) Creates a new query expression that tests this property.
void	setDefaultValue(int[] value) sets the default 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, 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

Method Detail

getDefaultValue

public int[] getDefaultValue()

returns the default value for this property instance

Returns:

int[]

setDefaultValue

public void setDefaultValue(int[] value)

sets the default value for this property instance

Parameters:

value - int[]

isQueryRelationSupported

public boolean isQueryRelationSupported(QueryPart.Relation operator)

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

Overrides:

isQueryRelationSupported in class Property

Parameters:

operator - Query Relation

Returns:

true if the query relation is supported by this property

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.

getTypeOfMembers

public Type getTypeOfMembers()

Gets the type of member object referenced by this property value.

Returns:

The type of member object referenced by this property value, or null if there is no explicit type (as is the case for ATTACHMENT_IDS).

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