FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoPropertyValueConstraintRange Class Reference

#include <PropertyValueConstraintRange.h>

Inherits FdoPropertyValueConstraint.

Inheritance diagram for FdoPropertyValueConstraintRange:

[legend]
List of all members.

Detailed Description

FdoPropertyValueConstraintRange is used to specify minimum and / or maximum allowed values for a particular property. It can be used for all data property types except for Boolean, BLOB, or CLOB. One or the other or both of MinValue and MaxValue must be specified. If both are specified, then MaxValue must be greater than or equal to MinValue and if either MinInclusive or MaxInclusive are false, then MaxValue must be greater than MinValue. MinValue and MaxValue if specified must be valid values for the property type. E.g. if the property is decimal(4,0), then the maximum possible MaxValue is 9999. If the data property definition includes a non-null default value, then this constraint is applied to that value as well. If the data property definition allows nulls, a null value is considered as being valid regardless of the range constraint.

Definition at line 38 of file PropertyValueConstraintRange.h.


Public Member Functions

virtual bool Contains (FdoDataValue *pValue)
virtual bool Contains (FdoPropertyValueConstraint *pConstraint)
virtual bool Equals (FdoPropertyValueConstraint *pConstraint)
virtual FDO_API FdoPropertyValueConstraintType GetConstraintType ()
 Returns FdoPropertyValueConstraintType_Range type.
FDO_API bool GetMaxInclusive ()
 Returns a bool to indicate if the maximum value is inclusive or exclusive. This is the difference between <= and <. This is a boolean type where true means inclusive.
FDO_API FdoDataValueGetMaxValue ()
 Get the maximum allowed value. The type of this is the same as the type of the property. E.g. if the property is int32, then this value is int32.
FDO_API bool GetMinInclusive ()
 Returns a bool to indicate if the minimum value is inclusive or exclusive. This is the difference between >= and >. This is a boolean type where true means inclusive.
FDO_API FdoDataValueGetMinValue ()
 Get the minimum allowed value. The type of this is the same as the type of the property. E.g. if the property is int32, then this value is int32.
virtual void Set (FdoPropertyValueConstraint *pProperty, FdoString *parentName, FdoSchemaMergeContext *pContext)
 Update this range constraint from the given value constraint.
FDO_API void SetMaxInclusive (bool value)
 Returns a bool to indicate if the maximum value is inclusive or exclusive. This is the difference between <= and <. This is a boolean type where true means inclusive.
FDO_API void SetMaxValue (FdoDataValue *value)
 Set the maximum allowed value.
FDO_API void SetMinInclusive (bool value)
 Set the minimum value to inclusive or exclusive. This is the difference between >= and >.
FDO_API void SetMinValue (FdoDataValue *value)
 Set the minimum allowed value.

Static Public Member Functions

FDO_API FdoPropertyValueConstraintRangeCreate (FdoDataValue *minValue, FdoDataValue *maxValue)
 Constructs and populates an instance of an FdoPropertyValueConstraintRange.
FDO_API FdoPropertyValueConstraintRangeCreate ()
 Constructs an empty instance of an FdoPropertyValueConstraintRange.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoPropertyValueConstraintRange (FdoDataValue *minValue, FdoDataValue *maxValue)
 FdoPropertyValueConstraintRange ()
 Constructs a default instance of a FdoPropertyValueConstraintRange.
virtual ~FdoPropertyValueConstraintRange ()

Constructor & Destructor Documentation

FdoPropertyValueConstraintRange::FdoPropertyValueConstraintRange  )  [protected]
 

Constructs a default instance of a FdoPropertyValueConstraintRange.

FdoPropertyValueConstraintRange::FdoPropertyValueConstraintRange FdoDataValue minValue,
FdoDataValue maxValue
[protected]
 

Constructs an instance of a FdoPropertyValueConstraintRange using the specified arguments.

virtual FdoPropertyValueConstraintRange::~FdoPropertyValueConstraintRange  )  [protected, virtual]
 


