Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

The findUserProductionReports() takes several arguments. Arguments left empty are not included in the database query. The arguments are: 1.

  1. String Userid – i.e

...

  1. "amarx"

...

  1. String password – i.e.

...

  1. "A_

...

  1. marx"

...

  1. String schemaVersionNumber – i.e.

...

  1. "2.

...

  1. 1"

...

  1. String federalProcessorCode – i.e.

...

  1. "" or

...

  1. ""

...

  1. String adfgVesselNumber – i.e.

...

  1. "41444" or ""
  2. String portOfLanding – i.e.

...

  1. "JNU" or ""
  2. String gearCode – i.e.

...

  1. "3" or ""
  2. String processorCode – i.e.

...

  1. "F1234" or ""
  2. String managementProgram – i.e.

...

  1. "" or

...

  1. ""

...

  1. String reportType – i.e.

...

  1. "G" or ""
  2. Calendar fromDate – i.e. Calendar Object

...

  1. Calendar toDate – i.e. Calandar Object

In the web service client we might auto generate a data structure by providing the web service url. In eLandings we use Java – JAX-WS and generated a structure called ReportManager.
ReportManagement ws;
¿
¿ ...
...
String xml = ws. findUserProductionReports(userid, password, schemaVersionNumber, federalProcessorCode, adfgVesselNumber, portOfLanding, gearCode, processorCode, managementProgram, reportType, fromDate, toDate);
For example, if we wanted to search for all production reports with a date of landing between 01/10/2010 and 01/20/2010, we would run:

...

This query request would run code similar to:
SimpleDateFormat slashFmt = new SimpleDateFormat("MM/dd/yyyy");
Date calendarStartDate = slashFmt.parse(¿01"01/10/2010¿2010")
Calendar startDate = new GregorianCalendar();
startDate.setTimeInMillis(calendarStartDate.getTime());

Date calendarEndDate = slashFmt.parse(¿01"01/20/2010¿2010")
Calendar endDate = new GregorianCalendar();
endDate.setTimeInMillis(calendarEndDate.getTime());

XMLGregorianCalendar startDateArg = (null == startDate) ? null : datatypeFactory.newXMLGregorianCalendar((GregorianCalendar) startDate);

XMLGregorianCalendar endDateArg = (null == endDate) ? null : datatypeFactory.newXMLGregorianCalendar((GregorianCalendar) endDate);

String xml = ws. findUserProductionReports (¿amarx¿, ¿A_marx¿, ¿2.1¿, ¿¿, ¿¿, ¿¿, ¿¿, ¿¿, ¿¿, ¿¿, ¿¿, ¿¿, startDate, endDate"amarx", "A_marx", "2.1", "", "", "", "", "", "", "", "", "", startDateArg, endDateArg);

If the web service call was successful, we would get back a string containing a production_report_info containing one or more production_report_summary objects.

<CODE_EXAMPLE>findUserProductionReports_results_on_sucess.txt

The eLandings web page would display this information as:

...

String xml = ws. findUserProductionReports (¿amarx¿, ¿A_marx¿, ¿2.1¿, ¿¿, ¿¿, ¿¿, ¿¿, ¿¿, ¿1¿, ¿¿, ¿¿, ¿¿"amarx", "A_marx", "2.1", "", "", "", "", "", "1", "", "", "", startDate, endDate);

The returned xml string contains the following:

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<production_report_info>
    <messages>
        <message severity_desc="ERROR" severity_code="E" msgid="1476">No Production Reports found that match search criteria</message>
    </messages>
</production_report_info>

For the list of potential elandings messages see the elandings codes page and click on Message Codes

The eLandings web page would display this to the user as:

...