Interface Situation

All Known Subinterfaces:
SituationWithEntity, SituationWithEntityName, SituationWithFormName
All Known Implementing Classes:
EntityNameSituation, EntitySituation

public interface Situation
  • Method Summary

    Modifier and Type
    Method
    Description
    Tells the kind of situation it is, probably the class name.
    Returns the place for the situation.
    @Nullable String
    Tells the scope for which this situation is.
    getScope(String fallback)
     
    @Nullable String
    Tells the screen for which this situation is.
  • Method Details

    • getName

      String getName()
      Tells the kind of situation it is, probably the class name.
    • getScreen

      @Nullable @Nullable String getScreen()
      Tells the screen for which this situation is. Examples: 'explorer-main', 'explorer-relations', 'explorer-search', 'explorer-modal', 'home'.
    • getScope

      @Nullable @Nullable String getScope()
      Tells the scope for which this situation is. Example: 'update'.
      Returns:
      The scope in lower case, or null.
    • getScope

      String getScope(String fallback)
    • getPlace

      String getPlace()
      Returns the place for the situation. Example: 'topToolbar'.