Package org.opends.quicksetup

Class ReturnCode

java.lang.Object

org.opends.quicksetup.ReturnCode

public class ReturnCode
extends Object

This class defines enumeration of application return code.

Field Summary

Fields

Modifier and Type	Field	Description
static ReturnCode	APPLICATION_ERROR	Application specific error.
static ReturnCode	BUG	Return code: Bug.
static ReturnCode	CANCELED	Return code: User Cancelled operation.
static ReturnCode	CONFIGURATION_ERROR	Error during the configuration of the Directory Server.
static ReturnCode	FILE_SYSTEM_ACCESS_ERROR	Return code: Error accessing file system (reading/writing).
static ReturnCode	IMPORT_ERROR	Error during the import of data (base entry, from LDIF file or automatically generated data).
static ReturnCode	JAVA_VERSION_INCOMPATIBLE	Return code: java version non-compatible.
static ReturnCode	PRINT_VERSION	Return code: Print Version.
static ReturnCode	START_ERROR	Error starting the Open DS server.
static ReturnCode	STOP_ERROR	Error stopping the Open DS server.
static ReturnCode	SUCCESSFUL	Return code: Application successful.
static ReturnCode	TOOL_ERROR	Error invoking an OpenDS tool.
static ReturnCode	UNKNOWN	Return code for errors that are non-specified.
static ReturnCode	USER_DATA_ERROR	Return code: User provided invalid data.
static ReturnCode	USER_INPUT_ERROR	Return code: user provided invalid input.
static ReturnCode	WINDOWS_SERVICE_ERROR	Error enabling the Windows service.

Method Summary

Modifier and Type	Method	Description
int	getReturnCode()	Gets the return code to return to the console.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESSFUL

public static final ReturnCode SUCCESSFUL

Return code: Application successful.

CANCELED

public static final ReturnCode CANCELED

Return code: User Cancelled operation.

USER_DATA_ERROR

public static final ReturnCode USER_DATA_ERROR

Return code: User provided invalid data.

FILE_SYSTEM_ACCESS_ERROR

public static final ReturnCode FILE_SYSTEM_ACCESS_ERROR

Return code: Error accessing file system (reading/writing).

CONFIGURATION_ERROR

public static final ReturnCode CONFIGURATION_ERROR

Error during the configuration of the Directory Server.

IMPORT_ERROR

public static final ReturnCode IMPORT_ERROR

Error during the import of data (base entry, from LDIF file or automatically generated data).

START_ERROR

public static final ReturnCode START_ERROR

Error starting the Open DS server.

STOP_ERROR

public static final ReturnCode STOP_ERROR

Error stopping the Open DS server.

WINDOWS_SERVICE_ERROR

public static final ReturnCode WINDOWS_SERVICE_ERROR

Error enabling the Windows service.

APPLICATION_ERROR

public static final ReturnCode APPLICATION_ERROR

Application specific error.

TOOL_ERROR

public static final ReturnCode TOOL_ERROR

Error invoking an OpenDS tool.

BUG

public static final ReturnCode BUG

Return code: Bug.

JAVA_VERSION_INCOMPATIBLE

public static final ReturnCode JAVA_VERSION_INCOMPATIBLE

Return code: java version non-compatible.

USER_INPUT_ERROR

public static final ReturnCode USER_INPUT_ERROR

Return code: user provided invalid input.

PRINT_VERSION

public static final ReturnCode PRINT_VERSION

Return code: Print Version.

UNKNOWN

public static final ReturnCode UNKNOWN

Return code for errors that are non-specified.

Method Detail

getReturnCode

public int getReturnCode()

Gets the return code to return to the console.

Returns:

int code

toString

public String toString()

Overrides:

toString in class Object