IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.emf.msl
Interface IValidationStatus

All Superinterfaces:
IStatus

public interface IValidationStatus
extends IStatus

An extension of the Eclipse core status interface that provides additional information about the violation of a constraint during the validation of a model.

In general, validation status objects will not indicate an OKstatus, because they describe constraint violations. Moreover, validation status objects are never multi-statuses.

API clients should not implement this interface.


Field Summary
 
Fields inherited from interface org.eclipse.core.runtime.IStatus
CANCEL, ERROR, INFO, OK, WARNING
 
Method Summary
 IStatus[] getChildren()
          The IValidationStatus interface redefines this method to always return an empty array of child statuses.
 Set getRelatedObjects()
          In the case of a constraint violation, obtains the set of related elements that contributed to the problem.
 String getRuleID()
          The rule property defined in the marker resolution extension
 EObject getTarget()
          Obtains the model element on which a constraint was evaluated, that was violated (or not) according to my severity.
 boolean isMultiStatus()
          The IValidationStatus interface redefines this method to always return false.
 
Methods inherited from interface org.eclipse.core.runtime.IStatus
getCode, getException, getMessage, getPlugin, getSeverity, isOK, matches
 

Method Detail

getTarget

public EObject getTarget()
Obtains the model element on which a constraint was evaluated, that was violated (or not) according to my severity. In the case of a constraint violation, my messageindicates the nature of the problem.

Returns:
the target of a constraint evaluation

getRelatedObjects

public Set getRelatedObjects()
In the case of a constraint violation, obtains the set of related elements that contributed to the problem. This set always includes, minimally, the targetof the constraint evaluation.

Returns:
the set of elements that caused the problem, or an empty set in case of a successful constraint evaluation

isMultiStatus

public boolean isMultiStatus()
The IValidationStatus interface redefines this method to always return false.

Specified by:
isMultiStatus in interface IStatus
Returns:
false

getChildren

public IStatus[] getChildren()
The IValidationStatus interface redefines this method to always return an empty array of child statuses.

Specified by:
getChildren in interface IStatus
Returns:
an empty array of statuses

getRuleID

public String getRuleID()
The rule property defined in the marker resolution extension

Returns:
The id for the marker resolution extension

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.