Interface StructureProvider

  • All Known Implementing Classes:
    AbstractStructureProvider

    public interface StructureProvider
    Provides a structural view of a model. This structure information can be used on client side, typically to allow a user selection as an argument of a service execution. A StructureProvider is contributed using the com.sodius.mdw.server.structureProvider extension point.

    Clients may implement this interface. Clients are advised to use AbstractStructureProvider as base implementation.

    • Method Detail

      • getRoots

        List<Node> getRoots​(PropertySet properties)
                     throws CoreException
        Returns the list of root nodes of the structure.
        Parameters:
        properties - options configuring the retrieval of the root nodes. Those options are provided by the servlet request through headers or query parameters.
        Returns:
        the root nodes of the structure.
        Throws:
        CoreException - if anything prevents from retrieving the nodes.
      • getChildren

        List<Node> getChildren​(PropertySet properties,
                               String parentId)
                        throws CoreException
        Returns the list of child nodes of the specified parent node identifier.
        Parameters:
        properties - options configuring the retrieval of the children nodes. Those options are provided by the servlet request through headers or query parameters.
        parentId - the identifier of the parent node.
        Returns:
        the child nodes of the specified parent.
        Throws:
        CoreException - if anything prevents from retrieving the nodes.
        See Also:
        Node.getId()