diff options
| -rw-r--r-- | src/main/java/com/p4square/ccbapi/CCBAPI.java | 17 | ||||
| -rw-r--r-- | src/main/java/com/p4square/ccbapi/HTTPInterface.java | 1 | ||||
| -rw-r--r-- | src/main/java/com/p4square/ccbapi/model/CCBAPIResponse.java | 4 |
3 files changed, 11 insertions, 11 deletions
diff --git a/src/main/java/com/p4square/ccbapi/CCBAPI.java b/src/main/java/com/p4square/ccbapi/CCBAPI.java index bae2272..eb13cbf 100644 --- a/src/main/java/com/p4square/ccbapi/CCBAPI.java +++ b/src/main/java/com/p4square/ccbapi/CCBAPI.java @@ -12,7 +12,7 @@ public interface CCBAPI extends Closeable { /** * Retrieve the set of custom (user-defined) fields and the associated labels. * - * @return A GetCustomFieldLabelsResponse containing the fields. + * @return A {@link GetCustomFieldLabelsResponse} containing the fields. * @throws IOException on failure. */ GetCustomFieldLabelsResponse getCustomFieldLabels() throws IOException; @@ -22,13 +22,14 @@ public interface CCBAPI extends Closeable { * * Lookup tables provide the list of options for various pulldown fields. * - * @return A GetLookupTableResponse containing the item ids and labels. + * @param request The {@link GetLookupTableRequest} specifying the table type. + * @return A {@link GetLookupTableResponse} containing the item ids and labels. * @throws IOException on failure. */ GetLookupTableResponse getLookupTable(GetLookupTableRequest request) throws IOException; /** - * Retrieve one or more IndividualProfiles. + * Retrieve one or more {@link IndividualProfile}s. * * If any of the following properties are set on the request, * this method will return the matching individual, if one exists. @@ -44,17 +45,17 @@ public interface CCBAPI extends Closeable { * * The appropriate CCB API will be selected based on the options used. * - * @param request A GetIndividualProfilesRequest. - * @return A GetIndividualProfilesResponse object on success, including when no individuals match. + * @param request A {@link GetIndividualProfilesRequest}. + * @return A {@link GetIndividualProfilesResponse} object on success, including when no individuals match. * @throws IOException on failure. */ GetIndividualProfilesResponse getIndividualProfiles(GetIndividualProfilesRequest request) throws IOException; /** - * Update an IndividualProfile. + * Update an {@link IndividualProfile}. * - * @param request An UpdateIndividualProfileRequest including the fields to modify. - * @return An UpdateIndividualProfileResponse, including the updated IndividualProfile. + * @param request An {@link UpdateIndividualProfileRequest} including the fields to modify. + * @return An {@link UpdateIndividualProfileResponse}, including the updated IndividualProfile. * @throws IOException on failure. */ UpdateIndividualProfileResponse updateIndividualProfile(UpdateIndividualProfileRequest request) throws IOException; diff --git a/src/main/java/com/p4square/ccbapi/HTTPInterface.java b/src/main/java/com/p4square/ccbapi/HTTPInterface.java index 9c5e818..bf64821 100644 --- a/src/main/java/com/p4square/ccbapi/HTTPInterface.java +++ b/src/main/java/com/p4square/ccbapi/HTTPInterface.java @@ -26,7 +26,6 @@ public interface HTTPInterface extends Closeable { * @param uri The URI to request. * @param form Form data or null. * @return The response received. - * @throws com.p4square.ccbapi.exception.CCBRetryableErrorException * @throws CCBRetryableErrorException if a retryable error occurs. * @throws IOException If a non-retryable error occurs. */ diff --git a/src/main/java/com/p4square/ccbapi/model/CCBAPIResponse.java b/src/main/java/com/p4square/ccbapi/model/CCBAPIResponse.java index d54c8a9..fa3d017 100644 --- a/src/main/java/com/p4square/ccbapi/model/CCBAPIResponse.java +++ b/src/main/java/com/p4square/ccbapi/model/CCBAPIResponse.java @@ -18,7 +18,7 @@ public abstract class CCBAPIResponse { /** * Return the error message if present. * - * @return A CCBErrorResponse if an error occurred. Null if the request was successful. + * @return A {@link CCBErrorResponse} if an error occurred. Null if the request was successful. */ public List<CCBErrorResponse> getErrors() { return errorResponses; @@ -27,7 +27,7 @@ public abstract class CCBAPIResponse { /** * Set the error response. * - * @param error The CCBErrorResponse to set. + * @param errors The list of {@link CCBErrorResponse}s to set. */ public void setErrors(final List<CCBErrorResponse> errors) { this.errorResponses = errors; |