Package com.unboundid.directory.sdk.common.types

Class PreManageExtensionPluginResult

java.lang.Object

com.unboundid.directory.sdk.common.types.PreManageExtensionPluginResult

All Implemented Interfaces:

java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class PreManageExtensionPluginResult
extends java.lang.Object
implements java.io.Serializable

This class defines a structure which may be used to provide information about the result of the processing performed by a manage extension plugin.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static PreManageExtensionPluginResult	SUCCESS	A predefined result instance that indicates all processing completed successfully.

Constructor Summary

Constructors

Constructor	Description
PreManageExtensionPluginResult(boolean continueInstallation, java.util.List<java.lang.String> messages)	Creates a new pre manage extension plugin result with the provided information.

Method Summary

Modifier and Type	Method	Description
boolean	continueInstallation()	Indicates whether the manage-extension tool should continue with the installation.
java.util.List<java.lang.String>	getMessages()	Retrieves the list of messages to print to the console.
java.lang.String	toString()	Retrieves a string representation of this pre manage extension plugin result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SUCCESS

public static final PreManageExtensionPluginResult SUCCESS

A predefined result instance that indicates all processing completed successfully.

Constructor Detail

PreManageExtensionPluginResult

public PreManageExtensionPluginResult(boolean continueInstallation,
                                      java.util.List<java.lang.String> messages)

Creates a new pre manage extension plugin result with the provided information.

Parameters:

continueInstallation - Indicates whether the manage-extension tool should continue with the installation.

messages - Messages to print to the console or null.

Method Detail

continueInstallation

public boolean continueInstallation()

Indicates whether the manage-extension tool should continue with the installation.

Returns:

true the manage-extension tool should continue with the installation, or false if not.

getMessages

public java.util.List<java.lang.String> getMessages()

Retrieves the list of messages to print to the console.

Returns:

The list of messages to print to the console or null if no messages are to be printed.

toString

public java.lang.String toString()

Retrieves a string representation of this pre manage extension plugin result.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this pre manage extension plugin result.