com.sap.tc.cmi.sorting

Class CMIIllegalSortCriterionException

java.lang.Object
  BaseRuntimeException
      com.sap.tc.cmi.exception.CMIRuntimeException
          com.sap.tc.cmi.sorting.CMIIllegalSortCriterionException

public final class CMIIllegalSortCriterionException
extends CMIRuntimeException

Exception to be thrown by model implementations if a given sort criterion can't be processed.

Since:

NW Paris MS2

Version:

$Id: //tc/cm.interface/NW711_02_COR/src/_cmi_api/glib/api/com/sap/tc/cmi/sorting/CMIIllegalSortCriterionException.java#1 $

Type Classification:

This class is part of the Common Model Interface, so applications may reference it or call any method of this type, but they must not subclass it.

Field Summary

static int	FIRST_MODEL_DEFINED_REASON
static int	ILLEGAL_COLUMN_NAME
static int	ILLEGAL_COMPARISON_RULE
static int	ILLEGAL_SORT_CRITERION_TYPE

Constructor Summary

CMIIllegalSortCriterionException()
Deprecated. Use one of the other constructors and provide a reason and a message

CMIIllegalSortCriterionException(int reason, String message)
Creates exception with a predefined or model specific reason and a message text

CMIIllegalSortCriterionException(int reason, String message, Object[] parameters)
Creates exception with a predefined or model specific reason and a message text with parameters.

Method Summary

int	getReason() Returns the reason for this exception as one of the ILLEGAL_* constants in this class.

Methods inherited from class com.sap.tc.cmi.exception.CMIRuntimeException

getParameters

Methods inherited from class java.lang.Object

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

Field Detail

ILLEGAL_SORT_CRITERION_TYPE

public static final int ILLEGAL_SORT_CRITERION_TYPE

See Also:

Constant Field Values

ILLEGAL_COLUMN_NAME

public static final int ILLEGAL_COLUMN_NAME

See Also:

Constant Field Values

ILLEGAL_COMPARISON_RULE

public static final int ILLEGAL_COMPARISON_RULE

See Also:

Constant Field Values

FIRST_MODEL_DEFINED_REASON

public static final int FIRST_MODEL_DEFINED_REASON

See Also:

Constant Field Values

Constructor Detail

CMIIllegalSortCriterionException

public CMIIllegalSortCriterionException()

Deprecated. Use one of the other constructors and provide a reason and a message

CMIIllegalSortCriterionException

public CMIIllegalSortCriterionException(int reason,
                                        String message)

Creates exception with a predefined or model specific reason and a message text

Parameters:

reason -

message -

CMIIllegalSortCriterionException

public CMIIllegalSortCriterionException(int reason,
                                        String message,
                                        Object[] parameters)

Creates exception with a predefined or model specific reason and a message text with parameters.

Parameters:

reason -

message -

parameters -

Method Detail

getReason

public int getReason()

Returns the reason for this exception as one of the ILLEGAL_* constants in this class.

Returns:

The reason for the exception.