Class ProcessEngineFactory

    • Field Detail

      • PROPERTY

        public static final String PROPERTY
        This define denotes the key that is used to locate a match engine factory implementation.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ProcessEngineFactory

        public ProcessEngineFactory()
    • Method Detail

      • getInstance

        public static IProcessEngineFactory getInstance()
        Acquires an instance of IProcessEngineFactory. A different implementation can be registered to the ClassFactory by the PROPERTY constant within this class. Note: Once constructed the actual factory is statically cached. therefore once this class is loaded always the same instance is returned.
        Returns:
        The actual factory implementation.
      • setFactory

        public static void setFactory​(IProcessEngineFactory factory)
        Sets a new process engine factory.
        Parameters:
        factory - the new process engine factory
      • create

        public IProcessEngine create​(IProcessExtensionFactory factory,
                                     IProcessEngineDS processEngineDataSource,
                                     IRuleEngine ruleEngine,
                                     IMetaModel model,
                                     IProject project,
                                     IProcessCaseDao dao,
                                     ProcessSettings settings,
                                     ILicenseProvider licenseProvider,
                                     ITraceEngine traceEngine,
                                     IScheduler scheduler,
                                     CaseEngineScheduler caseEngineScheduler,
                                     ListsEventPublisher listsEventPublisher,
                                     ILegacyToggles legacyToggles)
                              throws InitializationException
        Description copied from interface: IProcessEngineFactory
        This method creates a new process engine using the specified data source.
        Specified by:
        create in interface IProcessEngineFactory
        Parameters:
        factory - The factory used by the processengine.
        processEngineDataSource - The data source providing the flow information.
        ruleEngine - Rule engine containing the various business rules and the expression parser.
        model - The model that should be used for the case data.
        project - The project that contains object definitions.
        dao - The DAO that should be used to persist process information.
        settings - processEngine settings to use
        licenseProvider - The optional license provider that is used to check if process engine construction is allowed.
        traceEngine - The trace engine to use
        scheduler - The scheduler used for controlling jobs.
        caseEngineScheduler - The scheduler used for controlling jobs if the case-engine is enabled.
        listsEventPublisher - The publisher to use for signaling the DCm Lists Service that an aspect of a case or task has changed.
        legacyToggles - parameter for providing legacy behavior for temporarily support of backwards compatibility.
        Returns:
        Process engine implementation for the specified data source.
        Throws:
        InitializationException - This exception is thrown when the process engine could not be initialized due to a fatal error.