"WEBNMS_5 API Docs"

com.adventnet.nms.admin
Class ShutDownException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.adventnet.nms.admin.ShutDownException
All Implemented Interfaces:
java.io.Serializable

public class ShutDownException
extends java.lang.Exception

ShutDownException is the extension of java.lang.Exception which is used to clearly explain the circumstances in which ShutDown didn't happen

See Also:
Serialized Form

Field Summary
static int AUTHENTICATION_FAILURE
          Error code for Authentication failure
static int AUTHORIZATION_FAILURE
          Error code for Authorization failure
static int WARNING_MESSAGE
          Error code for warning messages
 
Constructor Summary
ShutDownException(java.lang.String errormessage, java.lang.Throwable exception)
          Constructs the exception with the error message as well as throwable.You can even pass null to throwable.
ShutDownException(java.lang.String errormessage, java.lang.Throwable exception, int errorCode)
          Constructs the exception with the error message , throwable and error code
 
Method Summary
 int getErrorCode()
          Method for getting error code.
 void setErrorCode(int errorCode)
          Method for setting error code for this Exception
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

AUTHENTICATION_FAILURE

public static int AUTHENTICATION_FAILURE
Error code for Authentication failure


AUTHORIZATION_FAILURE

public static int AUTHORIZATION_FAILURE
Error code for Authorization failure


WARNING_MESSAGE

public static int WARNING_MESSAGE
Error code for warning messages

Constructor Detail

ShutDownException

public ShutDownException(java.lang.String errormessage,
                         java.lang.Throwable exception)
Constructs the exception with the error message as well as throwable.You can even pass null to throwable.

Parameters:
errormessage - The error message for this exception
exception - Throwable for this exception

ShutDownException

public ShutDownException(java.lang.String errormessage,
                         java.lang.Throwable exception,
                         int errorCode)
Constructs the exception with the error message , throwable and error code

Parameters:
errormessage - Error message for this Exception
exception - Throwable for this exception. Even null can be passed for this parameter
errorCode - Error code for this Exception. It may be any one of error codes explained above
Method Detail

getErrorCode

public int getErrorCode()
Method for getting error code. Returned error code can be any one of error codes explained above

Returns:
Error code associated with this exception. If no value is set for this exception -1 will be returned

setErrorCode

public void setErrorCode(int errorCode)
Method for setting error code for this Exception

Parameters:
errorCode - Can be any one of error codes mentioned above

"WEBNMS_5 API Docs"

Copyright © 2011 ZOHO Corp., All Rights Reserved.