Package org.faktorips.runtime

Interface IMarker

public interface IMarker
The implementation of this interface is used to provide additional information for an Message.

Currently there are two standard situations markers are expected to be used in (see isRequiredInformationMissing() and isTechnicalConstraintViolated()). Implementers are free to use markers for other purposes.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isRequiredInformationMissing()
    Returns whether the marked Message is stating that required information is missing.
    boolean
    isTechnicalConstraintViolated()
    Returns whether the marked Message is stating that a technical constraint (like for example a database column length) is violated.

  • Method Details

    • isRequiredInformationMissing

      boolean isRequiredInformationMissing()
      Returns whether the marked Message is stating that required information is missing. In most cases the missing information is a value for an attribute or an association's target and should be discernible from the Message's InvalidObjectProperties.
      Returns:
      true if the marked message indicates that required information is missing, otherwise false

    • isTechnicalConstraintViolated

      boolean isTechnicalConstraintViolated()
      Returns whether the marked Message is stating that a technical constraint (like for example a database column length) is violated. The property the constraint applies to should be discernible from the Message's InvalidObjectProperties.
      Returns:
      true if the marked message indicates that some technical constraints are violated, otherwise false