com.versionone.om
Interface ICustomAttributeDictionary

public interface ICustomAttributeDictionary

Provides access to custom fields.

Method Summary

boolean	containsKey(java.lang.String attributeName) Indicates the presence of a custom field.
java.lang.Object	get(java.lang.String attributeName) Get the value of the custom field.
java.lang.Boolean	getBoolean(java.lang.String attributeName) Gets the value of a Custom Field as a nullable boolean.
DateTime	getDate(java.lang.String attributeName) Gets the value of a Custom Field as a DateTime.
java.lang.Double	getNumeric(java.lang.String attributeName) Gets the value of a Custom Field as a numeric.
java.lang.String	getString(java.lang.String attributeName) Gets the value of a Custom Field as a string.
void	set(java.lang.String attributeName, java.lang.Object attributevalue) Sets the value of the custom field.

Method Detail

get

java.lang.Object get(java.lang.String attributeName)

Get the value of the custom field.

Parameters:

attributeName - The friendly name of the custom field, e.g. "Origin", not "Custom_Origin".

Returns:

custom attribute value.

set

void set(java.lang.String attributeName,
         java.lang.Object attributevalue)

Sets the value of the custom field.

Parameters:

attributeName - The friendly name of the custom field, e.g. "Origin", not "Custom_Origin".

attributevalue - custom attribute value.

containsKey

boolean containsKey(java.lang.String attributeName)

Indicates the presence of a custom field.

Parameters:

attributeName - The friendly name of the custom field, e.g. "Origin", not "Custom_Origin".

Returns:

True if the field exists.

getNumeric

java.lang.Double getNumeric(java.lang.String attributeName)

Gets the value of a Custom Field as a numeric.

Parameters:

attributeName - The friendly name of the custom field, e.g. "Origin", not "Custom_Origin".

Returns:

The value of the field as a double, or null.

getBoolean

java.lang.Boolean getBoolean(java.lang.String attributeName)

Gets the value of a Custom Field as a nullable boolean.

Parameters:

attributeName - The friendly name of the custom field, e.g. "Origin", not "Custom_Origin".

Returns:

The value of the field as a boolean, or null.

getDate

DateTime getDate(java.lang.String attributeName)

Gets the value of a Custom Field as a DateTime.

Parameters:

attributeName - The friendly name of the custom field, e.g. "Origin", not "Custom_Origin".

Returns:

The value of the field as a DateTime, or null.

getString

java.lang.String getString(java.lang.String attributeName)

Gets the value of a Custom Field as a string.

Parameters:

attributeName - The friendly name of the custom field, e.g. "Origin", not "Custom_Origin".

Returns:

The value of the field as a string, or null.