alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx Class Reference

Inheritance diagram for alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx:

[legend]

Collaboration diagram for alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx:

[legend]

List of all members.

Public Member Functions
	AcsJRangeExhaustedEx ()
	AcsJRangeExhaustedEx (String message)
	AcsJRangeExhaustedEx (String message, Throwable cause)
	AcsJRangeExhaustedEx (Throwable cause)
	AcsJRangeExhaustedEx (ErrorTrace etCause)
	AcsJRangeExhaustedEx (String message, ErrorTrace etCause)
String	getShortDescription ()
UserException	toCorbaException ()
RangeExhaustedEx	toRangeExhaustedEx ()
void	setRange (String value)
String	getRange ()
void	setRangeMaxDocumentId (String value)
String	getRangeMaxDocumentId ()
Static Public Member Functions
static AcsJRangeExhaustedEx	fromRangeExhaustedEx (RangeExhaustedEx corbaEx)
Protected Member Functions
final int	getErrorCode ()

---

Detailed Description

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

See also:

AcsJArchiveIdentifierErrorEx

Author:

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

---

Constructor & Destructor Documentation

alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::AcsJRangeExhaustedEx

(

)

[inline]

Referenced by fromRangeExhaustedEx().

alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::AcsJRangeExhaustedEx

(

String

message

)

[inline]

Deprecated:

The data in message should be given as parameters instead!

alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::AcsJRangeExhaustedEx	(	String	message,
		Throwable	cause
	)			[inline]

Deprecated:

The data in message should be given as parameters instead!

alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::AcsJRangeExhaustedEx

(

Throwable

cause

)

[inline]

alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::AcsJRangeExhaustedEx

(

ErrorTrace

etCause

)

[inline]

alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::AcsJRangeExhaustedEx	(	String	message,
		ErrorTrace	etCause
	)			[inline]

Deprecated:

The data in message should be given as parameters instead!

---

Member Function Documentation

static AcsJRangeExhaustedEx alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::fromRangeExhaustedEx

(

RangeExhaustedEx

corbaEx

)

[inline, static]

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

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

final int alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::getErrorCode

(

)

[inline, protected, virtual]

Returns the error code, which is fixed to 6, given by RangeExhausted.value.

See also:

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

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

String alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::getRange

(

)

[inline]

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

String alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::getRangeMaxDocumentId

(

)

[inline]

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

String alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::getShortDescription

(

)

[inline]

Returns the short description of the error

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

void alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::setRange

(

String

value

)

[inline]

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

Referenced by alma::acs::container::archive::Range::getNextID().

void alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::setRangeMaxDocumentId

(

String

value

)

[inline]

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

Referenced by alma::acs::container::archive::Range::getNextID().

UserException alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::toCorbaException

(

)

[inline, virtual]

See also:

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

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

References toRangeExhaustedEx().

RangeExhaustedEx alma::ArchiveIdentifierError::wrappers::AcsJRangeExhaustedEx::toRangeExhaustedEx

(

)

[inline]

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

• AcsJRangeExhaustedEx.java