Project

General

Profile

Programming Guide » History » Revision 4

Revision 3 (chin-yeh, 08/25/2011 11:40 AM) → Revision 4/21 (chin-yeh, 08/25/2011 11:42 AM)

{{toc}} 

 h1. Programming Guide 

 There are number of APIs provided by DP. All of these APIs are wrapped and exposed through a client application, [[documentation#list-of-components|dp-client]]. Refer to the following sub sections for more information. 

 The Javadoc of *dp-client*: 
 > http://192.168.2.13:50000/dp_client_apidocs/ 

 The binary or source files of *dp-client*: 
 > [[wiki#SCM|SCM]] 

 Demo application of *dp-client*: 
 > http://192.168.2.66:8080/dp-test/index.html 

 h2. Query DP status 

 h3. Input Parameters 

 h3. Output Parameters 

 h3. Code Snippet 

 h2. Impose Sales Lock 

 h3. Input Parameters 

 h3. Output Parameters 

 h3. Code Snippet 

 h2. Release Sales Lock 

 h3. Input Parameters 

 h3. Output Parameters 

 h3. Code Snippet 


 h2. Commit Sales 

 h3. Input Parameters 

 h3. Output Parameters 

 h3. Code Snippet 


 h2. Generate the redirect URL for VIP Details page 

 h3. Input Parameters 

 h3. Output Parameters 

 h3. Code Snippet 



 h2. Exception Handling Strategies 

 The APIs would throw the following exceptions: 
 * *RemoteException* - if there's any issue in communicating with the DP VP 
 * *SQLException* - if there's any issue in persisting or updating the event 
 * *unchecked exception* - e.g. NullPointerException. This is more like a programming errors so do not catch it for whatever reasons. 
 ** _note: catch the *Exception* will catch both checked & unchecked exception_ 

 The above exceptions should never be ignored, at least, the full error stack trace should be logged.