API

[KyleChamberlin]

we need to define what functions we want in the API.

1. boolean Job.exists()
2. Job Job.create(int jobNumber)
3. void Job.addData(File filename)
4. void Job.addResources(File filename)
5. void Job.commit(String message)

@danielcovington anything else you think we might need?

[danielcovington]

This seems to me at first glance to be okay. I dont really know what it takes to automate this so I think my opinion is a little worthless on this.

[KyleChamberlin]

I guess I should rephrase, I can handle the automation, it is more about what functions to expose to the PDF-Sorter (or any other program) so that they can interact with the repo. in the end all the library can do is automate the various functions, ideally, the program would be in charge of what goes into the repository, when to commit, what to do when there already exists a job with that job number.. there are going to need to be handled by the parent script/program. so I would like to figure out an API that could be used in various scripts and/or programs that would be consistent. and more than anything easily usable by any scripts that are written in the future. this is why I asked for the insight. I know what needs to happen in order to automate teh process, but I need to know if there are any API functions that would prove helpful to the outside observer.

[danielcovington]

Oh okay. For the API. The simpler the better.

bool job.CreateSubmission (intJobNumber,FlagOverwrite,FlagAppend,FlagCreate)
bool job.AddFile(EnumFileType,FileName)
bool Job.Commit(strComments)

I wonder if you wanna try to make this into a java bean and then we can use it as an ActiveX object that would make it easier to use in autoit or any other language that can use ActiveX. You could also use .net and make it accessible as a com object. Just a thought

[KyleChamberlin]

I like the idea of using a javabean. each user would have to install the java bridge for actveX to make that work, so that is something to keep in mind too.

[danielcovington]

I know. Its not that big of a deal to me. And you get to use Java !!! I would like to see how it works in the real world as well.

From: Kyle Chamberlin [mailto:notifications@github.com]
Sent: Thursday, August 14, 2014 9:39 AM
To: KentCommunications/git-integration
Cc: Daniel Covington
Subject: Re: [git-integration] API (#2)

I like the idea of using a javabean. each user would have to install the java bridge for actveX to make that work, so that is something to keep in mind too.

—
Reply to this email directly or view it on GitHub #2 (comment) . https://github.com/notifications/beacon/6976570__eyJzY29wZSI6Ik5ld3NpZXM6QmVhY29uIiwiZXhwaXJlcyI6MTcyMzY0MjcyMywiZGF0YSI6eyJpZCI6Mzk1NjUzNzF9fQ==--774484f31446ca0e2fc009923d2f9cd4c6d54d67.gif