com.vhosting.netconf.frame
Interface RpcReplyError


public interface RpcReplyError

This interface defines an RPC error as a possible reply to an RPC operation.

Version:
1.00, 02/11/2010
Author:
Giuseppe Palmeri

Nested Class Summary
static class RpcReplyError.ErrorSeverity
          This enum lists the types of severity of a RPC error.
static class RpcReplyError.ErrorTag
          This enum represents the cataloging of all possible errors that can be found in an RPC response.
static class RpcReplyError.ErrorType
          This listing allows you to catalog all RPC error that can be obtained in response to an RPC operation.
 
Method Summary
 java.lang.String getErrorAppTag()
          Get the custom application error tag if exists.
 RpcReplyErrorInfo getErrorInfo()
          Get additional information about the error, if the error type requires it.
 RpcReplyErrorMessage getErrorMessage()
          Get human readable information about the problem.
 java.lang.String getErrorPath()
          Contains the absolute XPath expression identifying the element path to the node that is associated with the error being reported in a RPC error.
 RpcReplyError.ErrorSeverity getErrorSeverity()
          Get the severity of the error.
 RpcReplyError.ErrorTag getErrorTag()
          Contains a string identifying the error condition.
 RpcReplyError.ErrorType getErrorType()
          Get the RPC error type.
 

Method Detail

getErrorType

RpcReplyError.ErrorType getErrorType()
Get the RPC error type.

Returns:
The RPC error type elements.

getErrorTag

RpcReplyError.ErrorTag getErrorTag()
Contains a string identifying the error condition.

Returns:
The error condition.

getErrorSeverity

RpcReplyError.ErrorSeverity getErrorSeverity()
Get the severity of the error.

Returns:
The error severity.

getErrorAppTag

java.lang.String getErrorAppTag()
Get the custom application error tag if exists.

Returns:
The custom application error tag; null if not exists.

getErrorPath

java.lang.String getErrorPath()
Contains the absolute XPath expression identifying the element path to the node that is associated with the error being reported in a RPC error.

Returns:
The XPath expression; null if not exists.

getErrorMessage

RpcReplyErrorMessage getErrorMessage()
Get human readable information about the problem.

Returns:
The human readable information about the problem.

getErrorInfo

RpcReplyErrorInfo getErrorInfo()
Get additional information about the error, if the error type requires it.

Returns:
The additional error informations; null if the error type not requires it.