Package wt.vc.config.custom

Interface CustomConfigSpecDelegate

public interface CustomConfigSpecDelegate
The interface defining a set of common operations that need to be implemented per CustomConfigpecDelegate type

Supported API: true

Extendable: true

  • Method Details

    • appendSearchCriteria

      QuerySpec appendSearchCriteria(QuerySpec querySpec) throws WTException
      Appends to the supplied QuerySpec additional search criteria to reduce the resulting iterations to only those that will be considered by this ConfigSpecDelegate. Appending additional classes to the QuerySpec is allowed (for join purposes), but those that are marked as selectable will be trimmed by "filteredIterationsOf" prior to it calling the "process" API.

      The QueryResult returned should be a copy of the passed in one (taking advantage of side-effects is not encouraged).

      Parameters:
      querySpec - A QuerySpec with a target class that is Iterated.
      Returns:
      QuerySpec
      Throws:
      WTException
      QueryException
      See Also:

    • process

      QueryResult process(QueryResult results) throws WTException
      Process the QueryResult of iterations, returning only those that "match" according to the algorithm.

      The QueryResult returned should be a copy of the passed-in QueryResult (side-effects should be avoided).

      Parameters:
      results - QueryResult of iterations to filter. Assumed to be the result of a query that included the additional search conditions applied by appendSearchCriteria. Note that after enumerating through the elements of this QueryResult, it should be reset.
      Returns:
      QueryResult
      Throws:
      WTException
      See Also:

    • setAttributesMap

      void setAttributesMap(Map<String,CustomConfigSpecAttribute> attributesMap)
      Setter for an attributes map passed from the client.

      Supported API: true
      Parameters:
      attributesMap -
      See Also: