Project

General

Profile

« Previous | Next » 

Revision 2133

Changes to comments

View differences:

HarvestLog.java
206 206
  
207 207

  
208 208
  /**
209
   * Retrieves the value of the EXPLANATION field of the HARVEST_OPERATION
210
   * table based on the value of the HARVEST_OPERATION_CODE field. 
209
   * Returns an explanation string based on the value of a
210
   * harvestOperationCode string. The explanation string is a description
211
   * of the harvest operation specified by the harvestOperationCode.
211 212
   * 
212 213
   * @param  harvestOperationCode  string value of the harvest operation code
213 214
   * @return the explanation for this harvest operation, a String
......
223 224
  
224 225

  
225 226
  /**
226
   * Retrieves the value of the either the EXPLANATION field or the
227
   * HARVEST_OPERATION_CODE_LEVEL field of the HARVEST_OPERATION table based on
228
   * the value of the HARVEST_OPERATION_CODE field.
227
   * Returns either an explanation string or a harvest operation code level 
228
   * string based on the value of a harvest operation code property. The
229
   * explanation and the code level are stored as comma-separated strings in
230
   * the harvester.properties file. For example, the HarvesterStartup
231
   * harvest operation code stores its explanation and code level like so:
232
   * 
233
   *            HarvesterStartup=Harvester start up,Info
229 234
   *
230 235
   * @param  fieldName  the field name to match, e.g. "EXPLANATION"
231 236
   * @param  harvestOperationCode  string value of the harvest operation code
......
257 262
  
258 263

  
259 264
  /**
260
   * Retrieves the value of the HARVEST_OPERATION_CODE_LEVEL field of the
261
   * HARVEST_OPERATION table based on the value of the HARVEST_OPERATION_CODE 
262
   * field.
265
   * Returns a code level string based on a harvestOperationCode string.
266
   * The code level string is one of a set of possible code levels:
267
   * "error", "warning", "notice", "info", or "debug".
263 268
   * 
264 269
   * @param  harvestOperationCode  string value of the harvest operation code
265 270
   * @return the code level value, a String, one of the following:

Also available in: Unified diff