Project: stp

com.ibm.rational.wvcm.stp
Enum StpException.StpReasonCode

Object
  extended by Enum<StpException.StpReasonCode>
      extended by com.ibm.rational.wvcm.stp.StpException.StpReasonCode
All Implemented Interfaces:
com.ibm.rational.wvcm.stpex.StpExEnumeration, Serializable, Comparable<StpException.StpReasonCode>
Enclosing class:
StpException

public static enum StpException.StpReasonCode
extends Enum<StpException.StpReasonCode>
implements com.ibm.rational.wvcm.stpex.StpExEnumeration

An encoding of exception conditions specific to this API. Each StpReasonCode maps to one WvcmException.ReasonCode, but, because the granularity of the StpReasonCode enumeration is finer than that of the ReasonCode, the mapping may be many-to-one.

When the correspondence between an StpReasonCode and a ReasonCode is not obvious, the StpReasonCode is mapped to either ReasonCode.CONFLICT or ReasonCode.FORBIDDEN using the following rationale:

For conditions where there is not enough information to decide whether or not there is anything the client could do to retry the method, the StpReasonCode is classified as CONFLICT.


Enum Constant Summary
ACTIVITY_NEEDED
          A checkout was attempted with no explicit activity and no current activity in the workspace.
ALREADY_BEING_EDITED
          The specified record is already being edited (by the same user).
AUTHENTICATION_INFO_REQUIRED
          Authentication information is required but client didn't provide any.
BAD_REPORT
          Precondition: Report failed since the resource does not support the specified report.
BAD_REQUEST
          Request not understood or contextually incorrect for the provider.
BAD_SOURCE_STATE
          The requested action is inappropriate for the current state of the query (precondition failure)
CANNOT_CHECKIN_MUST_BE_CHECKED_OUT
          The checkin operation failed because the resource is not checked out.
CANNOT_CREATE_AT_THIS_LOCATION
          Precondition: Cannot create this resource at the specified location.
CANNOT_ENCODE_STRING
          Used when a string is not supported by the server's operating system.
CANNOT_MODIFY_PROTECTED_PROPERTY
          Precondition: Operation failed because it attempted to set a protected property.
CANNOT_OVERWRITE
          Cannot overwrite existing binding.
CANNOT_UNCHECKOUT_MUST_BE_CHECKED_OUT
          The uncheckout operation failed because the resource is not checked out.
CHECKOUT_BRANCH_NOT_MASTERED
          Checkout failed because the branch was not mastered locally.
CHECKOUT_BRTYPE_NOT_MASTERED
          Checkout failed because the branch type was not mastered locally.
CHECKOUT_NOT_LATEST
          Version being checked out is not the latest
CHILD_ORIGINAL_SOURCE_DIRECTORY_NO_LONGER_EXISTS
          Used by REVERT method
CHILDREN_OF_FOLDER_MUST_BE_REVERTED_FIRST
          Used by REVERT method
CLIENT_LOCATION_NOT_IN_FILE_AREA
          The client location is not within a file area
CONDITIONAL_EXECUTION
          A communication precondition failed
CONFLICT
          The operation cannot be performed because of a conflict with resource state.
CONNECTION_FAILED
          An operation failed because the connection to the remote server could not be established or terminated prematurely after being established.
CREDENTIALS_REQUIRED
          Used if an operation requires credentials but none were provided
DELIVER_INVALID_ACTIVITIES
          A deliver operation failed because selected activities depend on un-delivered activities.
DELIVERY_ERROR
          An attempt to deliver a resource from the change context to the database failed.
DISCONNECTED
          Used when an operation is forbidden due to operating in disconnected mode
DISCORDANCE_VERSION
          Version discordance detected
DUPLICATE_ACTIVITY_NAME
          Duplicate activity name
DUPLICATE_STREAM_NAME
          Duplicate stream name
EXTERNAL_LOCK_ALREADY_PRESENT
          This code indicates that an external lock couldn't be acquired because the lock already exists.
FAILED_DEPENDENCY
          Some dependency required by the communication channel failed.
FIELD_VALIDATION
          A field did not pass validation during an attempted delivery.
FILE_AREA_NEEDS_UPGRADE
          The client resource resides in a file area whose version is not compatible with the currently running software.
FILE_ERROR
          A file error was encountered
FOLDER_HAS_CHILDREN
          Used when trying to delete query folders
FORBIDDEN
          The provider was unable to complete the operation for an unspecified reason.
