org.jasig.portal.channels.error
Class ErrorCode

java.lang.Object
  org.jasig.portal.channels.error.ErrorCode

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class ErrorCode
extends Object

Error codes specific to the CError channel.

Since:

uPortal 2.5

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Author:

andrew.petro@yale.edu

Field Summary

static ErrorCode	CHANNEL_AUTHORIZATION_EXCEPTION Deprecated. Error code representing failure to render due to lack of authorization.
static ErrorCode	CHANNEL_MISSING_EXCEPTION Deprecated. Error code representing the channel being just plain missing.
static ErrorCode	GENERAL_ERROR Deprecated. Generic error code
static ErrorCode	RENDER_TIME_EXCEPTION Deprecated. Error code for failure during rendering.
static ErrorCode	SET_PCS_EXCEPTION Deprecated. Error code representing failure when framework attempts to set channel portal control structures.
static ErrorCode	SET_RUNTIME_DATA_EXCEPTION Deprecated. Error code for errors at time runtime data is set.
static ErrorCode	SET_STATIC_DATA_EXCEPTION Deprecated. Error code for errors at time static data is set
static ErrorCode	TIMEOUT_EXCEPTION Deprecated. Error code for channels that fail to complete rendering during allotted time.
static ErrorCode	UNKNOWN_ERROR Deprecated. Generic error code

Method Summary

static ErrorCode	codeForInt(int codeNum) Deprecated. Obtain the ErrorCode for the given code number, or null if the code number does not correspond to an error code.
int	getCode() Deprecated.
String	getLabel() Deprecated.
boolean	isRefreshAllowed() Deprecated. Is this ErrorCode representative of a problem to which channel refresh would be an appropriate response.
String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_ERROR

public static final ErrorCode UNKNOWN_ERROR

Deprecated.

Generic error code

GENERAL_ERROR

public static final ErrorCode GENERAL_ERROR

Deprecated.

Generic error code

RENDER_TIME_EXCEPTION

public static final ErrorCode RENDER_TIME_EXCEPTION

Deprecated.

Error code for failure during rendering.

SET_STATIC_DATA_EXCEPTION

public static final ErrorCode SET_STATIC_DATA_EXCEPTION

Deprecated.

Error code for errors at time static data is set

SET_RUNTIME_DATA_EXCEPTION

public static final ErrorCode SET_RUNTIME_DATA_EXCEPTION

Deprecated.

Error code for errors at time runtime data is set.

TIMEOUT_EXCEPTION

public static final ErrorCode TIMEOUT_EXCEPTION

Deprecated.

Error code for channels that fail to complete rendering during allotted time.

SET_PCS_EXCEPTION

public static final ErrorCode SET_PCS_EXCEPTION

Deprecated.

Error code representing failure when framework attempts to set channel portal control structures.

CHANNEL_AUTHORIZATION_EXCEPTION

public static final ErrorCode CHANNEL_AUTHORIZATION_EXCEPTION

Deprecated.

Error code representing failure to render due to lack of authorization.

CHANNEL_MISSING_EXCEPTION

public static final ErrorCode CHANNEL_MISSING_EXCEPTION

Deprecated.

Error code representing the channel being just plain missing.

Method Detail

codeForInt

public static ErrorCode codeForInt(int codeNum)

Deprecated.

Obtain the ErrorCode for the given code number, or null if the code number does not correspond to an error code.

Parameters:

codeNum -

Returns:

ErrorCode or null.

getCode

public int getCode()

Deprecated.

getLabel

public String getLabel()

Deprecated.

isRefreshAllowed

public boolean isRefreshAllowed()

Deprecated.

Is this ErrorCode representative of a problem to which channel refresh would be an appropriate response. Some ErrorCodes are representative of problems that refreshing just won't fix, such as a failure when setting static data.

Returns:

true if refresh is allowed, false otherwise

toString

public String toString()

Deprecated.

Overrides:

toString in class Object