com.sap.ip.collaboration.core.api.util.exception

Interface IBaseException

All Known Implementing Classes:

AddAttachmentException, AddAttachmentFailureException, AttachmentDeleteException, AttachmentException, AttachmentSetTypeException, AttachmentTypeException, AuthenticationException, BaseException, BaseRuntimeException, CheckerException, EFPException, ExtensionException, GroupwareException, GroupwareRuntimeException, IncompleteOperationException, InvalidEmailAddressFormatException, InvalidTransportException, NoAttachmentCollectionException, NoAttachmentListException, NoAttachmentListReadOnlyException, NoLogonDataFoundException, NoPhotoFoundException, NoRelationException, NoRelationServiceException, NoResourceFoundException, NoSuchRoomRoleException, NoTransportConfiguredException, OperationNotSupportedException, RoomCreationException, RoomDeletionException, RoomException, RoomInstantiationException, RoomPartCreationException, RoomPartException, RoomVersionException, SCFException, SCFRuntimeException, SCFTextBundleNotFoundException, SCFUMException, TemplateInstantiationException, TransportLoadFailureException, UserPasswordException, UserPhotoCheckerException, UserPhotoException, UserPhotoRuntimeException, ValueSetProviderException

public interface IBaseException

Common interface for base exceptions with internationalizable error texts

Copyright: Copyright (c) 2002 Company: SAP Portals

Field Summary

static boolean	DONT_LOG constant for not logging the exception
static boolean	LOG constant for logging the exception

Method Summary

Throwable	getCausingThrowable() returns the causing throwable if there is one or null
String	getMessage() returns an error message formated with the logging locale
String	getMessage(Locale locale) returns a locale specific short error message.
Throwable	getRootThrowable() returns the top most throwable in the exception chain.
IText	getText() returns the text object representing the error message
boolean	isLogged() checks, if the exception was already logged
void	logException() logs the exception using a standard logger
void	printStackTrace() printStackTrace method as on java.lang.Exception
void	printStackTrace(PrintStream stream) printStackTrace method as on java.lang.Exception
void	printStackTrace(PrintWriter writer) printStackTrace method as on java.lang.Exception

Field Detail

LOG

static final boolean LOG

constant for logging the exception

See Also:

Constant Field Values

DONT_LOG

static final boolean DONT_LOG

constant for not logging the exception

See Also:

Constant Field Values

Method Detail

logException

void logException()

logs the exception using a standard logger

isLogged

boolean isLogged()

checks, if the exception was already logged

getMessage

String getMessage()

returns an error message formated with the logging locale

getMessage

String getMessage(Locale locale)

returns a locale specific short error message.

Parameters:

locale - the locale for the message

getText

IText getText()

returns the text object representing the error message

printStackTrace

void printStackTrace()

printStackTrace method as on java.lang.Exception

printStackTrace

void printStackTrace(PrintStream stream)

printStackTrace method as on java.lang.Exception

Parameters:

stream - PrintStream for output

printStackTrace

void printStackTrace(PrintWriter writer)

printStackTrace method as on java.lang.Exception

Parameters:

writer - PrintWriter for output

getCausingThrowable

Throwable getCausingThrowable()

returns the causing throwable if there is one or null

Returns:

causing exception or null, if there is no causing throwable

getRootThrowable

Throwable getRootThrowable()

returns the top most throwable in the exception chain. If the exception is the top most in the chain the method returns this.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-COLL	[sap.com] tc/kmc/coll/util	api	EP-KM-COL
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM