com.sap.caf.eu.gp.structure.api

Interface IGPAttributeInfo

public interface IGPAttributeInfo

Describes an attribute in the structures in the technical input or output parameters of a callable object. The attribute cardinality is described by the following constants:

• MULITIPLICITY_0_1 - not required, non-list attribute
• MULITIPLICITY_1_1 - required, non-list attribute
• MULITIPLICITY_0_N - can be empty, list attribute
• MULITIPLICITY_1_N - not-empty, list attribute

The attribute is identified by its technical name and namespace, which is optional. The localized name can be defined for the attribute by the public void setNameKey(String nameKey) method. The attribute uses the resource accessor defined for the technical description.

Field Summary

static int	BASE_BASE64BINARY Represents java byte array(byte[]).
static int	BASE_BOOLEAN Represents java boolean values(boolean).
static int	BASE_DATE Represents java Date values(Date).
static int	BASE_DATETIME Equivalent to BASE_DATE
static int	BASE_DECIMAL Represents java BigDecimal values(BigDecimal).
static int	BASE_DOUBLE Represents java double values(double).
static int	BASE_FLOAT Represents java float values(float).
static int	BASE_SIGNED_BYTE Represents java byte values(byte).
static int	BASE_SIGNED_INT Represents java int values(int).
static int	BASE_SIGNED_LONG Represents java long values(long).
static int	BASE_SIGNED_SHORT Represents java short values(short).
static int	BASE_STRING Represents java string values(string).
static int	BASE_TIME Equivalent to BASE_DATE
static int	BASE_UNSIGNED_BYTE E1uivalent to BASE_SIGNED_SHORT
static int	BASE_UNSIGNED_INT Equivalent to BASE_SIGNED_LONG
static int	BASE_UNSIGNED_LONG Represents java BigInteger values(BigInteger).
static int	BASE_UNSIGNED_SHORT Equivalent to BASE_SIGNED_INT
static int	MULITIPLICITY_0_1 Defines non-list, not required attribute cardinality
static int	MULITIPLICITY_0_N Defines list, not required attribute cardinality
static int	MULITIPLICITY_1_1 Defines non-list, required attribute cardinality
static int	MULITIPLICITY_1_N Defines list, non-empty attribute cardinality

Method Summary

IGPLabel	getLabel() Return the labe identifying this attribute
int	getMultiplicity() Returns the cardinality of the attribute
String	getNamespace() Returns the attribute namespace
IGPStructureInfo	getStructureInfo() Returns the structure definiition of the containing structure
String	getTechName() Return the technical name of the attribute
int	getType() Returns the type of the attribute.
String	resolveText(Locale locale) Resolves the language dependent text for the description.
void	setMultiplicity(int multiplicity) Sets the cardinality of the attribute
void	setNameKey(String nameKey) Sets the key for the localized name of the attribute
void	setType(int type) Sets the type of the attribute
String	toString() Overriden default-method.

Field Detail

BASE_BASE64BINARY

static final int BASE_BASE64BINARY

Represents java byte array(byte[]). The following IGPStructure.getAttributeAs* methods may be invoked when the attribute is of this type:

• getAttributeAsByteArray
• getAttributeAsString

The following IGPStructure.setAttributeValue methods may be invoked when the attribute is of this type:

• setAttributeValue(... byte[] value)

See Also:

Constant Field Values

BASE_BOOLEAN

static final int BASE_BOOLEAN

Represents java boolean values(boolean). The following IGPStructure.getAttributeAs* methods may be invoked when the attribute is of this type:

• getAttributeAsBoolean
• getAttributeAsString

The following IGPStructure.setAttributeValue methods may be invoked when the attribute is of this type:

• setAttributeValue(... boolean value)

See Also:

Constant Field Values

BASE_DATE

static final int BASE_DATE

Represents java Date values(Date). The following IGPStructure.getAttributeAs* methods may be invoked when the attribute is of this type:

• getAttributeAsDate
• getAttributeAsString

The following IGPStructure.setAttributeValue methods may be invoked when the attribute is of this type:

• setAttributeValue(... Date value)
• setAttributeValue(... String value) value must be string representation of a date

See Also:

Constant Field Values

BASE_DATETIME

static final int BASE_DATETIME

Equivalent to BASE_DATE

See Also:

BASE_DATE, Constant Field Values

BASE_DECIMAL

static final int BASE_DECIMAL

Represents java BigDecimal values(BigDecimal). The following IGPStructure.getAttributeAs* methods may be invoked when the attribute is of this type:

• getAttributeAsBigDecimal
• getAttributeAsBigInteger
• getAttributeAsByte
• getAttributeAsShort
• getAttributeAsInt
• getAttributeAsLong
• getAttributeAsDouble
• getAttributeAsString

The following IGPStructure.setAttributeValue methods may be invoked when the attribute is of this type:

• setAttributeValue(... BigDecimal value)
• setAttributeValue(... BigInteger value)
• setAttributeValue(... byte value)
• setAttributeValue(... short value)
• setAttributeValue(... int value)
• setAttributeValue(... long value)
• setAttributeValue(... double value)
• setAttributeValue(... String value)

See Also:

Constant Field Values

BASE_DOUBLE

static final int BASE_DOUBLE

Represents java double values(double). The get/set methods that can be used with this type are as for BASE_DECIMAL

