Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.message / src / org / simantics / message / IDetailStatus.java

diff --git a/bundles/org.simantics.message/src/org/simantics/message/IDetailStatus.java b/bundles/org.simantics.message/src/org/simantics/message/IDetailStatus.java
new file mode 100644 (file)
index 0000000..44ab658
--- /dev/null
+++ b/bundles/org.simantics.message/src/org/simantics/message/IDetailStatus.java
@@ -0,0 +1,57 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.message;
+
+import org.eclipse.core.runtime.IStatus;\r
+import org.eclipse.core.runtime.MultiStatus;\r
+
+/**
+ * A more detailed version of {@link IStatus} tailored for Simantics' purposes.
+ * 
+ * <p>
+ * This interface can be used without OSGi running.
+ * </p>
+ * 
+ * @see IStatus
+ * @see MultiStatus
+ * @see Status
+ * 
+ * @author Tuukka Lehtonen
+ */
+public interface IDetailStatus extends IStatus {
+
+    /**
+     * Status type severity (bit mask, value 16) indicating this status
+     * represents a debug message
+     * 
+     * @see #getSeverity()
+     * @see #matches(int)
+     */
+    public static final int DEBUG = 0x10;
+
+    /**
+     * Returns the message describing the outcome in more detail than the value
+     * returned by {@link #getMessage()}. The message is localized to the
+     * current locale.
+     * 
+     * <p>
+     * Detailed descriptions messages can should contain additional information
+     * regarding the event, such as <code>&lt;a&gt;</code> hyperlinks to
+     * resources related to this event. This is necessary to provide a more
+     * concrete context for the messages.
+     * </p>
+     * 
+     * @return a localized detailed description
+     */
+    String getDetailedDescription();
+
+}