Class EntityNameSituation

All Implemented Interfaces:
Situation, SituationWithEntityName, SituationWithFormName
Direct Known Subclasses:

public class EntityNameSituation extends Object implements SituationWithEntityName, SituationWithFormName
  • Field Details

    • NAME

      public static final String NAME
    • entityName

      protected String entityName
      The entity name, eg 'Address'. NOTE: entityName would have been the correct variable name - type has another meaning.
    • formName

      @Nullable protected @Nullable String formName
      The form name, eg 'Address' or 'PublicDmsResource'.
    • screen

      @Nullable protected @Nullable String screen
      For example 'explorer-main'.
    • scope

      @Nullable protected @Nullable String scope
      For example 'create'.
    • place

      protected String place
      Something like 'top toolbar' afaik.
    • module

      @Nullable protected @Nullable String module
    • mainPrimaryKey

      @Nullable protected @Nullable String mainPrimaryKey
  • Constructor Details

    • EntityNameSituation

      public EntityNameSituation()
  • Method Details

    • getEntityName

      public String getEntityName()
      Specified by:
      getEntityName in interface SituationWithEntityName
    • setEntityName

      public void setEntityName(String entityName)
    • getFormName

      @Nullable public @Nullable String getFormName()
      Specified by:
      getFormName in interface SituationWithFormName
    • setFormName

      public void setFormName(String formName)
    • getScope

      @Nullable public @Nullable String getScope()
      Description copied from interface: Situation
      Tells the scope for which this situation is. Example: 'update'.
      Specified by:
      getScope in interface Situation
      The scope in lower case, or null.
    • getScope

      public String getScope(String fallback)
      Specified by:
      getScope in interface Situation
    • setScope

      public void setScope(@Nullable @Nullable String scope)
    • getPlace

      public String getPlace()
      Description copied from interface: Situation
      Returns the place for the situation. Example: 'topToolbar'.
      Specified by:
      getPlace in interface Situation
    • setPlace

      public void setPlace(String place)
    • getScreen

      @Nullable public @Nullable String getScreen()
      Description copied from interface: Situation
      Tells the screen for which this situation is. Examples: 'explorer-main', 'explorer-relations', 'explorer-search', 'explorer-modal', 'home'.
      Specified by:
      getScreen in interface Situation
    • setScreen

      public void setScreen(String screen)
    • toString

      public String toString()
      toString in class Object
    • getName

      public String getName()
      Description copied from interface: Situation
      Tells the kind of situation it is, probably the class name.
      Specified by:
      getName in interface Situation
    • getModule

      @Nullable public @Nullable String getModule()
    • setModule

      public void setModule(@Nullable @Nullable String module)
    • getMainPrimaryKey

      public String getMainPrimaryKey()
    • setMainPrimaryKey

      public void setMainPrimaryKey(@Nullable @Nullable String mainPrimaryKey)