wt.sandbox
Class SandboxValidationException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          wt.util.WTException
              wt.sandbox.SandboxException
                  wt.sandbox.SandboxValidationException

All Implemented Interfaces:

LocalizableMessage, Message, Serializable

public class SandboxValidationException

extends SandboxException

implements Serializable

General exception to denote one or more error conditions discovered in the process of validating a sandbox operation.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private Map	additionalErrorsToCausalObjectsMap
private Map	additionalErrorsToErrorMessagesMap
static String	CANNOT_CHECK_OUT_LOCKED_OBJECTS
static String	CANNOT_CHECK_OUT_WIP_CHECKEDOUT_OBJECT
static String	CANNOT_DELETE_CONTAINER_WITH_WORKING_COPIES
static String	CANNOT_DELETE_SANDBOX_WORKING_COPY
static String	CANNOT_SB_CHECK_OUT_PERSONAL_CABINET_ENTRY
static String	CANNOT_SB_CHECKIN_OBJ_NOT_CHECKED_OUT
static String	CANNOT_SB_CHECKIN_OBJ_NOT_IN_PROJECT
static String	CANNOT_SB_CHECKIN_TERMINAL_OBJ
static String	CANNOT_SB_CHECKIN_WHILE_WIP_CHECKED_OUT
static String	CANNOT_SB_CHECKIN_WITH_NON_LATEST_ITERATIONS
static String	CANNOT_SB_CHECKIN_WITHOUT_INITIAL_CHECKIN_DATA
static String	CANNOT_SB_CHECKOUT_NON_LATEST_ITERATIONS
static String	CANNOT_UNDO_SB_CHECKOUT_INVALID_DATA_STATE
static String	CANNOT_UNDO_SB_CHECKOUT_NON_LATEST_ITERATIONS
static String	CANNOT_UNDO_SB_CHECKOUT_NOT_CHECKED_OUT
static String	CANNOT_UNDO_SB_CHECKOUT_WHILE_WIP
private WTKeyedMap	causalObjectToIdentityMap
private static String	CLASSNAME
private String	errorCode
private boolean	hasMultipleErrors
static String	MULTI_VERSION_SB_CHECKOUT
static String	MULTIPLE_CAUSES
static String	OBJECT_CHECKED_OUT_TO_ANOTHER_SANDBOX
static String	OTHER_VERSION_CHECKED_OUT_TO_SANDBOX
private static String	RESOURCE
static String	SANDBOX_VERSION_ALREADY_CHECKED_OUT
static String	USER_CANNOT_UNLOCK_OBJECTS
static String	USER_HAS_NO_MODIFY_PRIVILEGES

Fields inherited from class wt.util.WTException

GETMESSAGE_LINE_SEPARATOR, LINE_SEPARATOR, SPACE_SEPARATOR, TOSTRING_LINE_SEPARATOR

Fields inherited from class java.lang.Exception

Fields inherited from class java.lang.Throwable

Constructor Summary

	SandboxValidationException()
private	SandboxValidationException(Throwable t, String errorCode, Object[] additionalMessages, Map additionalErrorsToCausalObjectsMap, WTKeyedMap causalObjectToIdentityMap, Map additionalErrorsToErrorMessagesMap)

Method Summary

private static Object[]	getAdditionalMessages(Map additionalErrorsToCausalObjectsMap, WTKeyedMap causalObjectToIdentityMap, Map additionalErrorsToErrorMessagesMap) Compute appropriate "additional" messages for display from overall set of errors and objects.
DisplayIdentity[]	getCausalIdentitiesForPartialErrorCode(String partialErrorCode) Get display identities of objects causing a given partial error code.
WTSet	getCausalObjects() Return set of all objects which caused the errors.
WTCollection	getCausalObjectsForPartialErrorCode(String partialErrorCode) Returns collection of objects causing a given partial error.
String	getErrorCode() Returns the overall error code.
WTMessage	getMessageForPartialErrorCode(String partialErrorCode) Returns error message for a given partial error code.
String[]	getPartialErrorCodes() Returns partial error codes, i.e.
boolean	hasMultipleErrors() Returns true if and only if this exception contains multiple errors.
(package private) static SandboxValidationException	newSandboxValidationException(Map exceptionCodesToCausalObjects)
(package private) static SandboxValidationException	newSandboxValidationException(String errorCode, WTCollection causalObjects)
private static SandboxValidationException	newSandboxValidationException(Throwable t, Map exceptionCodesToCausalObjects)

