Class RegionSection

java.lang.Object
org.pidome.server.entities.base.BaseEntity
org.pidome.server.services.premises.RegionSection
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
PremisesSection, PropertySection

@Entity
public abstract class RegionSection
extends BaseEntity
The base for any section. This entity contains two parameters which provides support to display this entity in an ordered manner with a combined compound name like:
  • premises/section
  • premises/property/level/section
The above is only available when a compound request is made. For example when retrieving items. These two parameters are transitive and can not be set or altered as this will have no result.
See Also:
Serialized Form
  • Constructor Details

  • Method Details

    • getName

      public java.lang.String getName()
      Returns:
      the name
    • setName

      public void setName​(java.lang.String name)
      Parameters:
      name - the name to set
    • getSectionType

      public PropertySectionType getSectionType()
      Return the property section type.
      Returns:
      The section type.
    • getItems

      public java.util.List<ItemMeta> getItems()
      The items linked to this section.
      Returns:
      the items
    • setItems

      public void setItems​(java.util.List<ItemMeta> items)
      The items linked to this section.
      Parameters:
      items - the items to set
    • getIcon

      public org.pidome.platform.presentation.icon.PresentationIcon getIcon()
      Returns:
      the icon
    • setIcon

      public void setIcon​(org.pidome.platform.presentation.icon.PresentationIcon icon)
      Parameters:
      icon - the icon to set
    • setCompoundName

      public void setCompoundName​(java.lang.String compoundName)
      Sets the name with all levels combined.
      Parameters:
      compoundName - The combined name.
    • getCompoundName

      public java.lang.String getCompoundName()
      Returns the combined name. This parameter is only available when a combined set is returned.
      Returns:
      The section with all upper levels combined.
    • setCompoundOrder

      public void setCompoundOrder​(int compoundOrder)
      Returns the order in which this section could be shown.
      Parameters:
      compoundOrder - The order of the section.
    • getCompoundOrder

      public int getCompoundOrder()
      The order number of showing the combined section. This method is only valid when a combined set is returned.
      Returns:
      The order number.