bundles/org.simantics.message/src/org/simantics/message/IDetailStatus.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.message;
  13
  14 import org.eclipse.core.runtime.IStatus;
  15 import org.eclipse.core.runtime.MultiStatus;
  16
  17 /**
  18  * A more detailed version of {@link IStatus} tailored for Simantics' purposes.
  19  *
  20  * <p>
  21  * This interface can be used without OSGi running.
  22  * </p>
  23  *
  24  * @see IStatus
  25  * @see MultiStatus
  26  * @see Status
  27  *
  28  * @author Tuukka Lehtonen
  29  */
  30 public interface IDetailStatus extends IStatus {
  31
  32     /**
  33      * Status type severity (bit mask, value 16) indicating this status
  34      * represents a debug message
  35      *
  36      * @see #getSeverity()
  37      * @see #matches(int)
  38      */
  39     public static final int DEBUG = 0x10;
  40
  41     /**
  42      * Returns the message describing the outcome in more detail than the value
  43      * returned by {@link #getMessage()}. The message is localized to the
  44      * current locale.
  45      *
  46      * <p>
  47      * Detailed descriptions messages can should contain additional information
  48      * regarding the event, such as <code>&lt;a&gt;</code> hyperlinks to
  49      * resources related to this event. This is necessary to provide a more
  50      * concrete context for the messages.
  51      * </p>
  52      *
  53      * @return a localized detailed description
  54      */
  55     String getDetailedDescription();
  56
  57 }