HOOK_RETURNED_MESSAGE
          While firing a named ClearQuest hook, the hook returned a message, which generally represents an error or need for additional information
ILLEGAL_ARG
          An illegal argument was specified
ILLEGAL_LOCATION_SYNTAX
          Illegal syntax for location string value.
ILLEGAL_QUERY
          An in-line query definition during query execution
INCOMPATIBLE_FILE_AREA_VERSION
          The client resource resides in a file area whose version is not compatible with the currently running software.
INCOMPATIBLE_SERVER
          Used when the client is not compatible with the server.
INSUFFICIENT_PERMISSION
          Insufficient permission for the requested operation
INTERACTION_REQUEST
          An interaction request has occurred
INTERNAL_ERROR
          An internal error has occurred
INTERNAL_SERVER_ERROR
          The provider's server encountered an unexpected internal error condition which prevented it from fulfilling the request.
INVALID
          The request or operation in not valid
INVALID_OBJECT_SELECTOR
          A required field is missing from or malformed in an StpLocation specification.
INVALID_RESPONSE
          An invalid response was received
INVALID_VALUES
          Completion of operation was prevented because one or more properties have invalid values
LICENSE_ERROR
          License error occurred
LOCKED_DATABASE
          The database to be affected is currently locked
LOGIN_FAILED
          Login on server failed
NAME_MUST_BE_VALID
          The name supplied for a new resource is invalid
NEEDS_MERGE_FROM_LATEST
          Resource needs to be merged from latest version
NO_CONTENT
          The resource has no content.
NO_DUPLICATE_RECORD
          Thrown by OpenRecord when a duplicate record is not specified with a duplicate action.
NONE
          For use when StpException is just a wrapper for a WvcmException
NOT_ALLOWED
          Request not allowed by the provider.
NOT_DUPLICATE_ACTION
          A duplicate record is specified but the action is not a duplicate action.
NOT_FOUND
          The corresponding remote resource no longer exists or was never created.
NOT_SUPPORTED
          The request or operation is not supported
PARAMETER_MISMATCH
          A parameter mismatch was detected in a response
PARENT_MUST_EXIST
          The parent of a targeted resource needs to exist, but doesn't
PARTIAL_RESULTS
          This exception is reporting failure in an operation that was applied independently to multiple resources and failed on some of them.
PRIOR_COMMIT_FAILURE
          Used when delivering change contexts
PROPERTY_ERROR
          Some other property error such as Can't update value because it is inappropriate for property.
PROPERTY_NOT_AVAILABLE_LOCALLY
          The property value is maintained only on the server and so is not available locally
PROPERTY_NOT_CURRENTLY_AVAILABLE
          Precondition: Failed to retrieve a property that should be supported.
PROPERTY_NOT_DEFINED_FOR_RESOURCE
          The requested property value is unavailable because it is not valid for the targeted resource--the property name used is not defined in the targeted resource's interface nor is it included in the PropertyRequest returned by Resource.doGetPropertyNameList(Feedback) for the resource.
PROPERTY_NOT_REQUESTED
          The property value is unavailable because it was not in the property name list when the proxy was created nor has it subsequently been added via Resource.setProperty(javax.wvcm.PropertyNameList.PropertyName, T) or one of the other property setters.
PROPERTY_NOT_SUPPORTED_BY_SERVER
          Even though this API 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.
PROPERTY_RETRIEVAL_FAILED
          An exception with this StpReasonCode is thrown by the execution of any property "getter" method when the targeted property could not be retrieved from the server.
READ_FAILED
          The provider suffered an I/O failure, the operation may be retried.
RECORD_WITH_SAME_DISPLAYNAME_EXISTS
          Thrown by CreateRecord when an attempt is made to create a record with the same name as one that already exists on the server.
REQUEST_FAILED_ERROR
          Request failed error
REQUEST_TIMED_OUT
          The request timed out waiting for a resource to become free.
RESOURCE_ALREADY_EXISTS_AT_LOCATION
          Precondition: Creating a resource failed because a resource already exists at the specified location.
RPC_UNEXPECTEDLY_EXITED
           
SERVER_BUSY
          Used when the server capacity has been reached.
SERVER_ERROR
          The provider has detected something inappropriate with a server's response.
SESSION_EXPIRED_OR_DOES_NOT_EXIST
          Session does not exist or the session has expired.
SUBMIT_NOT_ALLOWED
          The submit request is not allowed
