Interface EntitiesExplorerView.ViewContext

  • All Known Implementing Classes:
    ExplorerViewContext
    Enclosing interface:
    EntitiesExplorerView

    public static interface EntitiesExplorerView.ViewContext

    The context for the entities explorer view.

    The view uses this callback methods for internal features management.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean canCreate()
      Allows enabling or disabling the entities creation feature.
      boolean canDelete()
      Allows enabling or disabling the entities delete feature.
      boolean canRead()
      Allows enabling or disabling the entities read feature.
      boolean canSearch()
      Allows enabling or disabling the entities search feature.
      boolean canSelect()
      Allows enabling or disabling the entities selection feature.
      Set<String> getConstrainedEntities()
      The entity identifiers that cannot be used.
      Set<String> getSelectedEntities()
      If canSelect() is enabled, the entity identifiers specified in the collection values will be mark as selected.
    • Method Detail

      • canSearch

        boolean canSearch()

        Allows enabling or disabling the entities search feature.

        Returns:

        Two possible values:

        • true - The entities explorer widget enables the search feature.
        • false - The entities explorer widget disables the search feature.
      • canCreate

        boolean canCreate()

        Allows enabling or disabling the entities creation feature.

        Returns:

        Two possible values:

        • true - The entities explorer widget enables the create feature.
        • false - The entities explorer widget disables the create feature.
        • null - The entities explorer widget will determine if create is enabled by using the UserSysteManager API.
      • canRead

        boolean canRead()

        Allows enabling or disabling the entities read feature.

        Returns:

        Two possible values:

        • true - The entities explorer widget enables the read feature.
        • false - The entities explorer widget disables the read feature.
      • canDelete

        boolean canDelete()

        Allows enabling or disabling the entities delete feature.

        Returns:

        Two possible values:

        • true - The entities explorer widget enables the delete feature.
        • false - The entities explorer widget disables the delete feature.
      • canSelect

        boolean canSelect()

        Allows enabling or disabling the entities selection feature.

        Returns:

        Two possible values:

        • true - The entities explorer widget enables the selection feature.
        • false - The entities explorer widget disables the selection feature.
      • getSelectedEntities

        Set<String> getSelectedEntities()

        If canSelect() is enabled, the entity identifiers specified in the collection values will be mark as selected.

        Returns:

        A collection of the selected entity identifiers present in the entities collection returned by getEntities(),

      • getConstrainedEntities

        Set<String> getConstrainedEntities()

        The entity identifiers that cannot be used.