Member Function Documentation

virtual bool FdoPropertyValueConstraintRange::Contains FdoDataValue pValue  )  [virtual]
 

Implements FdoPropertyValueConstraint.

virtual bool FdoPropertyValueConstraintRange::Contains FdoPropertyValueConstraint pConstraint  )  [virtual]
 

Implements FdoPropertyValueConstraint.

FDO_API FdoPropertyValueConstraintRange* FdoPropertyValueConstraintRange::Create FdoDataValue minValue,
FdoDataValue maxValue
[static]
 

Constructs and populates an instance of an FdoPropertyValueConstraintRange.

Parameters:
minValue Minimum allowed value
maxValue Maximum allowed value
Returns:
Returns an FdoPropertyValueConstraintRange

FDO_API FdoPropertyValueConstraintRange* FdoPropertyValueConstraintRange::Create  )  [static]
 

Constructs an empty instance of an FdoPropertyValueConstraintRange.

Returns:
Returns an FdoPropertyValueConstraintRange

virtual void FdoPropertyValueConstraintRange::Dispose  )  [inline, protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

Definition at line 50 of file PropertyValueConstraintRange.h.

virtual bool FdoPropertyValueConstraintRange::Equals FdoPropertyValueConstraint pConstraint  )  [virtual]
 

Implements FdoPropertyValueConstraint.

virtual FDO_API FdoPropertyValueConstraintType FdoPropertyValueConstraintRange::GetConstraintType  )  [virtual]
 

Returns FdoPropertyValueConstraintType_Range type.

Returns:
Returns the constraint type

Implements FdoPropertyValueConstraint.

FDO_API bool FdoPropertyValueConstraintRange::GetMaxInclusive  ) 
 

Returns a bool to indicate if the maximum value is inclusive or exclusive. This is the difference between <= and <. This is a boolean type where true means inclusive.

Returns:
Returns true if the value is inclusive. false otherwise

FDO_API FdoDataValue* FdoPropertyValueConstraintRange::GetMaxValue  ) 
 

Get the maximum allowed value. The type of this is the same as the type of the property. E.g. if the property is int32, then this value is int32.

Returns:
Returns the maximum value

FDO_API bool FdoPropertyValueConstraintRange::GetMinInclusive  ) 
 

Returns a bool to indicate if the minimum value is inclusive or exclusive. This is the difference between >= and >. This is a boolean type where true means inclusive.

Returns:
Returns true if the value is inclusive. false otherwise

FDO_API FdoDataValue* FdoPropertyValueConstraintRange::GetMinValue  ) 
 

Get the minimum allowed value. The type of this is the same as the type of the property. E.g. if the property is int32, then this value is int32.

Returns:
Returns the minimum value

virtual void FdoPropertyValueConstraintRange::Set FdoPropertyValueConstraint pProperty,
FdoString parentName,
FdoSchemaMergeContext pContext
[virtual]
 

Update this range constraint from the given value constraint.

Reimplemented from FdoPropertyValueConstraint.

FDO_API void FdoPropertyValueConstraintRange::SetMaxInclusive bool  value  ) 
 

Returns a bool to indicate if the maximum value is inclusive or exclusive. This is the difference between <= and <. This is a boolean type where true means inclusive.

Returns:
Returns true if the value is inclusive. false otherwise

FDO_API void FdoPropertyValueConstraintRange::SetMaxValue FdoDataValue value  ) 
 

Set the maximum allowed value.

Parameters:
value Maximum allowed value
Returns:
Returns nothing

FDO_API void FdoPropertyValueConstraintRange::SetMinInclusive bool  value  ) 
 

Set the minimum value to inclusive or exclusive. This is the difference between >= and >.

Parameters:
value This is a boolean type where true means inclusive.
Returns:
Returns nothing

FDO_API void FdoPropertyValueConstraintRange::SetMinValue FdoDataValue value  ) 
 

Set the minimum allowed value.

Parameters:
value Minimum allowed value
Returns:
Returns nothing

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.