blob: 6b9ba2e59e1bd5cf79ee92345c45ba19547cc5b6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
package com.p4square.ccbapi;
import com.p4square.ccbapi.model.*;
import java.io.Closeable;
import java.io.IOException;
/**
* CCBAPI is a Java interface for using the Church Community Builder API.
*/
public interface CCBAPI extends Closeable {
/**
* Retrieve the set of custom (user-defined) fields and the associated labels.
*
* @return A {@link GetCustomFieldLabelsResponse} containing the fields.
* @throws IOException on failure.
*/
GetCustomFieldLabelsResponse getCustomFieldLabels() throws IOException;
/**
* Retrieve the list of items in a particular lookup table.
*
* Lookup tables provide the list of options for various pulldown fields.
*
* @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 {@link IndividualProfile}s.
*
* If any of the following properties are set on the request,
* this method will return the matching individual, if one exists.
*
* <ul>
* <li>Individual ID</li>
* <li>Login and Password</li>
* <li>MICR</li>
* </ul>
*
* If more than one property is included only the first, in the order listed above, will be used.
* If none of the options are included, all individuals will be returned.
*
* The appropriate CCB API will be selected based on the options used.
*
* @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 {@link 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;
/**
* 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;
}
|