SYNC_CANCEL_FAILED
          View update cancel failed
SYNC_CANCELLED
          View update was canceled
UNAUTHORIZED
          The user is not authorized to execute the attempted operation.
UNEXPECTED_EXCEPTION
           
UNKNOWN_ACTION
          Thrown by OpenRecord when the specified action is not defined for the record type.
UNSUPPORTED_REPORT
          Thrown when a report has been requested on resource that does not support that report type.
VIEW_OUT_OF_SYNC_WITH_STREAM
          View's config spec is not synchronized with stream's configuration.
WRITE_FAILED
          The provider suffered an I/O failure, the operation may be retried.
 
Method Summary
 WvcmException.ReasonCode getWvcmReasonCode()
          Returns the WVCM base reason code associated with this STP reason code.
 String toString()
           
static StpException.StpReasonCode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static StpException.StpReasonCode[] values()
          Returns an array containing the constants of this enum type, in the order they are 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

ACTIVITY_NEEDED

public static final StpException.StpReasonCode ACTIVITY_NEEDED
A checkout was attempted with no explicit activity and no current activity in the workspace.


ALREADY_BEING_EDITED

public static final StpException.StpReasonCode ALREADY_BEING_EDITED
The specified record is already being edited (by the same user).


AUTHENTICATION_INFO_REQUIRED

public static final StpException.StpReasonCode AUTHENTICATION_INFO_REQUIRED
Authentication information is required but client didn't provide any.


BAD_REPORT

public static final StpException.StpReasonCode BAD_REPORT
Precondition: Report failed since the resource does not support the specified report.


BAD_REQUEST

public static final StpException.StpReasonCode BAD_REQUEST
Request not understood or contextually incorrect for the provider.


BAD_SOURCE_STATE

public static final StpException.StpReasonCode BAD_SOURCE_STATE
The requested action is inappropriate for the current state of the query (precondition failure)


CANNOT_CHECKIN_MUST_BE_CHECKED_OUT

public static final StpException.StpReasonCode CANNOT_CHECKIN_MUST_BE_CHECKED_OUT
The checkin operation failed because the resource is not checked out.


CANNOT_CREATE_AT_THIS_LOCATION

public static final StpException.StpReasonCode CANNOT_CREATE_AT_THIS_LOCATION
Precondition: Cannot create this resource at the specified location.


CANNOT_ENCODE_STRING

public static final StpException.StpReasonCode CANNOT_ENCODE_STRING
Used when a string is not supported by the server's operating system.


CANNOT_MODIFY_PROTECTED_PROPERTY

public static final StpException.StpReasonCode CANNOT_MODIFY_PROTECTED_PROPERTY
Precondition: Operation failed because it attempted to set a protected property.


CANNOT_OVERWRITE

public static final StpException.StpReasonCode CANNOT_OVERWRITE
Cannot overwrite existing binding.


CANNOT_UNCHECKOUT_MUST_BE_CHECKED_OUT

public static final StpException.StpReasonCode CANNOT_UNCHECKOUT_MUST_BE_CHECKED_OUT
The uncheckout operation failed because the resource is not checked out.


CHECKOUT_BRANCH_NOT_MASTERED

public static final StpException.StpReasonCode CHECKOUT_BRANCH_NOT_MASTERED
Checkout failed because the branch was not mastered locally.


CHECKOUT_BRTYPE_NOT_MASTERED

public static final StpException.StpReasonCode CHECKOUT_BRTYPE_NOT_MASTERED
Checkout failed because the branch type was not mastered locally.


CHECKOUT_NOT_LATEST

public static final StpException.StpReasonCode CHECKOUT_NOT_LATEST
Version being checked out is not the latest


CHILD_ORIGINAL_SOURCE_DIRECTORY_NO_LONGER_EXISTS

public static final StpException.StpReasonCode CHILD_ORIGINAL_SOURCE_DIRECTORY_NO_LONGER_EXISTS
Used by REVERT method


CHILDREN_OF_FOLDER_MUST_BE_REVERTED_FIRST

public static final StpException.StpReasonCode CHILDREN_OF_FOLDER_MUST_BE_REVERTED_FIRST
Used by REVERT method


CLIENT_LOCATION_NOT_IN_FILE_AREA

public static final StpException.StpReasonCode CLIENT_LOCATION_NOT_IN_FILE_AREA
The client location is not within a file area


CONDITIONAL_EXECUTION

