Package wt.vc.config

Interface GetConfigSpecForDelegate2

All Known Implementing Classes:
DefaultGetConfigSpecForDelegate, EPMDocGetConfigSpecForDelegate, PFMatrixEditorGetConfigSpecForDelegate, PSBVariantSpecGetConfigSpecForDelegate, WTDocumentGetConfigSpecForDelegate, WTPartGetConfigSpecForDelegate
public interface GetConfigSpecForDelegate2
Delegate that is used by ConfigService.getConfigSpecFor(NavCriteriaContext) to create the list of ConfigSpec.

The delegate is looked up using service name = wt.vc.config.GetConfigSpecForDelegate and requestor = NavCriteriaContext.getApplicableType() and optional selector = NavCriteriaContext.getApplicationName(). The delegate can be registered with or without a selector but the system will give precedence to a delegate registered with a selector that matches the NavCriteriaContext.getApplicationName().

To create a custom delegate, extend one of the classes WTPartGetConfigSpecForDelegate, WTDocumentGetConfigSpecForDelegate, or EPMDocGetConfigSpecForDelegate. Then register that delegate using the xconfmanager with the service name, selector, and requestor as defined above.



Supported API: true

Extendable: true

  • Method Details

    • getConfigSpecFor

      List<ConfigSpec> getConfigSpecFor(NavCriteriaContext context) throws WTException
      Method to get a list of ConfigSpecs given the parameters in the NavCriteriaContext. This method is not called if a sandbox config spec is needed.

      Supported API: true

      Extendable: true
      Parameters:
      context - Information about the context in which the ConfigSpecs are being requested.
      Returns:
      A list of ConfigSpecs.
      Throws:
      WTException - On error.

    • getSandboxConfigSpecFor

      List<ConfigSpec> getSandboxConfigSpecFor(NavCriteriaContext context) throws WTException
      Method to create a sandbox config spec using the parameters given in the NavCriteriaContext. This method is only called if a sandbox config spec is needed. Use the following code to construct the sandbox config spec and return it or encapsulate it in a higher-level config spec. return Arrays.asList(GetConfigSpecForDelegate2Helper.getDefaultSandboxConfigSpec(context));

      Supported API: true

      Extendable: true
      Parameters:
      context - Information about the context in which the ConfigSpecs are being requested.
      Returns:
      A list of ConfigSpecs.
      Throws:
      WTException - On error.