summaryrefslogtreecommitdiff
path: root/src/main/java/com/p4square/ccbapi/CCBAPI.java
diff options
context:
space:
mode:
authorJesse Morgan <jesse@jesterpm.net>2018-07-14 12:13:04 -0700
committerJesse Morgan <jesse@jesterpm.net>2018-07-14 12:13:04 -0700
commit808c6323049c1efff52f20d872813f86e21c5b37 (patch)
treeacf7ec4000631e5fa7d5d9a8155367070c23fffa /src/main/java/com/p4square/ccbapi/CCBAPI.java
parent35887b81ac23a389f123df529e45fd9c49ce7459 (diff)
parent633d0cebff548b6a54ac33e464447d93e800bf12 (diff)
Merge branch 'groups-api'
Diffstat (limited to 'src/main/java/com/p4square/ccbapi/CCBAPI.java')
-rw-r--r--src/main/java/com/p4square/ccbapi/CCBAPI.java15
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;
}