1 /**
2 * Copyright (c) 2012-2015, 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.odesk;
31
32 import com.jcabi.aspects.Immutable;
33 import java.io.IOException;
34 import javax.validation.constraints.NotNull;
35
36 /**
37 * Teams.
38 *
39 * @author Yegor Bugayenko (yegor@tpc2.com)
40 * @version $Id: 7fcb4c06f4421b50714f94c74c08fbb87bbc9ad3 $
41 * @since 0.1
42 */
43 @Immutable
44 public interface Teams {
45
46 /**
47 * Get reference IDs of all teams.
48 * @return List of reference IDs
49 * @throws IOException If fails due to IO problem
50 */
51 @NotNull(message = "list of IDs is never NULL")
52 Iterable<String> iterate() throws IOException;
53
54 /**
55 * Get team by reference.
56 * @param ref Reference
57 * @return Team
58 */
59 @NotNull(message = "team is never NULL")
60 Team team(@NotNull(message = "ref can't be NULL") String ref);
61
62 }