See Also:

BASE_DECIMAL, Constant Field Values

BASE_FLOAT

static final int BASE_FLOAT

Represents java float values(float). The get/set methods that can be used with this type are as for BASE_DECIMAL

See Also:

BASE_DECIMAL, Constant Field Values

BASE_SIGNED_BYTE

static final int BASE_SIGNED_BYTE

Represents java byte values(byte). The get/set methods that can be used with this type are as for BASE_DECIMAL

See Also:

BASE_DECIMAL, Constant Field Values

BASE_SIGNED_INT

static final int BASE_SIGNED_INT

Represents java int values(int). The get/set methods that can be used with this type are as for BASE_DECIMAL

See Also:

BASE_DECIMAL, Constant Field Values

BASE_SIGNED_LONG

static final int BASE_SIGNED_LONG

Represents java long values(long). The get/set methods that can be used with this type are as for BASE_DECIMAL

See Also:

BASE_DECIMAL, Constant Field Values

BASE_SIGNED_SHORT

static final int BASE_SIGNED_SHORT

Represents java short values(short). The get/set methods that can be used with this type are as for BASE_DECIMAL

See Also:

BASE_DECIMAL, Constant Field Values

BASE_STRING

static final int BASE_STRING

Represents java string values(string). The following IGPStructure.getAttributeAs* methods may be invoked when the attribute is of this type:

• getAttributeAsString
• getAttributeAsDate
• getAttributeAsBoolean
• getAttributeAsBigDecimal
• getAttributeAsBigInteger
• getAttributeAsByte
• getAttributeAsShort
• getAttributeAsInt
• getAttributeAsLong
• getAttributeAsDouble

The following IGPStructure.setAttributeValue methods may be invoked when the attribute is of this type:

• setAttributeValue(... String value)
• setAttributeValue(... Date value)
• setAttributeValue(... boolean value)
• setAttributeValue(... BigDecimal value)
• setAttributeValue(... BigInteger value)
• setAttributeValue(... byte value)
• setAttributeValue(... short value)
• setAttributeValue(... int value)
• setAttributeValue(... long value)
• setAttributeValue(... double value)

See Also:

Constant Field Values

BASE_TIME

static final int BASE_TIME

Equivalent to BASE_DATE

See Also:

BASE_DATE, Constant Field Values

BASE_UNSIGNED_BYTE

static final int BASE_UNSIGNED_BYTE

E1uivalent to BASE_SIGNED_SHORT

See Also:

BASE_SIGNED_SHORT, Constant Field Values

BASE_UNSIGNED_INT

static final int BASE_UNSIGNED_INT

Equivalent to BASE_SIGNED_LONG

See Also:

BASE_SIGNED_LONG, Constant Field Values

BASE_UNSIGNED_LONG

static final int BASE_UNSIGNED_LONG

Represents java BigInteger values(BigInteger). The get/set methods that can be used with this type are as for BASE_DECIMAL

See Also:

BASE_DECIMAL, Constant Field Values

BASE_UNSIGNED_SHORT

static final int BASE_UNSIGNED_SHORT

Equivalent to BASE_SIGNED_INT

See Also:

BASE_SIGNED_INT, Constant Field Values

MULITIPLICITY_0_1

static final int MULITIPLICITY_0_1

Defines non-list, not required attribute cardinality

See Also:

Constant Field Values

MULITIPLICITY_1_1

static final int MULITIPLICITY_1_1

Defines non-list, required attribute cardinality

See Also:

Constant Field Values

MULITIPLICITY_0_N

static final int MULITIPLICITY_0_N

Defines list, not required attribute cardinality

See Also:

Constant Field Values

MULITIPLICITY_1_N

static final int MULITIPLICITY_1_N

Defines list, non-empty attribute cardinality

See Also:

Constant Field Values

Method Detail

getTechName

String getTechName()

Return the technical name of the attribute

Returns:

the technical name of the attribute

getType

int getType()

Returns the type of the attribute. The type constants are defined in the IGPAttributeInfo interface

Returns:

the type of the attribute

getMultiplicity

int getMultiplicity()

Returns the cardinality of the attribute

Returns:

the cardinaltity of the attribute

setMultiplicity

void setMultiplicity(int multiplicity)
                     throws GPInvocationException

Sets the cardinality of the attribute

Parameters:

multiplicity - the attribute cardinality

Throws:

GPInvocationException

setType

void setType(int type)

Sets the type of the attribute

Parameters:

type - the attribute type

getNamespace

String getNamespace()

Returns the attribute namespace

Returns:

the namspace of the attribute

setNameKey

void setNameKey(String nameKey)

Sets the key for the localized name of the attribute

Parameters:

nameKey - the key for the localized name of the attribute

getStructureInfo

IGPStructureInfo getStructureInfo()

Returns the structure definiition of the containing structure

Returns:

the

resolveText

String resolveText(Locale locale)

Resolves the language dependent text for the description. Implementations must make sure that a text is resolved according to the language resolution rules.

Parameters:

locale - the end user's locale

Returns:

the language dependent text to display.

getLabel

IGPLabel getLabel()

Return the labe identifying this attribute

Returns:

the label identifying this attribute

toString

String toString()

Overriden default-method. Returns an XML representation of IGPAttributeInfo.

Overrides:

toString in class Object