getErrorString method: BIP_EMAIL_DATA class

Syntax

getErrorString()

Description

Implement the getErrorString method to return a detailed error message to BI Publisher for PeopleSoft. The detailed error message should be internal to your implementation of the getEmailAddressArray method.

Note:

This is an abstract method.

Parameters

None.

Returns

A String value.

Example

During execution of the getEmailAddressArray method, the &m_errorStr instance variable is set to a literal string in some cases or to the message catalog entry. For example:

   &m_errorStr = MsgGet(&Err.MessageSetNumber, &Err.MessageNumber, &Err.ToString(), &sSub1, &sSub2, &sSub3, &sSub4, &sSub5);

Then, this &m_errorStr instance variable is set as the return value for the getErrorString method:

method getErrorString
   /+ Returns String +/
   /+ Extends/implements IPT_BIP_EXT_EMAIL_INT:BIP_EMAIL_DATA.getErrorString +/
   Return &m_errorStr;
end-method;