Project: stp

javax.wvcm
Enum WvcmException.ReasonCode

Object
  extended by Enum<WvcmException.ReasonCode>
      extended by javax.wvcm.WvcmException.ReasonCode
All Implemented Interfaces:
Serializable, Comparable<WvcmException.ReasonCode>
Enclosing class:
WvcmException

public static enum WvcmException.ReasonCode
extends Enum<WvcmException.ReasonCode>

The reason code for a WvcmException.


Enum Constant Summary
ABORTED
          Method execution was aborted via notification to the Feedback object.
ADD_MUST_BE_NEW_LABEL
          The label is already in use by this resource.
BAD_ARGUMENT_TYPE
          The type of the persistent resource identified by this argument was not compatible with the specified argument type.
CANNOT_CHECKIN_FORK_DISCOURAGED
          Cannot checkin since it would cause a fork and forking is discouraged.
CANNOT_CHECKIN_TO_RESERVED_ACTIVITY
          Failed because there is a reserved checkout of a version in this version history.
CANNOT_CHECKOUT_FORKING_IS_DISCOURAGED
          Failed to checkout because descendant already exists and forking is discouraged.
CANNOT_CHECKOUT_FORKING_IS_FORBIDDEN
          Failed to checkout because descendant already exists and forking is forbidden.
CANNOT_CHECKOUT_MULTI_CHECKOUT_IS_DISCOURAGED
          Failed to checkout resource because multiple checkout is discouraged and the caller did not specify fork-ok.
CANNOT_CHECKOUT_MULTI_CHECKOUT_IS_FORBIDDEN
          Checkout of an already checked-out resource is forbidden.
CANNOT_CREATE_AT_THIS_LOCATION
          Cannot create this resource at the specified location.
CANNOT_CREATE_BRANCH_IN_ACTIVITY
          Each version in an activity for a given version history must be on the same line of descent.
CANNOT_CREATE_BRANCH_IN_STREAM
          Each version in a stream for a given version history must be on the same line of descent.
CANNOT_FORK
          A fork in the version tree is not allowed.
CANNOT_HAVE_CONTROLLED_MEMBERS
          baseline control failed because the folder already has controlled resources.
CANNOT_HAVE_MULTIPLE_BASELINE_CONTROLLED_FOLDERS
          A baseline controlled folder already exists in this workspace for this baseline history.
CANNOT_MERGE_CHECKOUT_NOT_ALLOWED
          Failed to perform the merge because the target could not be checked-out.
CANNOT_MODIFY_PROTECTED_PROPERTY
          Operation failed because it attempted to set a protected property.
CANNOT_MODIFY_VERSION
          Failed to modify content/properties because the resource specified was a version.
CANNOT_OVERWRITE
          Cannot overwrite existing binding.
CANNOT_REMOVE_LABEL_DOES_NOT_EXIST
          Cannot remove the specified label because it does not used by this resource.
CONFLICT
          The operation could not be completed because of a conflict with the current state of the resource.
CONTROLLED_CONFIGURATION_ALREADY_EXISTS
          This folder already has a configuration.
CYCLE_NOT_ALLOWED
          Cannot create location cycle.
FORBIDDEN
          The provider understood the request, but is refusing to fulfill it.
ILLEGAL_LOCATION_SYNTAX
          Illegal syntax for location string value.
METHOD_NOT_SUPPORTED
          Report failed since the resource does not support the specified report.
MULTI_STATUS
          Method failed on some of the specified resources.
MUST_BE_CHECKED_IN
          The operation failed because the resource must be in the checked-in state.
MUST_BE_CHECKED_OUT
          The operation failed because the resource must be in the checked-out state.
NO_CHECKED_OUT_BASELINE_CONTROLLED_FOLDER_MEMBERS
          Failed to checkin the configuration because some of it's members are still checked-out.
NO_CROSS_SERVER_BINDING
          Cannot create cross-server binding.
NOT_FOUND
          The provider has not found anything matching the location of the proxy.
ONE_CHECKOUT_PER_ACTIVITY_PER_HISTORY
          Failed because more than one version of this resource is referenced in the specified activity.
ONE_CONTROLLED_RESOURCE_PER_HISTORY_PER_WORKSPACE
          The operation failed because it would result in more than one controlled resource for this version history in a workspace.
PROPERTY_NOT_CURRENTLY_AVAILABLE
          A potentially recoverable condition prevented the server from retrieving the property.