Methods inherited from class wt.util.WTException

getAdditionalMessageArray, getAdditionalMessages, getAdditionalMessages, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getNestedExceptionString, getNestedExceptionString, getNestedThrowable, getStandardMessage, getStandardMessage, printStackTrace, printStackTrace, printStackTrace, setLocalizedMessage, toString, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getMessage, getStackTrace, initCause, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

MULTIPLE_CAUSES

public static final String MULTIPLE_CAUSES

See Also:

Constant Field Values

CANNOT_SB_CHECKOUT_NON_LATEST_ITERATIONS

public static final String CANNOT_SB_CHECKOUT_NON_LATEST_ITERATIONS

See Also:

Constant Field Values

USER_HAS_NO_MODIFY_PRIVILEGES

public static final String USER_HAS_NO_MODIFY_PRIVILEGES

See Also:

Constant Field Values

CANNOT_CHECK_OUT_WIP_CHECKEDOUT_OBJECT

public static final String CANNOT_CHECK_OUT_WIP_CHECKEDOUT_OBJECT

See Also:

Constant Field Values

CANNOT_SB_CHECK_OUT_PERSONAL_CABINET_ENTRY

public static final String CANNOT_SB_CHECK_OUT_PERSONAL_CABINET_ENTRY

See Also:

Constant Field Values

SANDBOX_VERSION_ALREADY_CHECKED_OUT

public static final String SANDBOX_VERSION_ALREADY_CHECKED_OUT

See Also:

Constant Field Values

OBJECT_CHECKED_OUT_TO_ANOTHER_SANDBOX

public static final String OBJECT_CHECKED_OUT_TO_ANOTHER_SANDBOX

See Also:

Constant Field Values

CANNOT_CHECK_OUT_LOCKED_OBJECTS

public static final String CANNOT_CHECK_OUT_LOCKED_OBJECTS

See Also:

Constant Field Values

OTHER_VERSION_CHECKED_OUT_TO_SANDBOX

public static final String OTHER_VERSION_CHECKED_OUT_TO_SANDBOX

See Also:

Constant Field Values

CANNOT_UNDO_SB_CHECKOUT_INVALID_DATA_STATE

public static final String CANNOT_UNDO_SB_CHECKOUT_INVALID_DATA_STATE

See Also:

Constant Field Values

CANNOT_UNDO_SB_CHECKOUT_NON_LATEST_ITERATIONS

public static final String CANNOT_UNDO_SB_CHECKOUT_NON_LATEST_ITERATIONS

See Also:

Constant Field Values

CANNOT_UNDO_SB_CHECKOUT_WHILE_WIP

public static final String CANNOT_UNDO_SB_CHECKOUT_WHILE_WIP

See Also:

Constant Field Values

CANNOT_UNDO_SB_CHECKOUT_NOT_CHECKED_OUT

public static final String CANNOT_UNDO_SB_CHECKOUT_NOT_CHECKED_OUT

See Also:

Constant Field Values

USER_CANNOT_UNLOCK_OBJECTS

public static final String USER_CANNOT_UNLOCK_OBJECTS

See Also:

Constant Field Values

CANNOT_SB_CHECKIN_WITH_NON_LATEST_ITERATIONS

public static final String CANNOT_SB_CHECKIN_WITH_NON_LATEST_ITERATIONS

See Also:

Constant Field Values

CANNOT_SB_CHECKIN_WHILE_WIP_CHECKED_OUT

public static final String CANNOT_SB_CHECKIN_WHILE_WIP_CHECKED_OUT

See Also:

Constant Field Values

CANNOT_SB_CHECKIN_TERMINAL_OBJ

public static final String CANNOT_SB_CHECKIN_TERMINAL_OBJ

See Also:

Constant Field Values

CANNOT_SB_CHECKIN_OBJ_NOT_IN_PROJECT

