1 /**
2 * Copyright (c) 2013-2023, jcabi.com
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met: 1) Redistributions of source code must retain the above
8 * copyright notice, this list of conditions and the following
9 * disclaimer. 2) Redistributions in binary form must reproduce the above
10 * copyright notice, this list of conditions and the following
11 * disclaimer in the documentation and/or other materials provided
12 * with the distribution. 3) Neither the name of the jcabi.com nor
13 * the names of its contributors may be used to endorse or promote
14 * products derived from this software without specific prior written
15 * permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28 * OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 package com.jcabi.github;
31
32 import com.jcabi.aspects.Immutable;
33 import java.io.IOException;
34
35 /**
36 * Organizations of a Github user.
37 * @author Paul Polishchuk (ppol@ua.fm)
38 * @author Chris Rebert (github@chrisrebert.com)
39 * @version $Id: 1e0a907c684870e31bdc4778d8771dd3410f260b $
40 * @see <a href="https://developer.github.com/v3/orgs/">Organizations API</a>
41 * @since 0.24
42 */
43 @Immutable
44 public interface UserOrganizations {
45
46 /**
47 * Github we're in.
48 * @return Github
49 */
50 Github github();
51
52 /**
53 * Get its owner.
54 * @return User
55 */
56 User user();
57
58 /**
59 * Iterate organizations of particular user.
60 * All public organizations for an unauthenticated user or
61 * private and public organizations for authenticated users
62 * @return Iterator of Organizations
63 * @throws IOException If there is an I/O problem
64 * @see <a href="https://developer.github.com/v3/orgs/#list-user-organizations">List User Organizations</a>
65 * @since 0.24
66 */
67 Iterable<Organization> iterate() throws IOException;
68 }