namespace AnalysisServices.Contracts
{
public interface IAnalysisService : IDisposable
{
/// <summary>
/// Returns information about the application that is being exposed over REST.
/// </summary>
/// <returns></returns>
ServiceInfo GetServiceInfo();

/// <summary>
/// Returns a list of resources that the application supports.
/// An empty list if none (ideally this should never be the case)
/// </summary>
/// <returns></returns>
List<Model> GetModels();

/// <summary>
/// Called when all models are to be deleted.
/// </summary>
void DeleteAllModels();

/// <summary>
/// Called by the Agent to get an instance of the model object given the model name.
/// </summary>
/// <param name="modelName"></param>
Model GetModel(string modelName);

/// <summary>
/// Deletes a specified model
/// </summary>
/// <param name="modelName"></param>
void DeleteModel(string modelName);

/// <summary>
/// Return the inputs that are required by this model as a
/// tree structure contained in the ParamField array
/// </summary>
/// <param name="modelName"></param>
/// <returns></returns>
ParamField[] GetInputData(String modelName);

/// <summary>
/// Return the outputs that are generated by as a result of running a job
/// based on the given model as a tree structure contained in the ParamField array
/// </summary>
/// <param name="modelName"></param>
/// <returns></returns>
ParamField[] GetResultData(String modelName);

/// <summary>
/// This method is used primarily used to run jobs that are discrete i.e to be executed only
/// once as opposed to a continuous job which can continue to run indefinitely.
/// A discrete job can be run asynchronusly (in which case the method returns right away with
/// an inprocess status)or it can be run synchronously.
/// The implementation must inspect the flags on the job to determine
/// if the job is synchronous or asynchronous.
/// </summary>
/// <param name="jb"></param>
/// <returns></returns>
Job PostJob(Job jb);

/// <summary>
/// Return a list of jobs that are being held by the AnalysisService.
/// The jobs could be completed job,continuous jobs or inprogress and failed jobs.
/// </summary>
/// <returns></returns>
List<Job> GetJobs();

/// <summary>
/// Delete all jobs that are being held in the AnalysisService. If any jobs are running
/// they should be stopped and removed.
/// </summary>
void DeleteJobs();

/// <summary>
/// Get a job with the given job id.
/// </summary>
/// <param name="id"></param>
/// <returns></returns>
Job GetJob(string id);

/// <summary>
/// delete the given job , stop the job if it is still running
/// </summary>
/// <param name="id"></param>
void DeleteJob(string id);

/// <summary>
/// Called by the AnalysisAgent to deploy a model file if the
/// analysis provider supports file based models.
/// </summary>
/// <param name="fileName"></param>
/// <param name="m"></param>
void DeployModel(Model m);

/// <summary>
/// a reference to a method that should be called by the analysis provider
/// to provide job result updates for Async and continuous jobs.
/// </summary>
/// <param name="jb"></param>
void SetJobUpdateDelegate(JobUpdateDelegate jud);

/// <summary>
/// a reference to a method that should be called by the analysis provider
/// to provide job result updates for Async and continuous jobs.
/// </summary>
/// <param name="jb"></param>
void SetJobFileUploadDelegate(JobFileUploadDelegate jfud);

/// <summary>
/// Called by the AnalysisSDKAgent when new input needs to be provided
/// for a continuous job .
/// </summary>
/// <param name="jobId"></param>
/// <param name="mapProps"></param>
void UpdateJob(string jobId, string json);

/// <summary>
/// The StartJob method is called by the AnalysisSDK to start a continuous job
/// This method can be used by the implementation to set up data structures for
/// executing the job, the updates to inputs are provided via the UpdateJob method.
/// This happens whenever a triggering configuration is enabled.
/// </summary>
/// <param name="jb"></param>
/// <returns></returns>
Job StartJob(Job jb);

/// <summary>
/// This method is called by the AnalysisSDKAgent when a job needs to be stopped.
/// This is called whenever a triggering configuration is disabled or deleted.
/// </summary>
/// <param name="jobid"></param>
/// <returns></returns>
bool StopJob(string jobid);

/// <summary>
/// The AnalysisProvider should implement this to dispose of resources.
/// It is not currently not invoked directly by the analysis service.
/// </summary>
/// <param name="disposing"></param>
void Dispose(bool disposing);
}

//get the number of queued jobs. If the analysis service suports queuing
//then this should return the number of jobs in the queue .
int GetQueuedJobsCount();

void Initialize(Dictionary<string,object> dict );

//return value > 0 if pid of the analysis service is known
ulong GetPID();

//abort a job
bool AbortJob(string jobId); /// <summary>

/// The delegate method that is implemented by the AnalysisSDK and set using the SetJobDelegate
/// method. The application must call this method to report the progress and status of the job.
/// </summary>
/// <param name="jobid"></param>
/// <param name="status"></param>
/// <param name="xml"></param>
/// <param name="files"></param>
public delegate void JobUpdateDelegate(Job jb);

/// <summary>
/// The delegate method that is implemented by the AnalysisSDK and set using the JobFileUploadDelegate
/// method. The application must call this method upload files asynchronously without changing the job state.
/// </summary>
/// <param name="jobid"></param>
/// <param name="status"></param>
/// <param name="xml"></param>
/// <param name="files"></param>
public delegate void JobFileUploadDelegate(string jobId,string []files);
}

