Project: stp

com.ibm.rational.wvcm.stp
Class StpPartialResultsException

Object
  extended by Throwable
      extended by Exception
          extended by javax.wvcm.WvcmException
              extended by com.ibm.rational.wvcm.stp.StpException
                  extended by com.ibm.rational.wvcm.stp.StpPropertyException
                      extended by com.ibm.rational.wvcm.stp.StpPartialResultsException
All Implemented Interfaces:
Serializable

public abstract class StpPartialResultsException
extends StpPropertyException

An exception used to convey information about an operation that failed on some, but not necessarily all, resources processed by the operation.

See Also:
Serialized Form

Nested Class Summary
static interface StpPartialResultsException.PartialResultsData
          The interface for the data implementation object for this type of exception
 
Nested classes/interfaces inherited from class com.ibm.rational.wvcm.stp.StpPropertyException
StpPropertyException.PropertyData
 
Nested classes/interfaces inherited from class com.ibm.rational.wvcm.stp.StpException
StpException.Data, StpException.StpReasonCode
 
Nested classes/interfaces inherited from class javax.wvcm.WvcmException
WvcmException.ReasonCode
 
Method Summary
 boolean enumerationError()
          Returns whether or not the ResourceList of successful resources and the list of nested exceptions account for all the resources that were supposed to be operated on.
 ResourceList<Resource> resourceList()
          Returns the list of resources on which the operation succeeded.
 
Methods inherited from class com.ibm.rational.wvcm.stp.StpPropertyException
getPropertyName
 
Methods inherited from class com.ibm.rational.wvcm.stp.StpException
data, getMessage, getStpReasonCode, toString, unchecked_cast
 
Methods inherited from class javax.wvcm.WvcmException
getNestedExceptions, getReasonCode, getResource
 
Methods inherited from class Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

enumerationError

public boolean enumerationError()
Returns whether or not the ResourceList of successful resources and the list of nested exceptions account for all the resources that were supposed to be operated on. If this field is true, there may be resources on which the operation was not performed and hence are neither reported as succeeding or as failing; the failure mode of the operation was such that the remaining operands could not be processed.

Returns:
true if all the potential operands could not be enumerated; false if all the operands could be enumerated but the operation failed on at least one of them.

resourceList

public ResourceList<Resource> resourceList()
Returns the list of resources on which the operation succeeded.

Returns:
A ResourceList containing a proxy for each resource on which the operation succeeded. Any requested properties will be defined by these proxies.

Generated Tue 22-May-2012 12:04 PM

Copyright © IBM 2012. All rights reserved.