Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.birt.report.model.api.command
Class CustomMsgException

    java.lang.Object
      BirtException
          org.eclipse.birt.report.model.api.ModelException
              org.eclipse.birt.report.model.api.activity.SemanticException
                  org.eclipse.birt.report.model.api.command.CustomMsgException

    public class CustomMsgException

extends SemanticException

Reports an error during a user-defined message operation.

Field Summary
`static java.lang.String` | `DESIGN_EXCEPTION_DUPLICATE_LOCALE` Duplicated locale for one single message.
`static java.lang.String` | `DESIGN_EXCEPTION_INVALID_LOCALE` Invalid locale.
`static java.lang.String` | `DESIGN_EXCEPTION_RESOURCE_KEY_REQUIRED` The resource key must be specified for the Translation.
`static java.lang.String` | `DESIGN_EXCEPTION_TRANSLATION_NOT_FOUND` translation is not found in the report.

Fields inherited from class org.eclipse.birt.report.model.api.activity.SemanticException
`element`

Fields inherited from class org.eclipse.birt.report.model.api.ModelException
`PLUGIN_ID`

Constructor Summary
`CustomMsgException(org.eclipse.birt.report.model.core.DesignElement element, java.lang.String errCode)` Constructs the exception with error code.
`CustomMsgException(org.eclipse.birt.report.model.core.DesignElement element, java.lang.String resourceKey, java.lang.String locale, java.lang.String errCode)` Constructs the exception with error code.

Method Summary
`java.lang.String` | `getLocalizedMessage()`

Methods inherited from class org.eclipse.birt.report.model.api.activity.SemanticException
`getElement, getElementName, getMessage`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### DESIGN_EXCEPTION_RESOURCE_KEY_REQUIRED

    public static final java.lang.String DESIGN_EXCEPTION_RESOURCE_KEY_REQUIRED

  The resource key must be specified for the Translation.

  See Also:
    Constant Field Values

### DESIGN_EXCEPTION_DUPLICATE_LOCALE

    public static final java.lang.String DESIGN_EXCEPTION_DUPLICATE_LOCALE

  Duplicated locale for one single message.

  See Also:
    Constant Field Values

### DESIGN_EXCEPTION_INVALID_LOCALE

    public static final java.lang.String DESIGN_EXCEPTION_INVALID_LOCALE

  Invalid locale.

  See Also:
    Constant Field Values

### DESIGN_EXCEPTION_TRANSLATION_NOT_FOUND

    public static final java.lang.String DESIGN_EXCEPTION_TRANSLATION_NOT_FOUND

  translation is not found in the report.

  See Also:
    Constant Field Values

Constructor Detail

### CustomMsgException

    public CustomMsgException(org.eclipse.birt.report.model.core.DesignElement element,
                              java.lang.String errCode)

  Constructs the exception with error code.

  Parameters:
    `element` - the element
    `errCode` - the error code

### CustomMsgException

    public CustomMsgException(org.eclipse.birt.report.model.core.DesignElement element,
                              java.lang.String resourceKey,
                              java.lang.String locale,
                              java.lang.String errCode)

  Constructs the exception with error code.

  Parameters:
    `element` - the element
    `resourceKey` - the resource key which is involved in this exception
    `locale` - the locale which is involved in this exception
    `errCode` - the error code

Method Detail

### getLocalizedMessage

    public java.lang.String getLocalizedMessage()

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 Actuate Corp. All rights reserved.