01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/site/tags/sakai_2-4-1/site-api/api/src/java/org/sakaiproject/site/api/Group.java $
03: * $Id: Group.java 7168 2006-03-28 20:48:09Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
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,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.site.api;
21:
22: import java.io.Serializable;
23:
24: import org.sakaiproject.authz.api.AuthzGroup;
25: import org.sakaiproject.entity.api.Edit;
26:
27: /**
28: * <p>
29: * A Site Group is a way to divide up a Site into separate units, each with its own authorization group and descriptive information.
30: * </p>
31: */
32: public interface Group extends Edit, Serializable, AuthzGroup {
33: /** @return a human readable short title of this group. */
34: String getTitle();
35:
36: /** @return a text describing the group. */
37: String getDescription();
38:
39: /**
40: * Access the site in which this group lives.
41: *
42: * @return the site in which this group lives.
43: */
44: public Site getContainingSite();
45:
46: /**
47: * Set the human readable short title of this group.
48: *
49: * @param title
50: * The new title.
51: */
52: void setTitle(String title);
53:
54: /**
55: * Set the text describing this group.
56: *
57: * @param description
58: * The new description.
59: */
60: void setDescription(String description);
61: }
|