public static final String CANNOT_SB_CHECKIN_OBJ_NOT_IN_PROJECT

See Also:

Constant Field Values

CANNOT_SB_CHECKIN_OBJ_NOT_CHECKED_OUT

public static final String CANNOT_SB_CHECKIN_OBJ_NOT_CHECKED_OUT

See Also:

Constant Field Values

CANNOT_SB_CHECKIN_WITHOUT_INITIAL_CHECKIN_DATA

public static final String CANNOT_SB_CHECKIN_WITHOUT_INITIAL_CHECKIN_DATA

See Also:

Constant Field Values

CANNOT_DELETE_CONTAINER_WITH_WORKING_COPIES

public static final String CANNOT_DELETE_CONTAINER_WITH_WORKING_COPIES

See Also:

Constant Field Values

CANNOT_DELETE_SANDBOX_WORKING_COPY

public static final String CANNOT_DELETE_SANDBOX_WORKING_COPY

See Also:

Constant Field Values

MULTI_VERSION_SB_CHECKOUT

public static final String MULTI_VERSION_SB_CHECKOUT

See Also:

Constant Field Values

errorCode

private String errorCode

hasMultipleErrors

private boolean hasMultipleErrors

causalObjectToIdentityMap

private WTKeyedMap causalObjectToIdentityMap

additionalErrorsToCausalObjectsMap

private Map additionalErrorsToCausalObjectsMap

additionalErrorsToErrorMessagesMap

private Map additionalErrorsToErrorMessagesMap

Constructor Detail

SandboxValidationException

public SandboxValidationException()

SandboxValidationException

private SandboxValidationException(Throwable t,
                                   String errorCode,
                                   Object[] additionalMessages,
                                   Map additionalErrorsToCausalObjectsMap,
                                   WTKeyedMap causalObjectToIdentityMap,
                                   Map additionalErrorsToErrorMessagesMap)

Method Detail

getErrorCode

public String getErrorCode()

Returns the overall error code.

Supported API: false

Returns:

String

getCausalObjects

public WTSet getCausalObjects()

Return set of all objects which caused the errors.

Supported API: false

Returns:

WTSet

hasMultipleErrors

public boolean hasMultipleErrors()

Returns true if and only if this exception contains multiple errors.

Supported API: false

Returns:

boolean

getPartialErrorCodes

public String[] getPartialErrorCodes()

Returns partial error codes, i.e. individual, more specific error codes when the exception is aggregating multiple errors.

Supported API: false

Returns:

String[]

getCausalObjectsForPartialErrorCode

public WTCollection getCausalObjectsForPartialErrorCode(String partialErrorCode)

Returns collection of objects causing a given partial error.

Supported API: false

Parameters:

partialErrorCode - partial error code

Returns:

WTCollection

getMessageForPartialErrorCode

public WTMessage getMessageForPartialErrorCode(String partialErrorCode)

Returns error message for a given partial error code.

Supported API: false

Parameters:

partialErrorCode - partial error code

Returns:

WTMessage

getCausalIdentitiesForPartialErrorCode

public DisplayIdentity[] getCausalIdentitiesForPartialErrorCode(String partialErrorCode)

Get display identities of objects causing a given partial error code.

Supported API: false

Parameters:

partialErrorCode - partial error code

Returns:

DisplayIdentity[]

newSandboxValidationException

static SandboxValidationException newSandboxValidationException(String errorCode,
                                                                WTCollection causalObjects)
                                                         throws WTException

Throws:

WTException

newSandboxValidationException

static SandboxValidationException newSandboxValidationException(Map exceptionCodesToCausalObjects)
                                                         throws WTException

Throws:

WTException

newSandboxValidationException

private static SandboxValidationException newSandboxValidationException(Throwable t,
                                                                        Map exceptionCodesToCausalObjects)
                                                                 throws WTException

Throws:

WTException

getAdditionalMessages

private static Object[] getAdditionalMessages(Map additionalErrorsToCausalObjectsMap,
                                              WTKeyedMap causalObjectToIdentityMap,
                                              Map additionalErrorsToErrorMessagesMap)

Compute appropriate "additional" messages for display from overall set of errors and objects.