public static final StpException.StpReasonCode CONDITIONAL_EXECUTION
A communication precondition failed


CONFLICT

public static final StpException.StpReasonCode CONFLICT
The operation cannot be performed because of a conflict with resource state.


CONNECTION_FAILED

public static final StpException.StpReasonCode CONNECTION_FAILED
An operation failed because the connection to the remote server could not be established or terminated prematurely after being established.


CREDENTIALS_REQUIRED

public static final StpException.StpReasonCode CREDENTIALS_REQUIRED
Used if an operation requires credentials but none were provided


DELIVER_INVALID_ACTIVITIES

public static final StpException.StpReasonCode DELIVER_INVALID_ACTIVITIES
A deliver operation failed because selected activities depend on un-delivered activities.


DELIVERY_ERROR

public static final StpException.StpReasonCode DELIVERY_ERROR
An attempt to deliver a resource from the change context to the database failed.


DISCONNECTED

public static final StpException.StpReasonCode DISCONNECTED
Used when an operation is forbidden due to operating in disconnected mode


DISCORDANCE_VERSION

public static final StpException.StpReasonCode DISCORDANCE_VERSION
Version discordance detected


DUPLICATE_ACTIVITY_NAME

public static final StpException.StpReasonCode DUPLICATE_ACTIVITY_NAME
Duplicate activity name


DUPLICATE_STREAM_NAME

public static final StpException.StpReasonCode DUPLICATE_STREAM_NAME
Duplicate stream name


EXTERNAL_LOCK_ALREADY_PRESENT

public static final StpException.StpReasonCode EXTERNAL_LOCK_ALREADY_PRESENT
This code indicates that an external lock couldn't be acquired because the lock already exists.


FAILED_DEPENDENCY

public static final StpException.StpReasonCode FAILED_DEPENDENCY
Some dependency required by the communication channel failed.


FIELD_VALIDATION

public static final StpException.StpReasonCode FIELD_VALIDATION
A field did not pass validation during an attempted delivery.


FILE_AREA_NEEDS_UPGRADE

public static final StpException.StpReasonCode FILE_AREA_NEEDS_UPGRADE
The client resource resides in a file area whose version is not compatible with the currently running software. The file area needs to be upgraded in order to work with this software.


FILE_ERROR

public static final StpException.StpReasonCode FILE_ERROR
A file error was encountered


FOLDER_HAS_CHILDREN

public static final StpException.StpReasonCode FOLDER_HAS_CHILDREN
Used when trying to delete query folders


FORBIDDEN

public static final StpException.StpReasonCode FORBIDDEN
The provider was unable to complete the operation for an unspecified reason.


HOOK_RETURNED_MESSAGE

public static final StpException.StpReasonCode HOOK_RETURNED_MESSAGE
While firing a named ClearQuest hook, the hook returned a message, which generally represents an error or need for additional information


ILLEGAL_ARG

public static final StpException.StpReasonCode ILLEGAL_ARG
An illegal argument was specified


ILLEGAL_LOCATION_SYNTAX

public static final StpException.StpReasonCode ILLEGAL_LOCATION_SYNTAX
Illegal syntax for location string value.


ILLEGAL_QUERY

public static final StpException.StpReasonCode ILLEGAL_QUERY
An in-line query definition during query execution


INCOMPATIBLE_FILE_AREA_VERSION

public static final StpException.StpReasonCode INCOMPATIBLE_FILE_AREA_VERSION
The client resource resides in a file area whose version is not compatible with the currently running software. The software needs to be upgraded to handle this file area.


INCOMPATIBLE_SERVER

public static final StpException.StpReasonCode INCOMPATIBLE_SERVER
Used when the client is not compatible with the server. (This may be caused by a client that is too old, or too new.)


INSUFFICIENT_PERMISSION

public static final StpException.StpReasonCode INSUFFICIENT_PERMISSION
Insufficient permission for the requested operation


INTERACTION_REQUEST

public static final StpException.StpReasonCode INTERACTION_REQUEST
An interaction request has occurred


INTERNAL_ERROR

public static final StpException.StpReasonCode INTERNAL_ERROR
An internal error has occurred


INTERNAL_SERVER_ERROR

public static final StpException.StpReasonCode INTERNAL_SERVER_ERROR
The provider's server encountered an unexpected internal error condition which prevented it from fulfilling the request. This loosely corresponds to an HTTP 500 Internal Server Error response from the server.