PROPERTY_NOT_DEFINED_FOR_RESOURCE
          The property is not valid for this resource.
PROPERTY_NOT_REQUESTED
          The property value is unavailable because it was not in the property name list when the proxy was created.
PROPERTY_NOT_SUPPORTED_BY_SERVER
          Even though the specification says the property is valid for the targeted resource, the server does not support it.
PROPERTY_OVERWRITE_FORBIDDEN
          The property value update would overwrite an earlier change.
READ_FAILED
          The provider suffered an I/O failure, the operation may be retried.
RESOURCE_ALREADY_EXISTS_AT_LOCATION
          Creating a resource failed because a resource already exists at the specified location.
UNAUTHORIZED
          The user is not authorized to execute the attempted operation.
VERSION_HISTORY_MUST_BE_A_TREE
          Cannot checkin because the resources predecessors are not descendants of the root of the version history.
VERSION_NOT_SUPPORTED
          The provider understood the request, but is refusing to fulfill it due to suspected version incompatibility with the client.
WRITE_FAILED
          The provider suffered an I/O failure, the operation may be retried.
 
Method Summary
static WvcmException.ReasonCode getReasonCodeForRFC3253Condition(String condition)
          The ReasonCode for an RFC 3253 pre- or post-condition.
 String toString()
          Returns a string representation of this ReasonCode suitable for diagnostics.
