Interface Collection

All Superinterfaces:
Resource

public interface Collection extends Resource
The Collection Interface. Collection is specific type of Resource that can contain other resources (including other collections). We call the resources contained in a collection as the children of the collection and the collection is called the parent of its children.

The path of the child = The path of the parent + RegistryConstants.PATH_SEPARATOR + The resource name of the child. The ROOT collection is a specific instance of the Collection interface which doesn't have a parent.

  • Field Details

  • Method Details

    • getChildren

      String[] getChildren() throws RegistryException
      Method to return the absolute paths of the children of the collection
      Returns:
      the array of absolute paths of the children
      Throws:
      RegistryException - if the operation fails.
    • getChildren

      String[] getChildren(int start, int pageLen) throws RegistryException
      Method to return the paths of the selected range of children.
      Parameters:
      start - the starting number of children.
      pageLen - the number of entries to retrieve.
      Returns:
      an array of paths of the selected range of children.
      Throws:
      RegistryException - if the operation fails.
    • getChildCount

      int getChildCount() throws RegistryException
      Method to return the the number of children.
      Returns:
      the number of children.
      Throws:
      RegistryException - if the operation fails.
    • setChildren

      void setChildren(String[] paths) throws RegistryException
      Method to set the absolute paths of the children belonging to this collection. Absolute paths begin from the ROOT collection.
      Parameters:
      paths - the array of absolute paths of the children
      Throws:
      RegistryException - if the operation fails.