getErrorString method: IPDFSignature class

Syntax

getErrorString()

Description

Implement the getErrorString method to return a detailed error message to BI Publisher for PeopleSoft. A detailed error message can be internal to your implementation of the getSignatureId method or one that is passed back from an invocation of a PT_SECURITY_DIGITALCERTSTORE:DigitalCertStore method.

Note:

This is an abstract method.

Parameters

None.

Returns

A String value.

Example

During execution of the getSignatureId method, the &m_errorStr instance variable is set to the message catalog entry corresponding to any error returned from invocations of DigitalCertStore methods. For example:

If ... Then
   &m_errorStr = MsgGet(&m_ErrorMessageSet, 64, "### Not able to retrieve a list of digital IDs.");
End-If;

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

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