public class Model
{
public string ResourceName { get; set; }
public string ResourceType { get; set; }
public bool Available { get; set; }
public long UpdateTimestamp { get; set; }
public ParamField[] InputData { get; set; }
public ParamField[] ResultData { get; set; }
public long CreateTimestamp { get; set; }
public string FileName { get; set; }
public string[] includedFiles { get; set; }
}

public class ParamField
{
//special constructor to provide default initialization for the given fields
public string IDField { get; set; }
public string Description { get; set; }
public string ParentIDField { get; set; }
public string MaxValue { get; set; }
public string Unit { get; set; }
public int Depth { get; set; }
public string DefaultValue { get; set; }
public string BaseType { get; set; }
public int Ordinal { get; set; }
public string MinValue { get; set; }
public bool isPrimary { get; set; }

public ParamField(string idfield,string parentid,int depth,int ordinal,string basetype)
{
IDField = idfield;
ParentIDField = parentid;
Depth = depth;
Ordinal = ordinal;
BaseType = basetype;
Description = "default description";
}
}

public abstract class Job
{
public bool isContinuous { get; set; } // true if this is a simulation job
public string id { get; set; } //id of the job, this can be changed by the service
public string key { get; set; } // key is usually the same as the id.
public string resourceServiceProvider { get; set; } //the provider that is invoking the job
public string resourceName { get; set; } //the name of resource on the server
public string status { get; set; } //the status of the job
public long updateTimeStamp { get; set; }
public bool isAsync { get; set; } // true if this is a asynchronous job
public string inputParams { get ; set ; } //the input params as a json string
public string results { get ; set ; } //results as json string .
public string assignedTo { get; set; } //the client to which this job is assigned.
public long jobStartTime { get; set; }
public long createTimeStamp { get; set; }
public string[] resultFiles { get ; set ; } //if result files are generated as a result of job execution
public string errorCode { get; set; } //application specific error code to be set by the service
public string errorMessage { get; set; } //the localized error message to be set by the service if an error occurs.
public string errorDetails { get; set; } // the exception or heap dump if the service wishes to report it.
}

namespace AnalysisServices.Contracts
{
/// <summary>
/// Contracts for getting access to thingworx connectedclient in order to invoke services on thingworx server
/// </summary>
interface IAnalysisTwxClientRequired
{
//Set the connectedthinglient instance
// <param name="client"></param>
void SetClient(ConnectedThingClient client);

/// <summary>
/// Returns the ConnectedClient instance in order to get access to the thingworx server
/// </summary>
/// <returns></returns>
ConnectedThingClient GetClient();
}
}

namespace AnalysisServices.Contracts
{
/// <summary>
/// Interface defining contracts for processing messages from thingworx server
/// </summary>
interface IAnalysisMessageSink
{
/// <summary>
/// processes the incoming message from twx server
/// </summary>
/// <param name="payLoad"></param>
void processMessage(JObject payLoad);
}
}