Adobe-Consulting-Services/acs-aem-commons

/*
 * ACS AEM Commons
 *
 * Copyright (C) 2013 - 2023 Adobe
 *
 * 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 com.adobe.acs.commons.mcp;

import com.adobe.acs.commons.fam.ActionManagerFactory;
import com.adobe.acs.commons.mcp.form.FieldComponent;
import com.adobe.acs.commons.mcp.mbean.CPMBean;
import java.util.Collection;
import java.util.Map;
import org.apache.jackrabbit.api.security.user.User;
import org.apache.sling.api.resource.LoginException;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.api.scripting.SlingScriptHelper;
import org.osgi.annotation.versioning.ProviderType;

/**
 * Core management container for managing controlled processes.
 */
@ProviderType
public interface ControlledProcessManager extends CPMBean {

    ActionManagerFactory getActionManagerFactory();

    ProcessInstance getManagedProcessInstanceByPath(String path);

    ProcessInstance getManagedProcessInstanceByIdentifier(String id);

    ProcessInstance createManagedProcessInstance(ProcessDefinition definition, String description);

    ResourceResolver getServiceResourceResolver() throws LoginException;

    ProcessDefinition findDefinitionByNameOrPath(String nameOrPath) throws ReflectiveOperationException;

    Collection<ProcessInstance> getActiveProcesses();

    Collection<ProcessInstance> getInactiveProcesses();

    public Map<String, ProcessDefinitionFactory> getAllProcessDefinitionsForUser(User user);

    public Map<String, FieldComponent> getComponentsForProcessDefinition(String processDefinitionName, SlingScriptHelper sling) throws ReflectiveOperationException;
}