com.sap.engine.interfaces.messaging.api

Interface ErrorInfo

public interface ErrorInfo

The ErrorInfo interface defines a container which carries error information for specific message implementations in a generic way. Message implementation specific ErrorInfo container implementations can be retrieved from a given message with the createErrorInfo method and maintained as part of a message with the setter and getter method.
There's an default implementation of the ErrorInfo container just simply based on a Hashmap with setter and getter methods for arbitrary error attributes. Each protocol (message format implementation) should extend this abstract ErrorInfo implementation and offer convenience methods for setting and getting the protocol specific error information attributes (if the protocol supports explicit error messages).

Version:

$Id: //tc/xpi.ms/NW711_03_COR/src/_interface/pifce/api/com/sap/engine/interfaces/messaging/api/ErrorInfo.java#1 $

Method Summary

String	getAttribute(String name) Returns the requested ErrorInfo attribute.
String[]	getSupportedAttributeNames() This method can be overwritten by the protocol specific ErrorInfo container implementations to specify, which attribute names are known by the setAttribute method.
void	setAttribute(String name, String value) Sets an ErrorInfo attribute.

Method Detail

getSupportedAttributeNames

String[] getSupportedAttributeNames()

This method can be overwritten by the protocol specific ErrorInfo container implementations to specify, which attribute names are known by the setAttribute method.

setAttribute

void setAttribute(String name,
                  String value)
                  throws InvalidParamException

Sets an ErrorInfo attribute.

Parameters:

name - The name of the attribute.

value - The value of the attribute.

Throws:

InvalidParamException

getAttribute

String getAttribute(String name)

Returns the requested ErrorInfo attribute.

Returns:

The requested attribute value or null, if it does not exist.