oracle.tip.callout
Interface CalloutContext

public interface CalloutContext

The CalloutContext interface contains methods for accessing callout and usage properties using a key and also methods for obtaining all callout / usage properties in a Map. This interface will be used to access the properties from a callout. Note: callout properties are defined at registration time and usage propreties are defined at modeling time.

Field Summary

static int	BOOLEAN_VALUE
static int	FLOAT_VALUE
static int	INTEGER_VALUE
static int	STRING_VALUE Define some constants for the various primitive types of data

Method Summary

java.util.Map	getAllProperties() getAllProperties() returns a Map containing all properties
java.lang.Boolean	getBooleanProperty(java.lang.String key) getBooleanProperty() returns a Boolean object property with the specified key
java.util.Map	getCalloutProperties() getCalloutProperties() returns a Map containing all callout properties
java.lang.Float	getFloatProperty(java.lang.String key) getFloatProperty() returns a Float object property with the specified key
java.lang.Integer	getIntegerProperty(java.lang.String key) getIntegerProperty() returns an Integer object property with the specified key
int	getPropertyType(java.lang.String key) getPropertyType() returns the type of the property with the specified key
java.lang.String	getStringProperty(java.lang.String key) getStringProperty() returns a String object property with the specified key
java.util.Map	getUsageProperties() getUsageProperties() returns a Map containing all usage properties
boolean	isCalloutProperty(java.lang.String key) isCalloutProperty() returns a boolean if the property for the specified key is a callout property

Field Detail

STRING_VALUE

public static final int STRING_VALUE

Define some constants for the various primitive types of data

See Also:

Constant Field Values

BOOLEAN_VALUE

public static final int BOOLEAN_VALUE

See Also:

Constant Field Values

INTEGER_VALUE

public static final int INTEGER_VALUE

See Also:

Constant Field Values

FLOAT_VALUE

public static final int FLOAT_VALUE

See Also:

Constant Field Values

Method Detail

isCalloutProperty

public boolean isCalloutProperty(java.lang.String key)
                          throws CalloutDomainException

isCalloutProperty() returns a boolean if the property for the specified key is a callout property

Returns:

boolean - true if it is a callout property

Throws:

CalloutDomainException - - when no property with that key exists

getPropertyType

public int getPropertyType(java.lang.String key)
                    throws CalloutDomainException

getPropertyType() returns the type of the property with the specified key

Returns:

int - the type of the callout property (STRING_VALUE, INTEGER_VALUE etc.)

Throws:

CalloutDomainException - - when no property with that key exists

getStringProperty

public java.lang.String getStringProperty(java.lang.String key)
                                   throws CalloutDomainException

getStringProperty() returns a String object property with the specified key

Returns:

String - the value of the property

Throws:

CalloutDomainException - - when no property with that key exists or a format error occurs

getBooleanProperty

public java.lang.Boolean getBooleanProperty(java.lang.String key)
                                     throws CalloutDomainException

getBooleanProperty() returns a Boolean object property with the specified key

Returns:

Boolean - the value of the property

Throws:

CalloutDomainException - - when no property with that key exists or a format error occurs

getIntegerProperty

public java.lang.Integer getIntegerProperty(java.lang.String key)
                                     throws CalloutDomainException

getIntegerProperty() returns an Integer object property with the specified key

Returns:

Integer - the value of the property

Throws:

CalloutDomainException - - when no property with that key exists or a format error occurs

getFloatProperty

public java.lang.Float getFloatProperty(java.lang.String key)
                                 throws CalloutDomainException

getFloatProperty() returns a Float object property with the specified key

Returns:

Float - the value of the property

Throws:

CalloutDomainException - - when no property with that key exists or a format error occurs

getCalloutProperties

public java.util.Map getCalloutProperties()

getCalloutProperties() returns a Map containing all callout properties

Returns:

Map - containing all callout properties

getUsageProperties

public java.util.Map getUsageProperties()

getUsageProperties() returns a Map containing all usage properties

Returns:

Map - containing all callout properties

getAllProperties

public java.util.Map getAllProperties()

getAllProperties() returns a Map containing all properties

Returns:

Map - containing all callout properties