static WvcmException.ReasonCode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static WvcmException.ReasonCode[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ABORTED

public static final WvcmException.ReasonCode ABORTED
Method execution was aborted via notification to the Feedback object.


ADD_MUST_BE_NEW_LABEL

public static final WvcmException.ReasonCode ADD_MUST_BE_NEW_LABEL
The label is already in use by this resource.


BAD_ARGUMENT_TYPE

public static final WvcmException.ReasonCode BAD_ARGUMENT_TYPE
The type of the persistent resource identified by this argument was not compatible with the specified argument type.


CANNOT_CHECKIN_FORK_DISCOURAGED

public static final WvcmException.ReasonCode CANNOT_CHECKIN_FORK_DISCOURAGED
Cannot checkin since it would cause a fork and forking is discouraged.


CANNOT_CHECKIN_TO_RESERVED_ACTIVITY

public static final WvcmException.ReasonCode CANNOT_CHECKIN_TO_RESERVED_ACTIVITY
Failed because there is a reserved checkout of a version in this version history.


CANNOT_CHECKOUT_FORKING_IS_DISCOURAGED

public static final WvcmException.ReasonCode CANNOT_CHECKOUT_FORKING_IS_DISCOURAGED
Failed to checkout because descendant already exists and forking is discouraged.


CANNOT_CHECKOUT_FORKING_IS_FORBIDDEN

public static final WvcmException.ReasonCode CANNOT_CHECKOUT_FORKING_IS_FORBIDDEN
Failed to checkout because descendant already exists and forking is forbidden.


CANNOT_CHECKOUT_MULTI_CHECKOUT_IS_DISCOURAGED

public static final WvcmException.ReasonCode CANNOT_CHECKOUT_MULTI_CHECKOUT_IS_DISCOURAGED
Failed to checkout resource because multiple checkout is discouraged and the caller did not specify fork-ok.


CANNOT_CHECKOUT_MULTI_CHECKOUT_IS_FORBIDDEN

public static final WvcmException.ReasonCode CANNOT_CHECKOUT_MULTI_CHECKOUT_IS_FORBIDDEN
Checkout of an already checked-out resource is forbidden.


CANNOT_CREATE_AT_THIS_LOCATION

public static final WvcmException.ReasonCode CANNOT_CREATE_AT_THIS_LOCATION
Cannot create this resource at the specified location.


CANNOT_CREATE_BRANCH_IN_ACTIVITY

public static final WvcmException.ReasonCode CANNOT_CREATE_BRANCH_IN_ACTIVITY
Each version in an activity for a given version history must be on the same line of descent.


CANNOT_CREATE_BRANCH_IN_STREAM

public static final WvcmException.ReasonCode CANNOT_CREATE_BRANCH_IN_STREAM
Each version in a stream for a given version history must be on the same line of descent.


CANNOT_FORK

public static final WvcmException.ReasonCode CANNOT_FORK
A fork in the version tree is not allowed.


CANNOT_HAVE_CONTROLLED_MEMBERS

public static final WvcmException.ReasonCode CANNOT_HAVE_CONTROLLED_MEMBERS
baseline control failed because the folder already has controlled resources.


CANNOT_HAVE_MULTIPLE_BASELINE_CONTROLLED_FOLDERS

public static final WvcmException.ReasonCode CANNOT_HAVE_MULTIPLE_BASELINE_CONTROLLED_FOLDERS
A baseline controlled folder already exists in this workspace for this baseline history.


CANNOT_MERGE_CHECKOUT_NOT_ALLOWED

public static final WvcmException.ReasonCode CANNOT_MERGE_CHECKOUT_NOT_ALLOWED
Failed to perform the merge because the target could not be checked-out.


CANNOT_MODIFY_PROTECTED_PROPERTY

public static final WvcmException.ReasonCode CANNOT_MODIFY_PROTECTED_PROPERTY
Operation failed because it attempted to set a protected property.


CANNOT_MODIFY_VERSION

public static final WvcmException.ReasonCode CANNOT_MODIFY_VERSION
Failed to modify content/properties because the resource specified was a version.


CANNOT_OVERWRITE

public static final WvcmException.ReasonCode CANNOT_OVERWRITE
Cannot overwrite existing binding.


CANNOT_REMOVE_LABEL_DOES_NOT_EXIST

public static final WvcmException.ReasonCode CANNOT_REMOVE_LABEL_DOES_NOT_EXIST
Cannot remove the specified label because it does not used by this resource.


CONFLICT

public static final WvcmException.ReasonCode CONFLICT
The operation could not be completed because of a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and attempt the operation again. The exception message and data SHOULD include enough information for the user to recognize the source of the conflict. Ideally, the exception would include enough information for the user or user agent to fix the problem; however, that might not be possible and is not required. Conflicts are most likely to occur in response to an update operation. For example, if versioning were being used and the entity being updated included changes to a resource that conflict with those made by an earlier (third-party) operation, the provider might use the CONFLICT reason code to indicate that it can't complete the request. In this case, the exception would likely contain a list of the differences between the two versions in a format defined by the exception subclass documentation.

This ReasonCode can be thrown by any method that contacts the server, i.e. any doXyz() method.


CONTROLLED_CONFIGURATION_ALREADY_EXISTS

public static final WvcmException.ReasonCode CONTROLLED_CONFIGURATION_ALREADY_EXISTS
This folder already has a configuration.


CYCLE_NOT_ALLOWED

public static final WvcmException.ReasonCode CYCLE_NOT_ALLOWED
Cannot create location cycle.


FORBIDDEN

public static final WvcmException.ReasonCode FORBIDDEN
The provider understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated. If the provider wishes to make public why the operation has not been successful, it SHOULD describe the reason for the refusal in the message. If the provider does not wish to make this information available to the client, the reason code NOT_FOUND can be used instead.

This ReasonCode can be thrown by any method that contacts the server, i.e. any doXyz() method.


ILLEGAL_LOCATION_SYNTAX

public static final WvcmException.ReasonCode ILLEGAL_LOCATION_SYNTAX
Illegal syntax for location string value.


METHOD_NOT_SUPPORTED

public static final WvcmException.ReasonCode METHOD_NOT_SUPPORTED
Report failed since the resource does not support the specified report.


MULTI_STATUS

public static final WvcmException.ReasonCode MULTI_STATUS
Method failed on some of the specified resources.


MUST_BE_CHECKED_IN

public static final WvcmException.ReasonCode MUST_BE_CHECKED_IN
The operation failed because the resource must be in the checked-in state.


MUST_BE_CHECKED_OUT

public static final WvcmException.ReasonCode MUST_BE_CHECKED_OUT
The operation failed because the resource must be in the checked-out state.


NO_CHECKED_OUT_BASELINE_CONTROLLED_FOLDER_MEMBERS

public static final WvcmException.ReasonCode NO_CHECKED_OUT_BASELINE_CONTROLLED_FOLDER_MEMBERS
Failed to checkin the configuration because some of it's members are still checked-out.


NO_CROSS_SERVER_BINDING

public static final WvcmException.ReasonCode NO_CROSS_SERVER_BINDING
Cannot create cross-server binding.


NOT_FOUND

public static final WvcmException.ReasonCode NOT_FOUND
The provider has not found anything matching the location of the proxy. No indication is given whether the condition is temporary or permanent. This reason code is commonly used when the server does not wish to reveal exactly why the operation has been refused, or when no other response is applicable.

This ReasonCode can be thrown by any method that contacts the server, i.e. any doXyz() method.


ONE_CHECKOUT_PER_ACTIVITY_PER_HISTORY

public static final WvcmException.ReasonCode ONE_CHECKOUT_PER_ACTIVITY_PER_HISTORY
Failed because more than one version of this resource is referenced in the specified activity.


ONE_CONTROLLED_RESOURCE_PER_HISTORY_PER_WORKSPACE

public static final WvcmException.ReasonCode ONE_CONTROLLED_RESOURCE_PER_HISTORY_PER_WORKSPACE
The operation failed because it would result in more than one controlled resource for this version history in a workspace.


PROPERTY_NOT_CURRENTLY_AVAILABLE

public static final WvcmException.ReasonCode PROPERTY_NOT_CURRENTLY_AVAILABLE
A potentially recoverable condition prevented the server from retrieving the property. This ReasonCode can be thrown by any method defined to return a property value from a proxy, i.e., any method of the form getXyz().


PROPERTY_NOT_DEFINED_FOR_RESOURCE

public static final WvcmException.ReasonCode PROPERTY_NOT_DEFINED_FOR_RESOURCE
The property is not valid for this resource.

This ReasonCode can be thrown by any method defined to return a property value from a proxy, i.e., any method of the form getXyz().


PROPERTY_NOT_REQUESTED

public static final WvcmException.ReasonCode PROPERTY_NOT_REQUESTED
The property value is unavailable because it was not in the property name list when the proxy was created.

This ReasonCode can be thrown by any method defined to return a property value from a proxy, i.e., any method of the form getXyz().


PROPERTY_NOT_SUPPORTED_BY_SERVER

public static final WvcmException.ReasonCode PROPERTY_NOT_SUPPORTED_BY_SERVER
Even though the specification says the property is valid for the targeted resource, the server does not support it.

This ReasonCode can be thrown by any method defined to return a property value from a proxy, i.e., any method of the form getXyz().


PROPERTY_OVERWRITE_FORBIDDEN

public static final WvcmException.ReasonCode PROPERTY_OVERWRITE_FORBIDDEN
The property value update would overwrite an earlier change.


READ_FAILED

public static final WvcmException.ReasonCode READ_FAILED
The provider suffered an I/O failure, the operation may be retried.

This ReasonCode can be thrown by any method that reads information from the server or a persistent store.


RESOURCE_ALREADY_EXISTS_AT_LOCATION

public static final WvcmException.ReasonCode RESOURCE_ALREADY_EXISTS_AT_LOCATION
Creating a resource failed because a resource already exists at the specified location.


UNAUTHORIZED

public static final WvcmException.ReasonCode UNAUTHORIZED
The user is not authorized to execute the attempted operation.

This ReasonCode can be thrown by any method.


VERSION_HISTORY_MUST_BE_A_TREE

public static final WvcmException.ReasonCode VERSION_HISTORY_MUST_BE_A_TREE
Cannot checkin because the resources predecessors are not descendants of the root of the version history.


VERSION_NOT_SUPPORTED

public static final WvcmException.ReasonCode VERSION_NOT_SUPPORTED
The provider understood the request, but is refusing to fulfill it due to suspected version incompatibility with the client. Authorization will not help and the request SHOULD NOT be repeated.

This ReasonCode can be thrown by any method that contacts the server, i.e. any doXyz() method.


WRITE_FAILED

public static final WvcmException.ReasonCode WRITE_FAILED
The provider suffered an I/O failure, the operation may be retried.

This ReasonCode can be thrown by any method that writes information to the server or a persistent store.

Method Detail

getReasonCodeForRFC3253Condition

public static WvcmException.ReasonCode getReasonCodeForRFC3253Condition(String condition)
The ReasonCode for an RFC 3253 pre- or post-condition.

Parameters:
condition - the RFC 3253 pre- or post- condition local name.
Returns:
the corresponding ReasonCode.

toString

public String toString()
Returns a string representation of this ReasonCode suitable for diagnostics.

Overrides:
toString in class Enum<WvcmException.ReasonCode>

valueOf

public static WvcmException.ReasonCode valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name

values

public static final WvcmException.ReasonCode[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(WvcmException.ReasonCode c : WvcmException.ReasonCode.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

Generated Thu 15-Aug-2013 10:38 PM

Copyright © IBM 2013. All rights reserved.