Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)
E15995-06


oracle.webcenter.search
Class SearchException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by oracle.webcenter.search.SearchException

All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ContradictionException

public class SearchException
extends java.lang.Exception
implements java.io.Serializable

The base exception for all Search related errors.

Since:
11.1.1.0.0 Beta 2
See Also:
Serialized Form

Field Summary
protected  SearchExceptionCode m_exCode
           
protected static java.util.Map<java.lang.String,java.util.ResourceBundle> m_hmRbs
           
protected  java.lang.String[] m_oaParams
           

 

Constructor Summary
protected SearchException()
           
  SearchException(SearchExceptionCode exCode)
          Constructs a SearchException with a SearchExceptionCode.
  SearchException(SearchExceptionCode exCode, java.lang.Object... args)
          Constructs a SearchException with a SearchExceptionCode and an array of Object arguments.
  SearchException(SearchExceptionCode exCode, java.lang.Throwable throwable)
          Constructs a SearchException with a SearchExceptionCode and a Throwable as a nested Exception.
  SearchException(SearchExceptionCode exCode, java.lang.Throwable throwable, java.lang.Object... args)
          Constructs a SearchException with a SearchExceptionCode, a Throwable as a nested Exception, and an array of Object arguments.

 

Method Summary
 SearchExceptionCode getErrorCode()
          Returns the error code associated with this exception.
 java.lang.String getLocalizedMessage()
          Returns a message in the default locale format.
 java.lang.String getLocalizedMessage(java.util.Locale locale)
          Returns a message in the format of the locale passed as an argument.
 java.lang.String getMessage()
          Override method in base class to return a message in the default locale format.
protected  java.lang.String getMessagePrivate(java.util.Locale locale)
          Returns a exception message in the locale specific format.
 java.lang.String[] getParams()
          Returns the arguments for the format messaging.
protected  java.util.ResourceBundle getResourceBundle(java.util.Locale locale)
          Returns the resource bundle which is used in formatting the messages, given the locale.
protected  java.lang.String getResourceBundleName()
          Returns the name of the ResourceBundle to be used by this subclass of the SearchException.

 

Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, 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

m_oaParams

protected java.lang.String[] m_oaParams

m_exCode

protected SearchExceptionCode m_exCode

m_hmRbs

protected static java.util.Map<java.lang.String,java.util.ResourceBundle> m_hmRbs

Constructor Detail

SearchException

protected SearchException()

SearchException

public SearchException(SearchExceptionCode exCode)
Constructs a SearchException with a SearchExceptionCode. The construction uses the strongly typed SearchExceptionCode to allow only proper instantiation from controlled implementations.
Parameters:
exCode - identifies the exception code associated with this exception. it will be used as a key into the exception resource bundle to get the localized execptin message.

SearchException

public SearchException(SearchExceptionCode exCode,
                       java.lang.Object... args)
Constructs a SearchException with a SearchExceptionCode and an array of Object arguments. The construction uses the strongly typed SearchExceptionCode to allow only proper instantiation from controlled implementations.
Parameters:
exCode - identifies the exception code associated with this exception. it will be used as a key into the exception resource bundle to get the localized execptin message.
args - argument(s) for the formatting of the message associated with this exception

SearchException

public SearchException(SearchExceptionCode exCode,
                       java.lang.Throwable throwable)
Constructs a SearchException with a SearchExceptionCode and a Throwable as a nested Exception. The construction uses the strongly typed SearchExceptionCode to allow only proper instantiation from controlled implementations.
Parameters:
exCode - identifies the exception code associated with this exception. it will be used as a key into the exception resource bundle to get the localized execptin message.
throwable - a throwable that causes this SearchException to be raised

SearchException

public SearchException(SearchExceptionCode exCode,
                       java.lang.Throwable throwable,
                       java.lang.Object... args)
Constructs a SearchException with a SearchExceptionCode, a Throwable as a nested Exception, and an array of Object arguments. The construction uses the strongly typed SearchExceptionCode to allow only proper instantiation from controlled implementations.
Parameters:
exCode - identifies the exception code associated with this exception. it will be used as a key into the exception resource bundle to get the localized execptin message.
throwable - a throwable that cause this SearchException to be raised
args - argument(s) for the formatting of the message associated with this exception

Method Detail

getMessage

public java.lang.String getMessage()
Override method in base class to return a message in the default locale format. The default locale is the locale where the server is placed.
Overrides:
getMessage in class java.lang.Throwable
Returns:
a localized message for for this Exception

getLocalizedMessage

public java.lang.String getLocalizedMessage()
Returns a message in the default locale format. The default locale is the locale where the server is placed.
Overrides:
getLocalizedMessage in class java.lang.Throwable
Returns:
a localized message for for this Exception

getLocalizedMessage

public java.lang.String getLocalizedMessage(java.util.Locale locale)
Returns a message in the format of the locale passed as an argument.
Parameters:
locale - a Locale with which we wish to get the message for
Returns:
a localized message for this Exception in the locale passed in

getErrorCode

public SearchExceptionCode getErrorCode()
Returns the error code associated with this exception.
Returns:
a SearchExceptionCode that this the Exception was created with

getParams

public java.lang.String[] getParams()
Returns the arguments for the format messaging.
Returns:
Object[] an array of objects

getResourceBundleName

protected java.lang.String getResourceBundleName()
Returns the name of the ResourceBundle to be used by this subclass of the SearchException. e.g. "oracle.discussions.exmsgs.XXXMessages"
Returns:
the resource bundle class name used by this Exception

getMessagePrivate

protected java.lang.String getMessagePrivate(java.util.Locale locale)
Returns a exception message in the locale specific format.
Parameters:
locale - Locale to get the message in
Returns:
a private message given a Locale

getResourceBundle

protected final java.util.ResourceBundle getResourceBundle(java.util.Locale locale)
                                                    throws java.util.MissingResourceException
Returns the resource bundle which is used in formatting the messages, given the locale.
Parameters:
locale - Locale of the resource bundle sought
Returns:
ResourceBundle object for that specified locale.
Throws:
java.util.MissingResourceException

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.7.0)
E15995-06


Copyright © 2009, 2013, Oracle and/or its affiliates. All rights reserved.