IPropertyContext

IPropertyContext is an abstract superclass that contains methods that get and set properties. These methods are inherited by other classes.

Inheritance hierarchy:

None

Methods

Summary of methods:

Method	Description
GetBooleanProperty	Get the value of the boolean property with the specified name.
GetByteProperty	Get the value of the byte property identified by name.
GetBytesProperty	Get the value of the byte array property identified by name.
GetCharProperty	Get the value of the 2-byte character property identified by name.
GetDoubleProperty	Get the value of the double precision floating point property identified by name.
GetFloatProperty	Get the value of the floating point property identified by name.
GetIntProperty	Get the value of the integer property identified by name.
GetLongProperty	Get the value of the long integer property identified by name.
GetObjectProperty	Get the value and data type of the property identified by name.
GetShortProperty	Get the value of the short integer property identified by name.
GetStringProperty	Get the value of the string property identified by name.
SetBooleanProperty	Set the value of the boolean property identified by name.
SetByteProperty	Set the value of the byte property identified by name.
SetBytesProperty	Set the value of the byte array property identified by name.
SetCharProperty	Set the value of the 2-byte character property identified by name.
SetDoubleProperty	Set the value of the double precision floating point property identified by name.
SetFloatProperty	Set the value of the floating point property identified by name.
SetIntProperty	Set the value of the integer property identified by name.
SetLongProperty	Set the value of the long integer property identified by name.
SetObjectProperty	Set the value and data type of a property identified by name.
SetShortProperty	Set the value of the short integer property identified by name.
SetStringProperty	Set the value of the string property identified by name.

GetBooleanProperty - Get Boolean Property

Interface:

Boolean GetBooleanProperty(String property_name);

Get the value of the boolean property with the specified name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

The value of the property.

Thread context:

Determined by the subclass

Exceptions:

• XMSException

GetByteProperty - Get Byte Property

Interface:

Byte    GetByteProperty(String property_name) ;
Int16   GetSignedByteProperty(String property_name) ;

Get the value of the byte property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

The value of the property.

Thread context:

Determined by the subclass

Exceptions:

• XMSException

GetBytesProperty - Get Byte Array Property

Interface:

Byte[]  GetBytesProperty(String property_name) ;

Get the value of the byte array property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

The number of bytes in the array.

Thread context:

Determined by the subclass

Exceptions:

• XMSException

GetCharProperty - Get Character Property

Interface:

Char    GetCharProperty(String property_name) ;

Get the value of the 2-byte character property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

The value of the property.

Thread context:

Determined by the subclass

Exceptions:

• XMSException

GetDoubleProperty - Get Double Precision Floating Point Property

Interface:

Double  GetDoubleProperty(String property_name) ;

Get the value of the double precision floating point property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

The value of the property.

Thread context:

Determined by the subclass

Exceptions:

• XMSException

GetFloatProperty - Get Floating Point Property

Interface:

Single  GetFloatProperty(String property_name) ;

Get the value of the floating point property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

The value of the property.

Thread context:

Determined by the subclass

Exceptions:

• XMSException

GetIntProperty - GetIntProperty

Interface:

Int32   GetIntProperty(String property_name) ;

Get the value of the integer property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

The value of the property.

Thread context:

Determined by the subclass

Exceptions:

• XMSException

GetLongProperty - Get Long Integer Property

Interface:

Int64   GetLongProperty(String property_name) ;

Get the value of the long integer property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

The value of the property.

Thread context:

Determined by the subclass

Exceptions:

• XMSException

GetObjectProperty - Get Object Property

Interface:

Object  GetObjectProperty( String property_name) ;

Get the value and data type of the property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

The value of the property, which is one of the following object types:

• Boolean
• Byte
• Byte[]
• Char
• Double
• Single
• Int32
• Int64
• Int16
• String

Thread context:

Determined by the subclass

Exceptions:

• XMSException

GetShortProperty - Get Short Integer Property

Interface:

Int16   GetShortProperty(String property_name) ;

Get the value of the short integer property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

The value of the property.

Thread context:

Determined by the subclass

Exceptions:

• XMSException

GetStringProperty - GetStringProperty

Interface:

String  GetStringProperty(String property_name) ;

Get the value of the string property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

Returns:

A String object encapsulating the string that is the value of the property. If data conversion is required, this value is the string after conversion.

Thread context:

Determined by the subclass

Exceptions:

• XMSException

SetBooleanProperty - Set Boolean Property

Interface:

void SetBooleanProperty( String property_name,  Boolean value) ;

Set the value of the boolean property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

value (input)

The value of the property.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException

SetByteProperty - Set Byte Property

Interface:

void SetByteProperty( String property_name,  Byte value) ;
      void SetSignedByteProperty( String property_name,  Int16 value) ;

Set the value of the byte property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

value (input)

The value of the property.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException

SetBytesProperty - Set Byte Array Property

Interface:

void SetBytesProperty( String property_name, Byte[] value ) ;

Set the value of the byte array property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

value (input)

The value of the property, which is an array of bytes.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException

SetCharProperty - Set Character Property

Interface:

void SetCharProperty( String property_name,  Char value) ;

Set the value of the 2-byte character property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

value (input)

The value of the property.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException

SetDoubleProperty - Set Double Precision Floating Point Property

Interface:

void SetDoubleProperty( String property_name,  Double value) ;

Set the value of the double precision floating point property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

value (input)

The value of the property.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException

SetFloatProperty - Set Floating Point Property

Interface:

void SetFloatProperty( String property_name,  Single value) ;

Set the value of the floating point property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

value (input)

The value of the property.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException

SetIntProperty - Set Integer Property

Interface:

void SetIntProperty( String property_name,  Int32 value) ;

Set the value of the integer property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

value (input)

The value of the property.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException

SetLongProperty - Set Long Integer Property

Interface:

void SetLongProperty( String property_name,  Int64 value) ;

Set the value of the long integer property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

value (input)

The value of the property.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException

SetObjectProperty - Set Object Property

Interface:

void SetObjectProperty( String property_name,  Object value) ;

Set the value and data type of a property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

objectType (input)

The value of the property, which must be one of the following object types:

• Boolean
• Byte
• Byte[]
• Char
• Double
• Single
• Int32
• Int64
• Int16
• String

value (input)

The value of the property as an array of bytes.

length (input)

The number of bytes in the array.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException

SetShortProperty - Set Short Integer Property

Interface:

void SetShortProperty( String property_name,  Int16 value) ;

Set the value of the short integer property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

value (input)

The value of the property.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException

SetStringProperty - Set String Property

Interface:

void SetStringProperty( String property_name,  String value);

Set the value of the string property identified by name.

Parameters:

property_name (input)

A String object encapsulating the name of the property.

value (input)

A String object encapsulating the string that is the value of the property.

Returns:

Void

Thread context:

Determined by the subclass

Exceptions:

• XMSException
• MessageNotWritableException