AR System Java API

com.bmc.arsys.api
Class ARException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.bmc.arsys.api.ARException
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ARBulkException, ARMultiStatusException

public class ARException
extends Exception

The ARException class represents the exceptions generated by API. StatusInfo represents the actual information returned by the system.

See Also:
Serialized Form

Constructor Summary
ARException()
          constructor
ARException(int returnCode, int errorCode)
          Constructor
ARException(int returnCode, int errorCode, String appendMsg)
           
ARException(int returnCode, int errorCode, String appendMsg, Locale locale)
          Constructor
ARException(List<StatusInfo> lastStatus)
          constructor
 
Method Summary
 boolean canErrorBeIgnored(int[] ignoredErrors)
          check if this exception only contains errors that can be ignored.
 void clear()
          Release all variable object references.
 List<StatusInfo> getLastStatus()
          Returns last status of operation.
 String getMessage()
          Returns in a String object for all of the status messages.
 void setLastStatus(List<StatusInfo> lastStatus)
          Set the last status
 String toString()
          Returns a string description of the object.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ARException

public ARException()
constructor


ARException

public ARException(List<StatusInfo> lastStatus)
constructor

Parameters:
lastStatus -

ARException

public ARException(int returnCode,
                   int errorCode)
Constructor

Parameters:
returnCode -
errorCode -

ARException

public ARException(int returnCode,
                   int errorCode,
                   String appendMsg)

ARException

public ARException(int returnCode,
                   int errorCode,
                   String appendMsg,
                   Locale locale)
Constructor

Parameters:
returnCode -
errorCode -
appendMsg -
locale -
Method Detail

getLastStatus

public List<StatusInfo> getLastStatus()
Returns last status of operation.


setLastStatus

public void setLastStatus(List<StatusInfo> lastStatus)
Set the last status

Parameters:
lastStatus -

toString

public String toString()
Returns a string description of the object.

Overrides:
toString in class Throwable

getMessage

public String getMessage()
Returns in a String object for all of the status messages.

Overrides:
getMessage in class Throwable

clear

public void clear()
Release all variable object references. Since most of those references are JNI objects, gc will not reclaim them if we do not release them specificly. Client should call this in their finally block when done with this object.


canErrorBeIgnored

public boolean canErrorBeIgnored(int[] ignoredErrors)
check if this exception only contains errors that can be ignored.


AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.