diff options
author | Jesse Morgan <jesse@jesterpm.net> | 2018-07-08 09:34:59 -0700 |
---|---|---|
committer | Jesse Morgan <jesse@jesterpm.net> | 2018-07-08 09:34:59 -0700 |
commit | 151f74ffa870561bbb3c857c0f07aeb4b27968f5 (patch) | |
tree | fc81aefe1330750c9fcfef28f38d2c938b792cd4 /src/main/java/com/p4square/ccbapi/CCBAPI.java | |
parent | 35887b81ac23a389f123df529e45fd9c49ce7459 (diff) |
Add Groups Service APIs
Diffstat (limited to 'src/main/java/com/p4square/ccbapi/CCBAPI.java')
-rw-r--r-- | src/main/java/com/p4square/ccbapi/CCBAPI.java | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/main/java/com/p4square/ccbapi/CCBAPI.java b/src/main/java/com/p4square/ccbapi/CCBAPI.java index eb13cbf..6b9ba2e 100644 --- a/src/main/java/com/p4square/ccbapi/CCBAPI.java +++ b/src/main/java/com/p4square/ccbapi/CCBAPI.java @@ -59,4 +59,19 @@ public interface CCBAPI extends Closeable { * @throws IOException on failure. */ UpdateIndividualProfileResponse updateIndividualProfile(UpdateIndividualProfileRequest request) throws IOException; + + /** + * Retrieve one or more {@link GroupProfile}s. + * + * If {@link GetGroupProfilesRequest#withGroupId(int)} is set on the + * request, only the specified group will be returned. + * Otherwise, all groups are returned. + * + * The appropriate CCB API will be selected based on the options used. + * + * @param request A {@link GetGroupProfilesRequest}. + * @return A {@link GetGroupProfilesResponse} object on success, including when no groups are found. + * @throws IOException on failure. + */ + GetGroupProfilesResponse getGroupProfiles(GetGroupProfilesRequest request) throws IOException; } |