com.crystaldecisions.sdk.properties
Interface IProperty

public interface IProperty

The IProperty interface is used to retrieve information about a specific property from the Properties collection. This property may be "normal," or it may be a container (For example, a property bag). The isContainer() method can be used to distinguish between normal properties and property bags. If a property is a property bag, the Properties property can be used to retrieve a list of properties that it contains.

Field Summary

static int	ALL
static int	BAG This constant specifies that the property is really a property bag.
static int	BINARY This constant specifies that the property's value is a binary stream.
static int	DELETE This constant specifies that the client wants this property removed.
static int	DIRTY This constant specifies that the property value has changed.
static int	NO_COPY This constant specifies that the property shouldn't be copied during an object copy operation.
static int	PROP_ID_LIST This constant specifies that the property is a list of ids generated by a relation.
static int	READ_ONLY This constant specifies that the property is read only.

Method Summary

int	getFlags() Returns the flags or settings applied to a property.
java.lang.Integer	getID() Returns the ID of the property.
java.lang.Object	getValue() Returns the value of the property.
boolean	isContainer() Returns true if this property contains other properties.
void	setValue(java.lang.Object PropertyValue) Sets the value of the property.

Field Detail

READ_ONLY

static final int READ_ONLY

This constant specifies that the property is read only. It can be updated but cannot be deleted.

DIRTY

static final int DIRTY

This constant specifies that the property value has changed. This is flag marks the property as dirty.

BAG

static final int BAG

This constant specifies that the property is really a property bag.

DELETE

static final int DELETE

This constant specifies that the client wants this property removed.

NO_COPY

static final int NO_COPY

This constant specifies that the property shouldn't be copied during an object copy operation.

BINARY

static final int BINARY

This constant specifies that the property's value is a binary stream.

PROP_ID_LIST

static final int PROP_ID_LIST

This constant specifies that the property is a list of ids generated by a relation.

Note:Map these properties to CUIDs when exporting.

ALL

static final int ALL

Method Detail

getFlags

int getFlags()

Returns the flags or settings applied to a property.

Returns:

An int specifying the flag or settings applied to a property.

getID

java.lang.Integer getID()

Returns the ID of the property.

Returns:

An Integer containing the ID of the property.

getValue

java.lang.Object getValue()

Returns the value of the property.

Returns:

An Object containing the value of the property. The type that this object can be cast as depends on the property. For example, for properties that specify a boolean value, a Boolean object will be returned. To quickly view the value of the Object, the toString() method can be used.

isContainer

boolean isContainer()

Returns true if this property contains other properties.

Returns:

true if this property contains other properties, false otherwise.

setValue

void setValue(java.lang.Object PropertyValue)

Sets the value of the property.

Parameters:

PropertyValue - An Object containing the value of the property.