/*******************************************************************************
* Copyright (c) 2000, 2009 QNX Software Systems and others.
* 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:
* QNX Software Systems - Initial API and implementation
*******************************************************************************/
package org.eclipse.cdt.core.model;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
/**
* Represents the outcome of an C model operation. Status objects are
* used inside <code>CModelException</code> objects to indicate what went
* wrong.
* <p>
* C model status object are distinguished by their plug-in id:
* <code>getPlugin</code> returns <code>"org.eclipse.cdt.core"</code>.
* <code>getCode</code> returns one of the status codes declared in
* <code>ICModelStatusConstants</code>.
* </p>
* <p>
* A C model status may also carry additional information (that is, in
* addition to the information defined in <code>IStatus</code>):
* <ul>
* <li>elements - optional handles to C elements associated with the failure</li>
* <li>string - optional string associated with the failure</li>
* </ul>
* @see org.eclipse.core.runtime.IStatus
* @see ICModelStatusConstants
*
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ICModelStatus extends IStatus {
/**
* Returns any C elements associated with the failure (see specification
* of the status code), or an empty array if no elements are related to this
* particular status code.
*
* @return the list of C element culprits
* @see ICModelStatusConstants
*/
ICElement[] getElements();
/**
* Returns the path associated with the failure (see specification
* of the status code), or <code>null</code> if the failure is not
* one of <code>DEVICE_PATH</code>, <code>INVALID_PATH</code>,
* <code>PATH_OUTSIDE_PROJECT</code>, or <code>RELATIVE_PATH</code>.
*
* @return the path that caused the failure, or <code>null</code> if none
* @see ICModelStatusConstants#DEVICE_PATH
* @see ICModelStatusConstants#INVALID_PATH
* @see ICModelStatusConstants#PATH_OUTSIDE_PROJECT
* @see ICModelStatusConstants#RELATIVE_PATH
*/
IPath getPath();
/**
* Returns the string associated with the failure (see specification
* of the status code), or <code>null</code> if no string is related to this
* particular status code.
*
* @return the string culprit, or <code>null</code> if none
* @see ICModelStatusConstants
*/
String getString();
/**
* Returns whether this status indicates that a C model element does not exist.
* This convenience method is equivalent to
* <code>getCode() == ICModelStatusConstants.ELEMENT_DOES_NOT_EXIST</code>.
*
* @return <code>true</code> if the status code indicates that a C model
* element does not exist
* @see ICModelStatusConstants#ELEMENT_DOES_NOT_EXIST
*/
boolean doesNotExist();
}