1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.security.api;
23
24 import java.util.Set;
25
26 /**
27 * Represent a group in Opencast
28 */
29 public interface Group {
30
31 /** Prefix of every generated group role */
32 String ROLE_PREFIX = "ROLE_GROUP_";
33
34 /**
35 * Gets the group identifier.
36 *
37 * @return the group identifier
38 */
39 String getGroupId();
40
41 /**
42 * Gets the group name.
43 *
44 * @return the group name
45 */
46 String getName();
47
48 /**
49 * Gets the user's organization.
50 *
51 * @return the organization
52 */
53 Organization getOrganization();
54
55 /**
56 * Gets the role description.
57 *
58 * @return the description
59 */
60 String getDescription();
61
62 /**
63 * Gets the group role.
64 *
65 * @return the group role
66 */
67 String getRole();
68
69 /**
70 * Gets the group members
71 *
72 * @return the group members
73 */
74 Set<String> getMembers();
75
76 /**
77 * Gets the group's roles.
78 *
79 * @return the group's roles
80 */
81 Set<Role> getRoles();
82
83 }