alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx Class Reference

Inheritance diagram for alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx:
Inheritance graph
[legend]
Collaboration diagram for alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 AcsJIdentifierUnavailableEx ()
 AcsJIdentifierUnavailableEx (String message)
 AcsJIdentifierUnavailableEx (String message, Throwable cause)
 AcsJIdentifierUnavailableEx (Throwable cause)
 AcsJIdentifierUnavailableEx (ErrorTrace etCause)
 AcsJIdentifierUnavailableEx (String message, ErrorTrace etCause)
String getShortDescription ()
UserException toCorbaException ()
IdentifierUnavailableEx toIdentifierUnavailableEx ()
void setContextInfo (String value)
String getContextInfo ()

Static Public Member Functions

static AcsJIdentifierUnavailableEx fromIdentifierUnavailableEx (IdentifierUnavailableEx corbaEx)

Protected Member Functions

final int getErrorCode ()

Detailed Description

Java native style exception class representing the error type alma.ACSErr.ACSErrType.ArchiveIdentifierError, error code IdentifierUnavailable.value.

See also:
AcsJArchiveIdentifierErrorEx
Author:
ACS Error System Code Generator created Sep 25, 2003 4:18:09 PM

Constructor & Destructor Documentation

alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::AcsJIdentifierUnavailableEx (  )  [inline]

Referenced by fromIdentifierUnavailableEx().

alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::AcsJIdentifierUnavailableEx ( String  message  )  [inline]
Deprecated:
The data in message should be given as parameters instead!
alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::AcsJIdentifierUnavailableEx ( String  message,
Throwable  cause 
) [inline]
Deprecated:
The data in message should be given as parameters instead!
alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::AcsJIdentifierUnavailableEx ( Throwable  cause  )  [inline]
alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::AcsJIdentifierUnavailableEx ( ErrorTrace  etCause  )  [inline]
alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::AcsJIdentifierUnavailableEx ( String  message,
ErrorTrace  etCause 
) [inline]
Deprecated:
The data in message should be given as parameters instead!

Member Function Documentation

static AcsJIdentifierUnavailableEx alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::fromIdentifierUnavailableEx ( IdentifierUnavailableEx  corbaEx  )  [inline, static]

Converts a CORBA IdentifierUnavailable to an instance of this class.

Note that unlike the constructor AcsJErrTest0Ex(ErrorTrace), this static conversion method does not wrap the existing chain of exceptions with a new exception. It simply converts all exceptions found in the ErrorTrace of corbaEx to the corresponding Java exceptions, knowing that the top level exception is of type IdentifierUnavailable and can always be converted to AcsJIdentifierUnavailableEx.

Here's an example of how to use this method in a Java program that makes a call so some other component etc.: 

 private void methodThatMakesARemoteCall() throws AcsJIdentifierUnavailableEx
 {
   try
   {
     // this fakes the remote call to a method
     // which can throw an IdentifierUnavailableEx...
     throw new IdentifierUnavailableEx();
   }
   catch (IdentifierUnavailableEx corbaEx)
   {
     throw AcsJIdentifierUnavailableEx.fromIdentifierUnavailableEx(corbaEx);
   }
 }
Parameters:
corbaEx the CORBA equivalent of this class; will be converted
Returns:
the newly created instance, with data fields and caused-by exceptions converted from corbaEx.

References AcsJIdentifierUnavailableEx(), and alma::ArchiveIdentifierError::IdentifierUnavailableEx::errorTrace.

String alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::getContextInfo (  )  [inline]

References alma::acs::exceptions::AcsJException::getProperty().

final int alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::getErrorCode (  )  [inline, protected, virtual]

Returns the error code, which is fixed to 1, given by IdentifierUnavailable.value.

See also:
alma.acs.exceptions.AcsJException::getErrorCode()

Implements alma::acs::exceptions::AcsJException.

String alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::getShortDescription (  )  [inline]

Returns the short description of the error

Reimplemented from alma::acs::exceptions::AcsJException.

void alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::setContextInfo ( String  value  )  [inline]

References alma::acs::exceptions::AcsJException::setProperty().

Referenced by alma::acs::container::archive::UIDLibrary::checkDefaultRange().

UserException alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::toCorbaException (  )  [inline, virtual]
See also:
alma.acs.exceptions.AcsJException::toCorbaException()

Implements alma::acs::exceptions::AcsJException.

References toIdentifierUnavailableEx().

IdentifierUnavailableEx alma::ArchiveIdentifierError::wrappers::AcsJIdentifierUnavailableEx::toIdentifierUnavailableEx (  )  [inline]

Creates an IdentifierUnavailable that represents this exception with all its caused-by child exceptions.

Typically to be called from a top-level catch block that must convert any of the Java exceptions used internally by the Java program to an IDL type exception that can be thrown on over CORBA.

Returns:
the type-safe subclass of org.omg.CORBA.UserException with an embedded ErrorTrace.
See also:
toCorbaException

References alma::acs::exceptions::AcsJException::getErrorTrace().

Referenced by toCorbaException().

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2