org.opends.server.types
Class MembershipException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by org.opends.server.types.OpenDsException
              extended by org.opends.server.types.IdentifiedException
                  extended by org.opends.server.types.MembershipException
All Implemented Interfaces:
java.io.Serializable

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=true,
           mayExtend=false,
           mayInvoke=true)
public final class MembershipException
extends IdentifiedException

This class defines an exception that may be thrown if a problem occurs while attempting to iterate across the members of a group.

See Also:
Serialized Form

Constructor Summary
MembershipException(Message errorMessage, boolean continueIterating)
          Creates a new membership exception with the provided information.
MembershipException(Message errorMessage, boolean continueIterating, java.lang.Throwable cause)
          Creates a new membership exception with the provided information.
 
Method Summary
 boolean continueIterating()
          Indicates whether it is possible to continue iterating through the list of group members.
 Message getErrorMessage()
          Retrieves the error message for this membership exception.
 
Methods inherited from class org.opends.server.types.OpenDsException
getMessageObject
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MembershipException

public MembershipException(Message errorMessage,
                           boolean continueIterating)
Creates a new membership exception with the provided information.

Parameters:
errorMessage - The error message for this membership exception.
continueIterating - Indicates whether it is possible to continue iterating through the list of group members.

MembershipException

public MembershipException(Message errorMessage,
                           boolean continueIterating,
                           java.lang.Throwable cause)
Creates a new membership exception with the provided information.

Parameters:
errorMessage - The error message for this membership exception.
continueIterating - Indicates whether it is possible to continue iterating through the list of group members.
cause - The underlying cause for this membership exception.
Method Detail

getErrorMessage

public Message getErrorMessage()
Retrieves the error message for this membership exception.

Returns:
The error message for this membership exception.

continueIterating

public boolean continueIterating()
Indicates whether it is possible to continue iterating through the list of group members.

Returns:
true if it is possible to continue iterating through the list of group members, or false if not.