EBufException (Oracle Communications Billing and Revenue Management Customer Center SDK Java API Reference)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.portal.pcm.PortalException
    - - com.portal.pcm.EBufException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ApplicationException, DeterminateException, IndeterminateException, RetryableException
```
public class EBufException
extends PortalException
```
Signals that a Portal Library exception has occurred.

Version:

2.0 05/21/98

Author:

Larry Lynch-Freshner

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`EBufException(int location, int error, int field, int recordID, int reserved, int line, Object obj)` Constructs an instance of `EBufException`.
`EBufException(int location, int error, int field, int recordID, int reserved, int line, String fileName, FList failData, int facility, int messageID, Date time, int version, FList args, EBufException chain, int reserved2)` Constructs an instance of `EBufException`.
`EBufException(int location, int error, int field, int recordID, Object obj)` Constructs an instance of `EBufException`.
`EBufException(int error, int field, int recordID, Object obj)` Constructs an instance of `EBufException`.
`EBufException(int location, int error, Object obj)` Constructs an instance of `EBufException`.
`EBufException(int error, Object obj)` Constructs an instance of `EBufException`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FList`	`getArgsFList()`
`String`	`getDetailedErrorString(PortalContext ctx, Locale locale)` Returns the detailed error message, if any.
`String`	`getDetailedHelpString(PortalContext ctx, Locale locale)` Returns the detailed error message help text, if any.
`int`	`getError()` Returns the error code.
`String`	`getErrorString()` Returns the error message.
`Date`	`getErrorTime()`
`int`	`getFacility()`
`String`	`getFacilityString()`
`int`	`getField()` Returns the storable class field number that caused the error.
`String`	`getFieldString()` Returns the field name string that caused the error.
`String`	`getFileName()` Returns the filename from which the exception was sent.
`int`	`getLine()` Returns the line number from which the exception was sent.
`int`	`getLocation()` Returns the number of the module that found the error.
`String`	`getLocationString()` Returns the module that found the error.
`String`	`getMessage()` Throwable overide
`int`	`getMessageID()`
`EBufException`	`getNestedError()`
`FList`	`getOpcodeFList()` Returns the output FList of the opcode that caused this exception.
`int`	`getRecordID()` Returns the record ID associated with the field that caused the error.
`int`	`getReserved()` Returns reserved error data.
`int`	`getReserved2()`
`int`	`getVersion()`
`void`	`log()` Logs the exception to the default error log
`void`	`log(ErrorLog elog)` Logs the exception to the specified error log
`String`	`toString()` Converts the error buffer information to a string.

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

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

- Constructor Detail
  - EBufException
```
public EBufException(int location,
                     int error,
                     int field,
                     int recordID,
                     int reserved,
                     int line,
                     String fileName,
                     FList failData,
                     int facility,
                     int messageID,
                     Date time,
                     int version,
                     FList args,
                     EBufException chain,
                     int reserved2)
```
    Constructs an instance of EBufException.
    
    Since:
    
    Infranet 5.5
  - EBufException
```
public EBufException(int location,
                     int error,
                     int field,
                     int recordID,
                     int reserved,
                     int line,
                     Object obj)
```
    Constructs an instance of EBufException.
    
    Since:
    
    Infranet 5.5
  - EBufException
```
public EBufException(int location,
                     int error,
                     int field,
                     int recordID,
                     Object obj)
```
    Constructs an instance of EBufException.
    
    Since:
    
    Infranet 5.5
  - EBufException
```
public EBufException(int error,
                     int field,
                     int recordID,
                     Object obj)
```
    Constructs an instance of EBufException.
    
    Since:
    
    Infranet 5.5
  - EBufException
```
public EBufException(int location,
                     int error,
                     Object obj)
```
    Constructs an instance of EBufException.
    
    Since:
    
    Infranet 5.5
  - EBufException
```
public EBufException(int error,
                     Object obj)
