alma::ACSTimeError::wrappers::AcsJInvalidIDEx Class Reference

Inheritance diagram for alma::ACSTimeError::wrappers::AcsJInvalidIDEx:

[legend]

Collaboration diagram for alma::ACSTimeError::wrappers::AcsJInvalidIDEx:

[legend]

List of all members.

Public Member Functions
	AcsJInvalidIDEx ()
	AcsJInvalidIDEx (String message)
	AcsJInvalidIDEx (String message, Throwable cause)
	AcsJInvalidIDEx (Throwable cause)
	AcsJInvalidIDEx (ErrorTrace etCause)
	AcsJInvalidIDEx (String message, ErrorTrace etCause)
String	getShortDescription ()
UserException	toCorbaException ()
InvalidIDEx	toInvalidIDEx ()
Static Public Member Functions
static AcsJInvalidIDEx	fromInvalidIDEx (InvalidIDEx corbaEx)
Protected Member Functions
final int	getErrorCode ()

---

Detailed Description

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

See also:

AcsJACSTimeErrorEx

Author:

ACS Error System Code Generator created Sep 25, 2003 4:18:09 PM

---

Constructor & Destructor Documentation

alma::ACSTimeError::wrappers::AcsJInvalidIDEx::AcsJInvalidIDEx

(

)

[inline]

Referenced by fromInvalidIDEx().

alma::ACSTimeError::wrappers::AcsJInvalidIDEx::AcsJInvalidIDEx

(

String

message

)

[inline]

Deprecated:

The data in message should be given as parameters instead!

alma::ACSTimeError::wrappers::AcsJInvalidIDEx::AcsJInvalidIDEx	(	String	message,
		Throwable	cause
	)			[inline]

Deprecated:

The data in message should be given as parameters instead!

alma::ACSTimeError::wrappers::AcsJInvalidIDEx::AcsJInvalidIDEx

(

Throwable

cause

)

[inline]

alma::ACSTimeError::wrappers::AcsJInvalidIDEx::AcsJInvalidIDEx

(

ErrorTrace

etCause

)

[inline]

alma::ACSTimeError::wrappers::AcsJInvalidIDEx::AcsJInvalidIDEx	(	String	message,
		ErrorTrace	etCause
	)			[inline]

Deprecated:

The data in message should be given as parameters instead!

---

Member Function Documentation

static AcsJInvalidIDEx alma::ACSTimeError::wrappers::AcsJInvalidIDEx::fromInvalidIDEx

(

InvalidIDEx

corbaEx

)

[inline, static]

Converts a CORBA InvalidID 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 InvalidID and can always be converted to AcsJInvalidIDEx.

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 AcsJInvalidIDEx
 {
   try
   {
     // this fakes the remote call to a method
     // which can throw an InvalidIDEx...
     throw new InvalidIDEx();
   }
   catch (InvalidIDEx corbaEx)
   {
     throw AcsJInvalidIDEx.fromInvalidIDEx(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 AcsJInvalidIDEx(), and alma::ACSTimeError::InvalidIDEx::errorTrace.

final int alma::ACSTimeError::wrappers::AcsJInvalidIDEx::getErrorCode

(

)

[inline, protected, virtual]

Returns the error code, which is fixed to 2, given by InvalidID.value.

See also:

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

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

String alma::ACSTimeError::wrappers::AcsJInvalidIDEx::getShortDescription

(

)

[inline]

Returns the short description of the error

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

UserException alma::ACSTimeError::wrappers::AcsJInvalidIDEx::toCorbaException

(

)

[inline, virtual]

See also:

alma.acs.exceptions.AcsJException::toCorbaException()

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

References toInvalidIDEx().

InvalidIDEx alma::ACSTimeError::wrappers::AcsJInvalidIDEx::toInvalidIDEx

(

)

[inline]

Creates an InvalidID 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:

• AcsJInvalidIDEx.java