com.versionone.om

Interface ICustomAttributeDictionary

public interface ICustomAttributeDictionary

Provides access to custom fields.

Method Summary

Methods

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

Method Detail

get

Object get(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(String attributeName,
       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(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

Double getNumeric(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

Boolean getBoolean(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

DB.DateTime getDate(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

String getString(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.