See Also:
SERVER_ERROR

INVALID

public static final StpException.StpReasonCode INVALID
The request or operation in not valid


INVALID_OBJECT_SELECTOR

public static final StpException.StpReasonCode INVALID_OBJECT_SELECTOR
A required field is missing from or malformed in an StpLocation specification.


INVALID_RESPONSE

public static final StpException.StpReasonCode INVALID_RESPONSE
An invalid response was received


INVALID_VALUES

public static final StpException.StpReasonCode INVALID_VALUES
Completion of operation was prevented because one or more properties have invalid values


LICENSE_ERROR

public static final StpException.StpReasonCode LICENSE_ERROR
License error occurred


LOCKED_DATABASE

public static final StpException.StpReasonCode LOCKED_DATABASE
The database to be affected is currently locked


LOGIN_FAILED

public static final StpException.StpReasonCode LOGIN_FAILED
Login on server failed


NAME_MUST_BE_VALID

public static final StpException.StpReasonCode NAME_MUST_BE_VALID
The name supplied for a new resource is invalid


NEEDS_MERGE_FROM_LATEST

public static final StpException.StpReasonCode NEEDS_MERGE_FROM_LATEST
Resource needs to be merged from latest version


NO_CONTENT

public static final StpException.StpReasonCode NO_CONTENT
The resource has no content.


NO_DUPLICATE_RECORD

public static final StpException.StpReasonCode NO_DUPLICATE_RECORD
Thrown by OpenRecord when a duplicate record is not specified with a duplicate action.


NONE

public static final StpException.StpReasonCode NONE
For use when StpException is just a wrapper for a WvcmException


NOT_ALLOWED

public static final StpException.StpReasonCode NOT_ALLOWED
Request not allowed by the provider.


NOT_DUPLICATE_ACTION

public static final StpException.StpReasonCode NOT_DUPLICATE_ACTION
A duplicate record is specified but the action is not a duplicate action.


NOT_FOUND

public static final StpException.StpReasonCode NOT_FOUND
The corresponding remote resource no longer exists or was never created.


NOT_SUPPORTED

public static final StpException.StpReasonCode NOT_SUPPORTED
The request or operation is not supported


PARAMETER_MISMATCH

public static final StpException.StpReasonCode PARAMETER_MISMATCH
A parameter mismatch was detected in a response


PARENT_MUST_EXIST

public static final StpException.StpReasonCode PARENT_MUST_EXIST
The parent of a targeted resource needs to exist, but doesn't


PARTIAL_RESULTS

public static final StpException.StpReasonCode PARTIAL_RESULTS
This exception is reporting failure in an operation that was applied independently to multiple resources and failed on some of them.

See Also:
StpPartialResultsException

PRIOR_COMMIT_FAILURE

public static final StpException.StpReasonCode PRIOR_COMMIT_FAILURE
Used when delivering change contexts


PROPERTY_ERROR

public static final StpException.StpReasonCode PROPERTY_ERROR
Some other property error such as


PROPERTY_NOT_AVAILABLE_LOCALLY

public static final StpException.StpReasonCode PROPERTY_NOT_AVAILABLE_LOCALLY
The property value is maintained only on the server and so is not available locally


PROPERTY_NOT_CURRENTLY_AVAILABLE

public static final StpException.StpReasonCode PROPERTY_NOT_CURRENTLY_AVAILABLE
Precondition: Failed to retrieve a property that should be supported. A potentially recoverable condition prevented the server from retrieving the property value.


PROPERTY_NOT_DEFINED_FOR_RESOURCE

public static final StpException.StpReasonCode PROPERTY_NOT_DEFINED_FOR_RESOURCE
The requested property value is unavailable because it is not valid for the targeted resource--the property name used is not defined in the targeted resource's interface nor is it included in the PropertyRequest returned by Resource.doGetPropertyNameList(Feedback) for the resource.


PROPERTY_NOT_REQUESTED

public static final StpException.StpReasonCode PROPERTY_NOT_REQUESTED
The property value is unavailable because it was not in the property name list when the proxy was created nor has it subsequently been added via Resource.setProperty(javax.wvcm.PropertyNameList.PropertyName, T) or one of the other property setters.


PROPERTY_NOT_SUPPORTED_BY_SERVER

public static final StpException.StpReasonCode PROPERTY_NOT_SUPPORTED_BY_SERVER
Even though this API says the property is valid for the targeted resource, the server does not support it. For properties the server intends to support in the release under development, the exception message should say “NOT YET IMPLEMENTED”.


