Package com.onenetwork.platform.ixm

Interface IXMEngine

public interface IXMEngine
Implements the core algorithm for a given IXM Engine. Given parameters, invokes the planning algorithm and produces a result.

  • Method Summary

    Modifier and Type Method Description
    IXMPlanResult plan​(IXMPlanParameters params)
    Implements the core algorithm for this engine.

  • Method Details

    • plan

      IXMPlanResult plan​(IXMPlanParameters params) throws IXMException
      Implements the core algorithm for this engine. Given parameters, invokes the planning algorithm and produces a result.
      Parameters:
      params - parameters required for plan execution
      Returns:
      a PlanResult object which describes the outcome of the plan - the type of this object is determined by the IXMEngineFactory
      Throws:
      IXMException - can be thrown to indicate that a plan could not be generated