IProblem.java

/*******************************************************************************
 * Copyright (c) 2004, 2010 BREDEX GmbH.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     BREDEX GmbH - initial API and implementation and/or initial documentation
 *******************************************************************************/
package org.eclipse.jubula.client.core.businessprocess.problems;

import org.eclipse.core.runtime.IStatus;


/**
 * Describes a Problem of a Resource.
 * 
 * @author BREDEX GmbH
 * @created 24.01.2011
 */
public interface IProblem {
    /**
     * @return the message to display for the user e.g. when running in UI this
     *         will be the marker text in the problems view or when running in
     *         headless mode this is the text to display on the commandline. 
     *         Can be <code>null</code> if no text should be displayed.
     * @see #hasUserMessage()
     */
    String getUserMessage();

    /**
     * @return an internationalized message suitable for displaying as a 
     *         tooltip.
     */
    String getTooltipMessage();
    
    /**
     * @return the status of this problem.
     */
    IStatus getStatus();

    /**
     * @return additional data associated with this problem, or 
     *         <code>null</code> if no additional data is associated with 
     *         this problem.
     */
    Object getData();
    
    /**
     * @return the type of this problem.
     */
    ProblemType getProblemType();
    
    /**
     * @return <code>true</code> when the problem has a message to display e.g. 
     *         the Problems View or when running in headless mode on the commandline.
     * @see #getUserMessage()
     */
    boolean hasUserMessage();
}