com.starteam
Class BooleanProperty

java.lang.Object
  com.starteam.Property
      com.starteam.EnumeratedProperty
          com.starteam.BooleanProperty

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

File.Type.IsExecutableProperty, File.Type.IsSyncInRevisionHistoryProperty, File.Type.IsSyncKnownProperty, File.Type.IsWorkingFileAvailableProperty, File.Type.IsWorkingFileExecutableProperty, Project.Type.ForceCheckinReasonProperty, Project.Type.IsProcessItemRequiredProperty, Project.Type.MarkUnlockedFilesReadOnlyProperty, Project.Type.RequireLockForCheckinProperty, Project.Type.UseKeywordsProperty, Requirement.Type.AmIResponsibleProperty, Requirement.Type.IsDisabledProperty, Task.Type.BlockedProperty, Task.Type.IsMyTaskProperty, Task.Type.MilestoneProperty, Task.Type.NeedsAttentionProperty, Topic.Type.AmIRecipientProperty, Trace.Type.IsSuspectProperty, User.Type.IsDirectoryManagedProperty, View.Type.IsDeleteCompleteProperty, View.Type.IsPurgedProperty, ViewMember.Type.IsBookmarkedProperty, ViewMember.Type.IsBranchOnChangeProperty, ViewMember.Type.IsReadOnlyProperty, ViewMember.Type.IsUnreadProperty, ViewMemberRevision.Type.BranchFlagProperty

public class BooleanProperty
extends EnumeratedProperty

A Boolean property is a Property whose value may be either True or False

Nested Class Summary

static class

BooleanProperty.WebCacheBooleanProperty Base accessor for cached SDK objects encapsulating the statefulness of objects obtained from the artifact cache.

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

EnumeratedProperty.WebCacheEnumeratedProperty

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

Property.MetaData, Property.WebCacheProperty

Field Summary

static java.lang.String	FALSE_INTERNAL_NAME The internal name used for the "false" EnumeratedValue.
static java.lang.String	TRUE_INTERNAL_NAME The internal name used for the "true" EnumeratedValue.

Fields inherited from class com.starteam.EnumeratedProperty

VALUE_NOT_SET

Method Summary

EnumeratedValue	findValue(int enumCode) Finds an existing EnumeratedValue by code.
boolean	getDefaultValue() Gets the default value of this property, as a boolean value.
EnumeratedValue	getFalseValue() Gets the enumerated value that is used to represent false
EnumeratedValue	getTrueValue() Gets the enumerated value that is used as the preferred true value for new object revisions.
QueryPart	newQueryPart(boolean value) Constructs a query expression that tests a boolean property value.
void	setDefaultValue(boolean flag) Sets the default value of this property, as a boolean value.
void	setFalseValue(EnumeratedValue falseValue) Sets the enumerated value that is used to represent false The EnumeratedValue parameter instance must belong to the set of EnumeratedValue's of this BooleanProperty instance
void	setTrueValue(EnumeratedValue trueValue) Sets the enumerated value that is used as the preferred true value for new object revisions.

Methods inherited from class com.starteam.EnumeratedProperty

copy, createValue, findValue, getAllValues, getDefaultValues, getDisplayValue, getEnumDisplayName, getSortedValues, getValues, isEqualTo, isHierarchicalEnumeration, isMultiSelectable, isQueryRelationSupported, isStatusProperty, newQueryPart, newQueryPart, newQueryPart, setDefaultValues, setStatusProperty, setValues, toBooleanProperty, update

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

FALSE_INTERNAL_NAME

public static final java.lang.String FALSE_INTERNAL_NAME

The internal name used for the "false" EnumeratedValue.

See Also:

EnumeratedValue.getInternalName(), BooleanProperty.getFalseValue(), Constant Field Values

TRUE_INTERNAL_NAME

public static final java.lang.String TRUE_INTERNAL_NAME

The internal name used for the "true" EnumeratedValue.

See Also:

EnumeratedValue.getInternalName(), BooleanProperty.getTrueValue(), Constant Field Values

Method Detail

getFalseValue

public EnumeratedValue getFalseValue()

Gets the enumerated value that is used to represent false

Returns:

EnumeratedValue

setFalseValue

public void setFalseValue(EnumeratedValue falseValue)

Sets the enumerated value that is used to represent false The EnumeratedValue parameter instance must belong to the set of EnumeratedValue's of this BooleanProperty instance

Parameters:

falseValue - EnumeratedValue

getTrueValue

public EnumeratedValue getTrueValue()

Gets the enumerated value that is used as the preferred true value for new object revisions.

Returns:

EnumeratedValue

setTrueValue

public void setTrueValue(EnumeratedValue trueValue)

Sets the enumerated value that is used as the preferred true value for new object revisions. The EnumeratedValue parameter instance must belong to the set of EnumeratedValue's of this BooleanProperty instance

Parameters:

trueValue - EnumeratedValue

newQueryPart

public QueryPart newQueryPart(boolean value)

Constructs a query expression that tests a boolean property value.

Parameters:

value - false to construct a query expression that returns true when tested against the current false value of this property; true to construct a query expression that returns true when tested against any value other than the current false value of this property.

Returns:

The new query expression.

getDefaultValue

public boolean getDefaultValue()

Gets the default value of this property, as a boolean value.

Returns:

The default value of this property, as a boolean value.

setDefaultValue

public void setDefaultValue(boolean flag)

Sets the default value of this property, as a boolean value.

Parameters:

flag - The default value of this property, as a boolean value.

findValue

public EnumeratedValue findValue(int enumCode)

Finds an existing EnumeratedValue by code. Returns either a True Value or a false value but never null

Overrides:

findValue in class EnumeratedProperty

Parameters:

enumCode - the code

Returns:

a True Value or a false value but never null