Interface IStructureWithOpenStatus

All Superinterfaces:
IPropertyHolder, IPropertyHolderConst

public interface IStructureWithOpenStatus extends IPropertyHolder
Represents an openable structure.

All structures that implement this interface need to register the Property.OPEN_STATUS property in their structure type.

  • Method Details

    • isOpenable

      default boolean isOpenable()
      Checks if this structure can be opened right now.
      Returns:
      True if this structure can be opened right now.
    • isCloseable

      default boolean isCloseable()
      Checks if this structure can be closed right now.
      Returns:
      True if this structure can be closed right now.
    • isOpen

      default boolean isOpen()
      Check if the Structure is currently open.
      Returns:
      True if the Structure is open
    • setOpenStatus

      default IPropertyValue<Boolean> setOpenStatus(boolean open)
      Sets the open status of the structure.
      Parameters:
      open - The new open status of the structure. True if the structure is open, false if it is closed.
      Returns:
      The previous property value of the open status property.
    • setOpen

      default IPropertyValue<Boolean> setOpen()
      Sets the structure to be open.
      Returns:
      The previous property value of the open status property.
    • setClosed

      default IPropertyValue<Boolean> setClosed()
      Sets the structure to be closed.
      Returns:
      The previous property value of the open status property.