com.flowcentraltech.flowcentral.codegeneration.business.CodeGenerationModuleService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flowcentral-codegeneration Show documentation

Flowcentral Code-generation Module

There is a newer version: 3.2.1

Show newest version

/*
 * Copyright 2021-2024 FlowCentral Technologies Limited.
 * 
 * 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.flowcentraltech.flowcentral.codegeneration.business;

import com.flowcentraltech.flowcentral.codegeneration.data.Snapshot;
import com.flowcentraltech.flowcentral.codegeneration.data.SnapshotMeta;
import com.flowcentraltech.flowcentral.common.business.FlowCentralService;
import com.tcdng.unify.core.UnifyException;
import com.tcdng.unify.core.task.TaskMonitor;

/**
 * Code generation module service.
 * 
 * @author FlowCentral Technologies Limited
 * @since 1.0
 */
public interface CodeGenerationModuleService extends FlowCentralService {

    /**
     * Generates custom application snapshot.
     * 
     * @param meta snapshot meta
     * @param basePackage
     *                    the base package
     * @return the snapshot
     * @throws UnifyException
     *                        if an error occurs
     */
    Snapshot generateSnapshot(SnapshotMeta meta, String basePackage) throws UnifyException;

    /**
     * Generates custom application snapshot.
     * 
     * @param meta snapshot meta
     * @param basePackage
     *                    the base package
     * @return the snapshot
     * @throws UnifyException
     *                        if an error occurs
     */
    Snapshot generateSnapshot(TaskMonitor taskMonitor, SnapshotMeta meta, String basePackage) throws UnifyException;
}