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

Class IncompleteOperationException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.sap.ip.collaboration.core.api.util.exception.BaseException
              extended by com.sap.ip.collaboration.core.api.util.exception.IncompleteOperationException
All Implemented Interfaces:
IBaseException, Serializable
Direct Known Subclasses:
RoomException, RoomPartCreationException, RoomPartException, ValueSetProviderException

public class IncompleteOperationException
extends BaseException

Class implementing an exception used in all non-atomic operations when parts of an operation failed. This exception class helps to return the partially computed results and a list of throwables for all failed parts.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.sap.ip.collaboration.core.api.util.exception.BaseException
DONT_LOG, LOG
 
Constructor Summary
IncompleteOperationException(Object partiallyComputedResult, List throwables)
          Deprecated.  
IncompleteOperationException(Object partiallyComputedResult, List throwables, boolean logExceptionOnCreation)
          Deprecated.  
IncompleteOperationException(Object partiallyComputedResult, List throwables, String message)
          Construct object of class IncompleteOperationException.
IncompleteOperationException(Object partiallyComputedResult, List throwables, String message, boolean logExceptionOnCreation)
          Construct object of class IncompleteOperationException.
IncompleteOperationException(Object partiallyComputedResult, List throwables, String message, Object[] args)
          Construct object of class IncompleteOperationException.
IncompleteOperationException(Object partiallyComputedResult, List throwables, String aTextKey, Object[] messageParameters, boolean log)
          Constructs a new MultipleBaseException with a list of throwables, a partially computed result and an independent message bundle
IncompleteOperationException(Object partiallyComputedResult, List throwables, String message, Object[] args, Throwable rootCause)
          Deprecated.  
IncompleteOperationException(Object partiallyComputedResult, List throwables, String message, Object[] args, Throwable rootCause, boolean logExceptionOnCreation)
          Deprecated.  
IncompleteOperationException(Object partiallyComputedResult, List throwables, String message, Throwable rootCause)
          Deprecated.  
IncompleteOperationException(Object partiallyComputedResult, List throwables, String message, Throwable rootCause, boolean logExceptionOnCreation)
          Deprecated.  
IncompleteOperationException(Object partiallyComputedResult, List throwables, Throwable rootCause)
          Deprecated.  
IncompleteOperationException(Object partiallyComputedResult, List throwables, Throwable rootCause, boolean logExceptionOnCreation)
          Deprecated.  
IncompleteOperationException(Throwable aCausingThrowable, String aTextKey, Object[] messageParameters, boolean log)
          constructs a new MultipleBaseException with a causing throwable for exception chaining.
 
Method Summary
 List getMessages()
           
 Object getPartiallyComputedResult()
          Get partially computed result.
 List getThrowables()
          Get list of throwables for all failed parts.
 void printStackTrace(PrintStream stream)
          overwrites the original printStackTrace method to also print chained stack traces.
 void printStackTrace(PrintWriter writer)
          overwrites the original printStackTrace method to also print chained stack traces.
 
Methods inherited from class com.sap.ip.collaboration.core.api.util.exception.BaseException
getCausingThrowable, getMessage, getMessage, getRootThrowable, getText, isLogged, logException, printStackTrace
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IncompleteOperationException

public IncompleteOperationException(Throwable aCausingThrowable,
                                    String aTextKey,
                                    Object[] messageParameters,
                                    boolean log)
constructs a new MultipleBaseException with a causing throwable for exception chaining. The exception message is taken from the root exception.

Parameters:
aCausingThrowable - causing throwable for exception chaining, of null if there is no causing exception
log - true, if exception should be logged

IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    String aTextKey,
                                    Object[] messageParameters,
                                    boolean log)
Constructs a new MultipleBaseException with a list of throwables, a partially computed result and an independent message bundle

Parameters:
partiallyComputedResult - partially computed result
throwables - list of throwables for all failed parts
aTextKey - key for an internationalized message, or null if no new message should be set
messageParameters - objects to fill message place holders, or null if there are no parameters to use the default mechanism to read text messages
log - true, if exception should be logged during its creation

IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables)
Deprecated. 


IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    Throwable rootCause)
Deprecated. 


IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    boolean logExceptionOnCreation)
Deprecated. 


IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    Throwable rootCause,
                                    boolean logExceptionOnCreation)
Deprecated. 


IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    String message,
                                    Throwable rootCause)
Deprecated. 


IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    String message,
                                    Object[] args,
                                    Throwable rootCause)
Deprecated. 


IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    String message,
                                    Throwable rootCause,
                                    boolean logExceptionOnCreation)
Deprecated. 


IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    String message,
                                    Object[] args,
                                    Throwable rootCause,
                                    boolean logExceptionOnCreation)
Deprecated. 


IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    String message)
Construct object of class IncompleteOperationException.

Parameters:
partiallyComputedResult - partially computed result
throwables - list of throwables for all failed parts
message - not localized message

IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    String message,
                                    Object[] args)
Construct object of class IncompleteOperationException.

Parameters:
partiallyComputedResult - partially computed result
throwables - list of throwables for all failed parts
message - not localized message
args - message arguments inserted by MessageFormat means

IncompleteOperationException

public IncompleteOperationException(Object partiallyComputedResult,
                                    List throwables,
                                    String message,
                                    boolean logExceptionOnCreation)
Construct object of class IncompleteOperationException.

Parameters:
partiallyComputedResult - partially computed result
throwables - list of throwables for all failed parts
message - not localized message
logExceptionOnCreation - when true log the exception now during its construction
Method Detail

getPartiallyComputedResult

public Object getPartiallyComputedResult()
Get partially computed result.

Returns:
partially computed result

getThrowables

public List getThrowables()
Get list of throwables for all failed parts.

Returns:
list of throwables for all failed parts

getMessages

public List getMessages()

printStackTrace

public void printStackTrace(PrintStream stream)
overwrites the original printStackTrace method to also print chained stack traces.

Specified by:
printStackTrace in interface IBaseException
Overrides:
printStackTrace in class BaseException
Parameters:
stream - PrintStream for output

printStackTrace

public void printStackTrace(PrintWriter writer)
overwrites the original printStackTrace method to also print chained stack traces.

Specified by:
printStackTrace in interface IBaseException
Overrides:
printStackTrace in class BaseException
Parameters:
writer - PrintWriter for output
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[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
[sap.com] KMC-CM [sap.com] tc/km/frwk api EP-KM-CM


Copyright 2012 SAP AG Complete Copyright Notice