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:
- The first form of getAppText() retrieves application-specific
information for the business object definition associated with the current
business object. This method can return null if there is no
application-specific information for the business object definition.
- The second and third forms of getAppText() retrieve the
application-specific information for the attribute, which can be specified by
name or by its position within the business object definition. This
method can return null if there is no application-specific
information for the attribute.
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:
- This first form retrieves the business-object-level application-specific
information; that is, it obtains the application-specific information for
the business object definition associated with the current business
object.
- The second and third forms retrieve the attribute application-specific
information; that is, they obtain the application-specific information
for an attribute, which you can identify through its name
(attrName) or position within the business object definition
(position).
- The fourth, fifth, and sixth forms retrieve application-specific
information when this information is formatted into
name-value pairs of the form:
tagName=value
The tagName specifies the name of the tag (property) that
appears in the application-specific information. The
delimiter specifies the symbol that separates each name-value
pair. By convention, the delimiter is usually the colon
(:). The fourth form retrieves a name-value pair from the
business-object-level application-specific information, while the fifth and
sixth forms retrieve a name-value pair from the application-specific
information of a specified attribute.
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()