```
    Constructs an instance of EBufException.
    
    Since:
    
    Infranet 5.5
- Method Detail
  - getMessage
```
public String getMessage()
```
    Throwable overide
    
    Overrides:
    
    getMessage in class Throwable
  - getLocation
```
public int getLocation()
```
    Returns the number of the module that found the error.
    
    Returns:
    
    Module ID
    
    Since:
    
    Infranet 5.5
  - getLocationString
```
public String getLocationString()
```
    Returns the module that found the error.
    
    Returns:
    
    Module Name
    
    Since:
    
    Infranet 5.5
  - getError
```
public int getError()
```
    Returns the error code.
    
    Returns:
    
    Error Code
    
    Since:
    
    Infranet 5.5
  - getErrorString
```
public String getErrorString()
```
    Returns the error message.
    
    Returns:
    
    Error Message or null
    
    Since:
    
    Infranet 5.5
  - getDetailedErrorString
```
public String getDetailedErrorString(PortalContext ctx,
                                     Locale locale)
```
    Returns the detailed error message, if any.
    
    Parameters:
    
    ctx - A PortalContext, used to read the DB
    
    locale - A locale for the error string
    
    Returns:
    
    a string containing the error message, with arguments formatted, if any
    
    Since:
    
    Infranet 6.0
  - getDetailedHelpString
```
public String getDetailedHelpString(PortalContext ctx,
                                    Locale locale)
```
    Returns the detailed error message help text, if any.
    
    Parameters:
    
    ctx - A PortalContext, used to read the DB
    
    locale - A locale for the error string
    
    Returns:
    
    A string containg help text for a detailed message, if any
    
    Since:
    
    Infranet 6.0
  - getField
```
public int getField()
```
    Returns the storable class field number that caused the error.
    
    Returns:
    
    Field ID
    
    Since:
    
    Infranet 5.5
  - getFieldString
```
public String getFieldString()
```
    Returns the field name string that caused the error.
    
    Returns:
    
    Field name
    
    Since:
    
    Infranet 5.5
  - getRecordID
```
public int getRecordID()
```
    Returns the record ID associated with the field that caused the error.
    
    Returns:
    
    Record ID
    
    Since:
    
    Infranet 5.5
  - getReserved
```
public int getReserved()
```
    Returns reserved error data.
    
    Returns:
    
    Reserved Information
    
    Since:
    
    Infranet 5.5
  - getLine
```
public int getLine()
```
    Returns the line number from which the exception was sent. This is generally local data.
    
    Returns:
    
    Line number where exception was thrown.
    
    Since:
    
    Infranet 5.5
  - getFileName
```
public String getFileName()
```
    Returns the filename from which the exception was sent. This is generally local data.
    
    Returns:
    
    File name where exception was thrown.
    
    Since:
    
    Infranet 5.5
  - getFacility
```
public int getFacility()
```
  - getFacilityString
```
public String getFacilityString()
```
  - getMessageID
```
public int getMessageID()
```
  - getErrorTime
```
public Date getErrorTime()
```
  - getVersion
```
public int getVersion()
```
  - getReserved2
```
public int getReserved2()
```
  - getArgsFList
```
public FList getArgsFList()
```
  - getNestedError
```
public EBufException getNestedError()
```
  - log
```
public void log()
```
    Logs the exception to the default error log
    
    Since:
    
    Infranet 5.5
  - log
```
public void log(ErrorLog elog)
```
    Logs the exception to the specified error log
    
    Since:
    
    Infranet 5.5
  - getOpcodeFList
```
public FList getOpcodeFList()
```
    Returns the output FList of the opcode that caused this exception. Returns null if there is no FList or the exception was thrown from a different location.
    
    Returns:
    
    The output FList from the opcode call.
  - toString
```
public String toString()
```
    Converts the error buffer information to a string. This is for logging and debugging, so it doesn't need to be localized.
    
    Overrides:
    
    toString in class Throwable
    
    Returns:
    
    The error buffer formatted as a string.
    
    Since:
    
    Infranet 5.5

Class EBufException

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Constructor Detail

EBufException

EBufException

EBufException

EBufException

EBufException

EBufException

Method Detail

getMessage

getLocation

getLocationString

getError

getErrorString

getDetailedErrorString

getDetailedHelpString

getField

getFieldString

getRecordID

getReserved

getLine

getFileName

getFacility

getFacilityString

getMessageID

getErrorTime

getVersion

getReserved2

getArgsFList

getNestedError

log

log

getOpcodeFList

toString