Oracle&#174 Ultra Search Java API Reference
10g Release 2 (10.2)

B14221-01


oracle.ultrasearch.crawler
Class AgentException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended byoracle.ultrasearch.crawler.AgentException

All Implemented Interfaces:
java.io.Serializable

public class AgentException
extends java.lang.Exception

This encapsulates information about a data source agent-specific error.

See Also:
Serialized Form

Field Summary
static int FATAL
static int UNDEFINED
static int WARNING

Constructor Summary
AgentException(java.lang.Exception errorException)
Constructs an AgentExcception from an exception.
AgentException(int severity, java.lang.String message)
Constructs an AgentException from an error code.
AgentException(java.lang.String message)
Constructs an AgentException from a string

Method Summary
java.lang.String getErrorString()
returns the error message
boolean isFatalException()
Checks if the exception is a fatal exception
java.lang.String toString()
returns the error message
java.lang.String toString(java.lang.String arg1)

Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNDEFINED

public static final int UNDEFINED
See Also:
Constant Field Values

FATAL

public static final int FATAL

WARNING

public static final int WARNING

Constructor Detail

AgentException

public AgentException(java.lang.String message)
Constructs an AgentException from a string
Parameters:
message - is the exception message

AgentException

public AgentException(int severity,
                      java.lang.String message)
Constructs an AgentException from an error code.
Parameters:
severity - severity of the exception: FATAL or WARNING
message - the exception message

AgentException

public AgentException(java.lang.Exception errorException)
Constructs an AgentExcception from an exception. This is useful when an agent needs to return error/failure information that is a direct result of an exception.
Parameters:
errorException - the cause of the agent exception

Method Detail

getErrorString

public java.lang.String getErrorString()
returns the error message

toString

public java.lang.String toString()
returns the error message

toString

public java.lang.String toString(java.lang.String arg1)

isFatalException

public boolean isFatalException()
Checks if the exception is a fatal exception
Returns:
true if the exception is fatal, false otherwise.

Oracle&#174 Ultra Search Java API Reference
10g Release 2 (10.2)

B14221-01


Copyright © 2003,2005, Oracle. All Rights Reserved.