Triton160/Triton160Common/Interface/IRecipeService.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Runtime.Serialization;

namespace Aitex.Triton160.Common.Interface
{
    [ServiceContract]
    public interface IRecipeService
    {
        [OperationContract]
        string LoadRecipe(ModuleName chamId, string recipeName);

        /// <summary>
        /// 调取当前反应腔的工艺程序信息
        /// </summary>
        /// <param name="chamId"></param>
        /// <returns> recipeName + recipeContent </returns>
        [OperationContract]
        Tuple<string, string> LoadRunTimeRecipeInfo(ModuleName chamId);

        /// <summary>
        /// Get a list of all recipe names.
        /// </summary>
        /// <param name="chamId"></param>
        /// <param name="includeUsedRecipe"></param>
        /// <returns></returns>
        [OperationContract]
        IEnumerable<string> GetRecipes(ModuleName chamId, bool includeUsedRecipe);

        /// <summary>
        /// Get recipe list in xml format
        /// </summary>
        /// <param name="chamId"></param>
        /// <param name="includeUsedRecipe"></param>
        /// <returns></returns>
        [OperationContract]
        string GetXmlRecipeList(ModuleName chamId, bool includeUsedRecipe);

        /// <summary>
        /// delete a existed recipe by recipe name
        /// </summary>
        /// <param name="chamId"></param>
        /// <param name="recipeName"></param>
        /// <returns></returns>
        [OperationContract]
        bool DeleteRecipe(ModuleName chamId, string recipeName);

        /// <summary>
        /// delete an existed folder
        /// </summary>
        /// <param name="chamId"></param>
        /// <param name="folderName"></param>
        /// <returns></returns>
        [OperationContract]
        bool DeleteFolder(ModuleName chamId, string folderName);

        /// <summary>
        /// SaveAs recipe by recipe name and recipe data
        /// </summary>
        /// <param name="chamId"></param>
        /// <param name="recipeName"></param>
        /// <param name="recipeContent"></param>
        /// <returns></returns>
        [OperationContract]
        bool SaveAsRecipe(ModuleName chamId, string recipeName, string recipeContent);

        /// <summary>
        /// Save recipe by recipe name and recipe data
        /// </summary>
        /// <param name="chamId"></param>
        /// <param name="recipeName"></param>
        /// <param name="recipeContent"></param>
        /// <returns></returns>
        [OperationContract]
        bool SaveRecipe(ModuleName chamId, string recipeName, string recipeContent);

        /// <summary>
        /// Save recipe by recipe name and recipe data
        /// </summary>
        /// <param name="chamId"></param>
        /// <param name="folderName"></param>
        /// <returns></returns>
        [OperationContract]
        bool CreateFolder(ModuleName chamId, string folderName);

        /// <summary>
        /// Move recipe by recipe name and recipe data
        /// </summary>
        /// <param name="chamId"></param>
        /// <param name="folderName"></param>
        /// <param name="tragetFolderName"></param>
        /// <returns></returns>
        [OperationContract]
        bool MoveRecipeFile(ModuleName chamId, string folderName, string tragetFolderName);
        /// <summary>
        /// Rename recipe file
        /// </summary>
        /// <param name="chamId"></param>
        /// <param name="oldName"></param>
        /// <param name="newName"></param>
        /// <returns></returns>
        [OperationContract]
        bool RenameRecipe(ModuleName chamId, string oldName, string newName);

        /// <summary>
        /// Rename recipe folder
        /// </summary>
        /// <param name="chamId"></param>
        /// <param name="oldName"></param>
        /// <param name="newName"></param>
        /// <returns></returns>
        [OperationContract]
        bool RenameFolder(ModuleName chamId, string oldName, string newName);

        /// <summary>
        /// get reactor's recipe format define file
        /// </summary>
        /// <param name="chamId"></param>
        /// <returns></returns>
        [OperationContract]
        string GetRecipeFormatXml(ModuleName chamId);

        /// <summary>
        /// get reactor's template recipe file
        /// </summary>
        /// <param name="chamId"></param>
        /// <returns></returns>
        [OperationContract]
        string GetRecipeTemplate(ModuleName chamId);

        [OperationContract]
        string GetRecipeByBarcode(ModuleName chamId, string barcode);

    }
}