com.ibm.manplato.Protocol
Class DLPError

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ibm.manplato.Protocol.DLPError
All Implemented Interfaces:
java.io.Serializable

public class DLPError
extends java.lang.Exception

DLPError class. This class is used to store DLPError information. DLP errors are generated and returned by the Palm when a requested function is not available, or when it cannot complete due to an error. see the DLP_Packet class for a list of error codes.

Version:
$Rev$-$Date: 2001/03/15 16:55:32 $$State: Exp $
Author:
File Created By: Brad BARCLAY <bbarclay@ca.ibm.com>, Last Modified By: $Author: Yaztromo $
See Also:
Serialized Form

Constructor Summary
(package private) DLPError(DLP_Packet dlp_packet)
          Create a new DLPError object with the given DLP_Packet which generated the error.
(package private) DLPError(java.lang.String s, DLP_Packet dlp_packet)
          Create a new DLPError object with the given DLP_Packet which generated the error and a String containing an error message.
 
Method Summary
(package private)  int getErrorCode()
          Returns the DLP error code.
(package private)  DLP_Packet getResponsePacket()
          Returns the responce packet containing the error.
 java.lang.String toString()
          Returns a string explaining this DLP_Error object.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DLPError

DLPError(DLP_Packet dlp_packet)
Create a new DLPError object with the given DLP_Packet which generated the error.
Parameters:
dlp_packet - the DLPPacket object which reported the error.

DLPError

DLPError(java.lang.String s,
         DLP_Packet dlp_packet)
Create a new DLPError object with the given DLP_Packet which generated the error and a String containing an error message.
Parameters:
s - a String containing an error message.
dlp_packet - the DLPPacket object which reported the error.
Method Detail

getErrorCode

int getErrorCode()
Returns the DLP error code. See the DLP_Packet class for a list of error codes.
Returns:
the error code provided by the Palm.
See Also:
DLP_Packet

getResponsePacket

DLP_Packet getResponsePacket()
Returns the responce packet containing the error.
Returns:
the DLP_Packet containing the error this class represents.

toString

public java.lang.String toString()
Returns a string explaining this DLP_Error object.
Overrides:
toString in class java.lang.Throwable
Returns:
a string explaining this DLP_Error object.