01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/metaobj/tags/sakai_2-4-1/metaobj-api/api/src/java/org/sakaiproject/metaobj/worksite/mgt/WorksiteManager.java $
03: * $Id: WorksiteManager.java 16908 2006-10-09 13:49:37Z chmaurer@iupui.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2004, 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.metaobj.worksite.mgt;
21:
22: import java.util.List;
23: import java.util.Map;
24:
25: import org.sakaiproject.authz.api.AuthzGroup;
26: import org.sakaiproject.metaobj.shared.model.Id;
27: import org.sakaiproject.site.api.Site;
28: import org.sakaiproject.site.api.ToolConfiguration;
29:
30: public interface WorksiteManager {
31:
32: public static final String WORKSITE_MAINTAIN = "maintain";
33:
34: /**
35: * @return list of all sites the current user belongs to
36: */
37: public List getUserSites();
38:
39: /**
40: * @return list of all sites the current user belongs to
41: */
42: public List getUserSites(Map properties, List siteTypes);
43:
44: public Id getCurrentWorksiteId();
45:
46: /**
47: * get all the tools for a site that have a type of "toolId"
48: * if tool id is null, get all tools for a site
49: *
50: * @param toolId
51: * @param site
52: * @return
53: */
54: public List getSiteTools(String toolId, Site site);
55:
56: public Site getSite(String siteId);
57:
58: public AuthzGroup getSiteRealm(String siteId);
59:
60: public ToolConfiguration getTool(String id);
61:
62: public boolean isUserInSite(String siteId);
63:
64: }
|