Fixed some Javadoc.

Joerg Huber · Joerg Huber · commit 2b4d2c55070a · 2018-09-25T09:05:39.000+08:00
diff --git a/SIF3InfraREST/SIF3REST/src/main/java/sif3/infra/rest/client/JobClient.java b/SIF3InfraREST/SIF3REST/src/main/java/sif3/infra/rest/client/JobClient.java
@@ -544,11 +544,11 @@ public Response retrieveDataFromPhase(PhaseInfo phaseInfo, MediaType returnMimeT
      * 
      * @param phaseInfo Hold the jobID and phase name of the job from where the data shall be created. If the parameter or
      *                  any of its properties must not be null/empty.
-     * @param phaseData The data and its mime type that is given to the operation of this phase. The data property of this
-     *                  parameter can be null in cases where no data is provided to this phase. This is entirely valid according
-     *                  to the SIF Specification. If data is provided (as a String) then the mime type is set as well, by the consumer,
-     *                  to indicate the format of the data. The provider can us this mime type to unmarshal the data into the 
-     *                  appropriate internal structure.
+     * @param phaseDataRequest The data and its mime type that is given to the operation of this phase. The data property 
+     *                         of this parameter can be null in cases where no data is provided to this phase. This is 
+     *                         entirely valid according to the SIF Specification. If data is provided (as a String) then 
+     *                         the mime type is set as well, by the consumer, to indicate the format of the data. The 
+     *                         provider can us this mime type to unmarshal the data into the appropriate internal structure.
      * @param returnMimeType The mime type the response data is in. It is expected that the consumer provides that and the provider
      *                       should attempt to marshal the data to the given mime type and return the resulting string as
      *                       part of this call. If the provider cannot marshal the data to the requested mime type then an
@@ -621,11 +621,11 @@ public Response createDataInPhase(PhaseInfo phaseInfo,
      *  
      * @param phaseInfo Hold the jobID and phase name of the job where the data shall be updated. If the parameter or
      *                  any of its properties must not be null/empty.
-     * @param phaseData The data and its mime type that is given to the operation of this phase. The data property of this
-     *                  parameter can be null in cases where no data is provided to this phase. This is entirely valid according
-     *                  to the SIF Specification. If data is provided (as a String) then the mime type is set as well, by the consumer,
-     *                  to indicate the format of the data. The provider can us this mime type to unmarshal the data into the 
-     *                  appropriate internal structure.
+     * @param phaseDataRequest The data and its mime type that is given to the operation of this phase. The data property 
+     *                         of this parameter can be null in cases where no data is provided to this phase. This is 
+     *                         entirely valid according to the SIF Specification. If data is provided (as a String) then 
+     *                         the mime type is set as well, by the consumer, to indicate the format of the data. The 
+     *                         provider can us this mime type to unmarshal the data into the appropriate internal structure.
      * @param returnMimeType The mime type the response data is in. It is expected that the consumer provides that and the provider
      *                       should attempt to marshal the data to the given mime type and return the resulting string as
      *                       part of this call. If the provider cannot marshal the data to the requested mime type then an
@@ -700,11 +700,11 @@ public Response updateDataInPhase(PhaseInfo phaseInfo,
      * 
      * @param phaseInfo Hold the jobID and phase name of the job where the data shall be deleted. If the parameter or
      *                  any of its properties must not be null/empty.
-     * @param phaseData The data and its mime type that is given to the operation of this phase. The data property of this
-     *                  parameter can be null in cases where no data is provided to this phase. This is entirely valid according
-     *                  to the SIF Specification. If data is provided (as a String) then the mime type is set as well, by the consumer,
-     *                  to indicate the format of the data. The provider can us this mime type to unmarshal the data into the 
-     *                  appropriate internal structure.
+     * @param phaseDataRequest The data and its mime type that is given to the operation of this phase. The data property 
+     *                         of this parameter can be null in cases where no data is provided to this phase. This is 
+     *                         entirely valid according to the SIF Specification. If data is provided (as a String) then 
+     *                         the mime type is set as well, by the consumer, to indicate the format of the data. The 
+     *                         provider can us this mime type to unmarshal the data into the appropriate internal structure.
      * @param returnMimeType The mime type the response data is in. It is expected that the consumer provides that and the provider
      *                       should attempt to marshal the data to the given mime type and return the resulting string as
      *                       part of this call. If the provider cannot marshal the data to the requested mime type then an
@@ -831,7 +831,6 @@ public Response updatePhaseState(PhaseInfo phaseInfo, PhaseState newState, Heade
      * 
      * @param phaseInfo Hold the jobID and phase name of the job where the states shall be retrieved. If the parameter or
      *                  any of its properties must not be null/empty.
-     * @param phaseName Name of the phase for which the state(s) shall be retrieved. If null then an error will be returned.
      * @param hdrProperties Header Properties to be added to the header of the request.
      * @param urlQueryParams URL query parameters to be added to the request. It is assumed that these are custom
      *                       URL query parameters. They are conveyed to the provider unchanged. URL query parameter
diff --git a/SIF3InfraREST/sif3Common/src/main/java/sif3/common/persist/service/JobService.java b/SIF3InfraREST/sif3Common/src/main/java/sif3/common/persist/service/JobService.java
@@ -200,7 +200,6 @@ public SIF3Job createJob(SIF3Job job) throws IllegalArgumentException, Persisten
      * Updates a job with the given values. Note that the internalID must be set and have the value of an existing object. The job object is
      * updated with the exact values given. Please refer to the appropriate method in the JobDAO for details on pre- and post-conditions.<br/>
      * 
-     * @param tx The current transaction. Cannot be null.
      * @param job The job to be updated to the SIF3_JOB table.
      * 
      * @return The updated job. This has a new lastModified date which is now the current date.

Original file line number	Diff line number	Diff line change
`@@ -200,7 +200,6 @@ public SIF3Job createJob(SIF3Job job) throws IllegalArgumentException, Persisten`
`200`	`200`	`* Updates a job with the given values. Note that the internalID must be set and have the value of an existing object. The job object is`
`201`	`201`	`* updated with the exact values given. Please refer to the appropriate method in the JobDAO for details on pre- and post-conditions.<br/>`
`202`	`202`	`*`
`203`		`- * @param tx The current transaction. Cannot be null.`
`204`	`203`	`* @param job The job to be updated to the SIF3_JOB table.`
`205`	`204`	`*`
`206`	`205`	`* @return The updated job. This has a new lastModified date which is now the current date.`