PROPERTY_OVERWRITE_FORBIDDEN

public static final StpException.StpReasonCode PROPERTY_OVERWRITE_FORBIDDEN
The property value update would overwrite an earlier change.


PROPERTY_RETRIEVAL_FAILED

public static final StpException.StpReasonCode PROPERTY_RETRIEVAL_FAILED
An exception with this StpReasonCode is thrown by the execution of any property "getter" method when the targeted property could not be retrieved from the server. Exceptions of this type wrap the exception generated by the server, which is accessible via the getCause() or WvcmException.getNestedExceptions() methods of this wrapping exception.

The traceback for the outer, PROPERTY_RETRIEVAL_FAILED exception will identify the context in which the attempt was made to get the property value from the proxy, while the traceback for the cause of that exception will identify the context in which the attempt was made to read the value into the proxy.


READ_FAILED

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


RECORD_WITH_SAME_DISPLAYNAME_EXISTS

public static final StpException.StpReasonCode RECORD_WITH_SAME_DISPLAYNAME_EXISTS
Thrown by CreateRecord when an attempt is made to create a record with the same name as one that already exists on the server.


REQUEST_FAILED_ERROR

public static final StpException.StpReasonCode REQUEST_FAILED_ERROR
Request failed error


REQUEST_TIMED_OUT

public static final StpException.StpReasonCode REQUEST_TIMED_OUT
The request timed out waiting for a resource to become free.


RESOURCE_ALREADY_EXISTS_AT_LOCATION

public static final StpException.StpReasonCode RESOURCE_ALREADY_EXISTS_AT_LOCATION
Precondition: Creating a resource failed because a resource already exists at the specified location.


RPC_UNEXPECTEDLY_EXITED

public static final StpException.StpReasonCode RPC_UNEXPECTEDLY_EXITED

SERVER_BUSY

public static final StpException.StpReasonCode SERVER_BUSY
Used when the server capacity has been reached.


SERVER_ERROR

public static final StpException.StpReasonCode SERVER_ERROR
The provider has detected something inappropriate with a server's response. It could be the result of a bug in the server's response or a bug in the provider's processing of the response.

See Also:
INTERNAL_SERVER_ERROR

SESSION_EXPIRED_OR_DOES_NOT_EXIST

public static final StpException.StpReasonCode SESSION_EXPIRED_OR_DOES_NOT_EXIST
Session does not exist or the session has expired.


SUBMIT_NOT_ALLOWED

public static final StpException.StpReasonCode SUBMIT_NOT_ALLOWED
The submit request is not allowed


SYNC_CANCEL_FAILED

public static final StpException.StpReasonCode SYNC_CANCEL_FAILED
View update cancel failed


SYNC_CANCELLED

public static final StpException.StpReasonCode SYNC_CANCELLED
View update was canceled


UNAUTHORIZED

public static final StpException.StpReasonCode UNAUTHORIZED
The user is not authorized to execute the attempted operation.


UNEXPECTED_EXCEPTION

public static final StpException.StpReasonCode UNEXPECTED_EXCEPTION

UNKNOWN_ACTION

public static final StpException.StpReasonCode UNKNOWN_ACTION
Thrown by OpenRecord when the specified action is not defined for the record type.


UNSUPPORTED_REPORT

public static final StpException.StpReasonCode UNSUPPORTED_REPORT
Thrown when a report has been requested on resource that does not support that report type.


VIEW_OUT_OF_SYNC_WITH_STREAM

public static final StpException.StpReasonCode VIEW_OUT_OF_SYNC_WITH_STREAM
View's config spec is not synchronized with stream's configuration. An update view operation is required.


WRITE_FAILED

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

Method Detail

getWvcmReasonCode

public WvcmException.ReasonCode getWvcmReasonCode()
Returns the WVCM base reason code associated with this STP reason code.

Returns:
The WVCM reason code associated with this STP reason code.

toString

public String toString()
Overrides:
toString in class Enum<StpException.StpReasonCode>

valueOf

public static StpException.StpReasonCode 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
NullPointerException - if the argument is null

values

public static StpException.StpReasonCode[] 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 (StpException.StpReasonCode c : StpException.StpReasonCode.values())
    System.out.println(c);

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

Generated Thu 2-Aug-2012 03:10 AM

Copyright © IBM 2012. All rights reserved.