msi.web.client
Interface MsiAppOriginatorInterface

All Superinterfaces:

java.rmi.Remote

public interface MsiAppOriginatorInterface

extends java.rmi.Remote

This is the super xml object that takes an xml document as input and then creates and application record. The xml document can contain the following IN ORDER:
1) One Customer record
2) Multiple (Co)Lessee records
3) Multiple Guarantor records
4) One Vendor record
5) One Broker record
6) One Application record
7) One Asset Delete record
8) Multiple Asset records
9) One Insurance record
10) Multiple UDF records
11) One Notebook record

Author:

Joseph Acosta Copyright by NetSol - Nov 22, 2004

Method Summary

java.lang.String	createAppAsUserRetMsg(java.lang.String username, java.lang.String pwd, java.lang.String xmlDocument, boolean addOnly) Call this when you want to add or update using a specific user name.
boolean	createApplication(java.lang.String xmlDocument, boolean addOnly) Call this when you want to update or add using the API username and password.
boolean	createApplicationAsUser(java.lang.String username, java.lang.String pwd, java.lang.String xmlDocument, boolean addOnly) Call this when you want to add or update using a specific user name.
java.lang.String	createAppRetMsg(java.lang.String xmlDocument, boolean addOnly) Call this when you want to update or add using the API username and password.
boolean	deleteAssets(java.lang.String applicationNumber) deprecated in v53a, use the createApp* functions and AFTER the APPLICATION_RECORD but before the ASSET_RECORD ( or by itself ) you can send: <ASSET_DELETE> <appNumber>application number</appNumber> </ASSET_DELETE> where application number is the number of the application you want to delete
boolean	deleteAssetsAsUser(java.lang.String username, java.lang.String pwd, java.lang.String applicationNumber) deprecated in v53a, use the createApp* functions and AFTER the APPLICATION_RECORD but before the ASSET_RECORD ( or by itself ) you can send: <ASSET_DELETE> <appNumber>application number</appNumber> </ASSET_DELETE> where application number is the number of the application you want to delete
java.lang.String	getMessages() This gets the message that occured during the transaction.

Method Detail

createAppAsUserRetMsg

public java.lang.String createAppAsUserRetMsg(java.lang.String username,
                                              java.lang.String pwd,
                                              java.lang.String xmlDocument,
                                              boolean addOnly)
                                       throws java.rmi.RemoteException

Call this when you want to add or update using a specific user name. This is a single synchronous, stateless API call. No session needs to be sent or stored.

Parameters:

username - - username

pwd - - leasepak pretty password

xmlDocument - - super massive xml document

addOnly - - weather or not you only want to add this document or also allow updates

Returns:

String - same as getMessages().

Throws:

java.rmi.RemoteException

createAppRetMsg

public java.lang.String createAppRetMsg(java.lang.String xmlDocument,
                                        boolean addOnly)
                                 throws java.rmi.RemoteException

Call this when you want to update or add using the API username and password. This is a single synchronous, stateless API call. No session needs to be sent or stored.

Parameters:

xmlDocument - - super massive xml document

addOnly - - weather or not you only want to add this document or also allow updates

Returns:

String - same as getMessages().

Throws:

java.rmi.RemoteException

createApplicationAsUser

public boolean createApplicationAsUser(java.lang.String username,
                                       java.lang.String pwd,
                                       java.lang.String xmlDocument,
                                       boolean addOnly)
                                throws java.rmi.RemoteException

Call this when you want to add or update using a specific user name.

Parameters:

username - - username

pwd - - leasepak pretty password

xmlDocument - - super massive xml document

addOnly - - weather or not you only want to add this document or also allow updates

Returns:

boolean - true on success or false on fail.

Throws:

java.rmi.RemoteException

createApplication

public boolean createApplication(java.lang.String xmlDocument,
                                 boolean addOnly)
                          throws java.rmi.RemoteException

Call this when you want to update or add using the API username and password.

Parameters:

xmlDocument - - super massive xml document

addOnly - - weather or not you only want to add this document or also allow updates

Returns:

boolean - true on success or false on fail.

Throws:

java.rmi.RemoteException

deleteAssets

public boolean deleteAssets(java.lang.String applicationNumber)
                     throws java.rmi.RemoteException

deprecated in v53a, use the createApp* functions and AFTER the APPLICATION_RECORD but before the ASSET_RECORD ( or by itself ) you can send:

<ASSET_DELETE>
<appNumber>application number</appNumber>
</ASSET_DELETE>

where application number is the number of the application you want to delete

Throws:

java.rmi.RemoteException

deleteAssetsAsUser

public boolean deleteAssetsAsUser(java.lang.String username,
                                  java.lang.String pwd,
                                  java.lang.String applicationNumber)
                           throws java.rmi.RemoteException

deprecated in v53a, use the createApp* functions and AFTER the APPLICATION_RECORD but before the ASSET_RECORD ( or by itself ) you can send:

<ASSET_DELETE>
<appNumber>application number</appNumber>
</ASSET_DELETE>

where application number is the number of the application you want to delete

Throws:

java.rmi.RemoteException

getMessages

public java.lang.String getMessages()
                             throws java.rmi.RemoteException

This gets the message that occured during the transaction. There are 2 elements in the resulting xml document:
1) INFO - this contains an informational message
2) ERROR - this contains an error message.
There will be only one ERROR message in an xml document, but possibly many INFO messages.

<!ELEMENT MSI_APP_ORIG_MSGS (INFO+, ERROR?)>
<!ELEMENT INFO (#PCDATA)>
<!ELEMENT ERROR (#PCDATA)>

Returns:

xml document containing the messages.

Throws:

java.rmi.RemoteException