getAppText()

Retrieves the value of the AppSpecificInfo field associated with this business object definition or with a specified attribute.

Syntax

public String getAppText();
 public String getAppText(String attrName);
 public String getAppText(int position);
 
public final String getAppText(String tagName, String delimiter);
 public final String getAppText(String attrName, String tagName, 
       String delimiter);
 public final String getAppText(int position, String tagName,
       String delimiter);
 

Parameters

attrName
Is the name of an attribute whose application-specific information is parsed.
delimiter
Is the delimiter between each name-value pair. By convention, the colon (:) is used as the delimiter for building the name-value pairs.
position
Is an integer that specifies the ordinal position of an attribute in the business object's attribute list.
tagName
Is the name of the tag in the application-specific information whose value the method retrieves.

Return values

A String object that holds the application-specific information from the appropriate AppSpecificInfo field:

Exceptions

The second, third, fifth, and sixth forms of the getAppText() method can throw the following exception:

AttributeNotFoundException
Thrown when the specified attribute cannot be found.

The fourth, fifth, and sixth forms of the getAppText() method can throw the following exception:

WrongASIFormatException
Thrown if the application-specific information does not conform to the name-value format.

Notes

The getAppText() method provides the following forms:

For example, suppose a business object definition contains the following application-specific information:

TN=table1:SCH=schema1
 

The following call to getAppText() retrieves the value of the name-value pair for the TN tag:

String TNvalue = busObj.getAppText("TN", ":");
 
Note:
To retrieve all name-value pairs as a Java Hashtable object, use the getBusObjASIHashtable() or the getAttrASIHashtable() method for business-object-level or attribute application-specific information, respectively.

See also

getAttrASIHashtable(),, getBusObjASIHashtable(),, getVerbAppText()

Copyright IBM Corp. 1997, 2003