Methods

Model

The constructor creates a new Model object.

public Model (    String host,
                  String port)

Parameters:

• host - the location of ITP/OnLine Server
• port - the port that ITP/OnLine Server listens to.

List

Lists the models that the user (as indicated by the current set of properties) is allowed to access.

  public boolean List ()
               throws Exception
  public boolean List (
                    String pattern)
                throws Exception

Parameters:

• pattern (optional) - the pattern the file names of the models must adhere to.

Returns:

false if the function failed. In that case the Info file contains XML error data. If the function succeeds it returns false, and the Info file contains a list of models.

Start

The RunModel functionality is split in two method calls: Start and Continue. Start must always be called first. Depending on the outcome of the previous call, zero or more Continue calls will be needed.

  public int Start (
                    String model,
                    String result,
                    String keys,
                    String extras)
            throws Exception

  public int Start (
                    String model,
                    String result,
                    String keys,
                    String extras,
                    String preCMD,
                    String postCMD,
                    String onSuccessCMD,
                    String onFailureCMD)
            throws Exception

Parameters:

• model - the model to run, given as relative path in the model directory on the server
• result - the URI of the file of the result. By default, this URI is a location relative to the user of the Java API itself. In that case, the API will retrieve the document from ITP/Server and store it at this location. The user must then ensure that the API is able to write at this location. Also see the DocumentOnServer flag for alternative use.
  The value passed here can be retrieved as the DocumentURI property.
• keys - the keys string, in ITP/Server format (there is no keys file support). A special "*DataURI" value refers to the XML file as indicated by the DataURI property. For models that need access to an XML file either this key and DataURI must be specified, or the actual path, relative to ITP/Server.
• extras - the extras string, in ITP/Server format (no extras file support).
• PreCMD - AS/400 only. The Pre command is executed after the library list is set.

  Note

  The api user should be aware that this Pre command is executed when the model needs to get data from the database. If the model is set up in such a way that interact statements follow on this data access, the pre command will be executed the first time the data is accessed and every time the Continue call is called.

• OnSuccessCMD - AS/400 only. The OnSuccess command is executed if the model is completed successfully.
• OnFailureCMD - AS/400 only. The OnFailure command is executed if the model failed.
• PostCMD - AS/400 only. The Post command is executed at the end of the run (after OnSuccess or OnFailure).

  Note

  The API user should be aware that this Post command is executed after every run of the model. This means that the Post command is executed for the Start call and all its Continue calls.

Return:

• An enumeration type that indicates what this call returns. See the Types section.

Continue

If Start(), or another Continue() call have returned ModelResultInteract, and the user has been prompted to provide answers to the interact questions, Continue() can be called to continue model execution.

  public int Continue (
                    String response,
                    String submission)
                throws Exception

Parameters:

• response - contains a reference to a file with the answer(s) to an ITP Model interact that has been returned earlier.
• submission - the Submission parameter indicates what the user has pressed in the INTERACT screen. The possible values of this parameter are passed in the XML File that holds the INTERACT questions (element button).
• Finish - this may be called after a ModelResultReady result has been returned to indicate that the user has accepted the model. ITP/Server may use this as a clean-up signal. It is not mandatory that users call Finish.
  Calling Finish clears the session id.

  public boolean Finish ()
                throws Exception

Upload

This method will send the file indicated by the filename argument to ITP/Server. The file will be stored under an automatically generated unique name in the session directory on the server. The server-side name will be returned as the return value of this call as a "file:<name>" URI. The name is a relative path w.r.t. the session directory on the server. If the call fails, an empty string will be returned and the info file will contain additional error data.

The stored files will at least remain present at the server until Finish is called.

Upload will only work as long as a session id is present, i.e. between calls of Start and Finish.

  public String Upload (
                    String filename)
                throws Exception

Parameters:

• filename - name of the file to upload

Returns:

Local name on the server, empty string on error.