/*
 * Copyright 2002-2015 SCOOP Software GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.copperengine.management;

import java.util.List;

import org.copperengine.management.model.EngineActivity;
import org.copperengine.management.model.EngineType;
import org.copperengine.management.model.WorkflowInfo;
import org.copperengine.management.model.WorkflowInstanceFilter;

public interface ProcessingEngineMXBean {
    public String getState();

    public String getEngineId();

    public EngineType getEngineType();

    /**
     * Query all <b>currently Running</b> instances from memory only, <b>Note it WON'T return instances in WAITING
     * state</b>
     * @return List of workflow information
     */
    public List<WorkflowInfo> queryWorkflowInstances();

    /**
     * Query all active instances, this includes instances in ENQUEUED, WAITING and RUNNING state
     * 
     * @param className
     *        - optional, returns workflow instances
     * @param max
     *        - to limit of number of workflows returned
     * @return List of workflow information
     */
    public List<WorkflowInfo> queryActiveWorkflowInstances(String className, int max);

    /**
     * query one workflow instance from memory, <b>Note it WON'T return instances in WAITING state</b>
     * 
     * @param id workflow id
     * @return info about this single workflow (Not if workflow is waiting). null if workflow not found.
     */
    public WorkflowInfo queryWorkflowInstance(String id);

    /**
     * query one workflow instance from memory or db regardless of its state
     * 
     * @param id workflow id
     * @return info about this single workflow. null if workflow not found.
     */
    public WorkflowInfo queryActiveWorkflowInstance(String id);

    public int getNumberOfWorkflowInstances();

    public List<ProcessorPoolMXBean> getProcessorPools();

    public WorkflowRepositoryMXBean getWorkflowRepository();

    public String getDependencyInjectorType();

    public String getStatisticsCollectorType();
    
    public EngineActivity queryEngineActivity(int minutesInHistory);
    
    /**
     * @return a list of all possible workflow instance states
     */
    public List<String> getWorkflowInstanceStates();
    
    public List<WorkflowInfo> queryWorkflowInstances(WorkflowInstanceFilter filter);
}