org.apereo.portal.tenants

Enum TenantOperationResponse.Result

java.lang.Object

java.lang.Enum<TenantOperationResponse.Result>

org.apereo.portal.tenants.TenantOperationResponse.Result

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TenantOperationResponse.Result>

Enclosing class:

TenantOperationResponse

public static enum TenantOperationResponse.Result
extends java.lang.Enum<TenantOperationResponse.Result>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT Indicates the ITenantOperationsListener was not successful and that the operation should be cancelled and, if possible, rolled back.
FAIL Indicates the ITenantOperationsListener was not successful, but stops short of canceling the whole operation.
IGNORE Instructs the TenantService to keep this response out of the report.
SUCCESS Indicates the ITenantOperationsListener was successful.

Method Summary

Modifier and Type	Method and Description
static TenantOperationResponse.Result	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TenantOperationResponse.Result[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final TenantOperationResponse.Result SUCCESS

Indicates the ITenantOperationsListener was successful.

FAIL

public static final TenantOperationResponse.Result FAIL

Indicates the ITenantOperationsListener was not successful, but stops short of canceling the whole operation.

ABORT

public static final TenantOperationResponse.Result ABORT

Indicates the ITenantOperationsListener was not successful and that the operation should be cancelled and, if possible, rolled back.

IGNORE

public static final TenantOperationResponse.Result IGNORE

Instructs the TenantService to keep this response out of the report.

Method Detail

values

public static TenantOperationResponse.Result[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TenantOperationResponse.Result c : TenantOperationResponse.Result.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TenantOperationResponse.Result valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null