001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/site/tags/sakai_2-4-1/site-api/api/src/java/org/sakaiproject/site/cover/SiteService.java $
003: * $Id: SiteService.java 8384 2006-04-27 03:09:26Z ggolden@umich.edu $
004: ***********************************************************************************
005: *
006: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
007: *
008: * Licensed under the Educational Community License, Version 1.0 (the "License");
009: * you may not use this file except in compliance with the License.
010: * You may obtain a copy of the License at
011: *
012: * http://www.opensource.org/licenses/ecl1.php
013: *
014: * Unless required by applicable law or agreed to in writing, software
015: * distributed under the License is distributed on an "AS IS" BASIS,
016: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017: * See the License for the specific language governing permissions and
018: * limitations under the License.
019: *
020: **********************************************************************************/package org.sakaiproject.site.cover;
021:
022: import org.sakaiproject.component.cover.ComponentManager;
023:
024: /**
025: * <p>
026: * SiteService is a static Cover for the {@link org.sakaiproject.site.api.SiteService SiteService}; see that interface for usage details.
027: * </p>
028: */
029: public class SiteService {
030: /**
031: * Access the component instance: special cover only method.
032: *
033: * @return the component instance.
034: */
035: public static org.sakaiproject.site.api.SiteService getInstance() {
036: if (ComponentManager.CACHE_COMPONENTS) {
037: if (m_instance == null)
038: m_instance = (org.sakaiproject.site.api.SiteService) ComponentManager
039: .get(org.sakaiproject.site.api.SiteService.class);
040: return m_instance;
041: } else {
042: return (org.sakaiproject.site.api.SiteService) ComponentManager
043: .get(org.sakaiproject.site.api.SiteService.class);
044: }
045: }
046:
047: private static org.sakaiproject.site.api.SiteService m_instance = null;
048:
049: public static java.lang.String APPLICATION_ID = org.sakaiproject.site.api.SiteService.APPLICATION_ID;
050:
051: public static java.lang.String REFERENCE_ROOT = org.sakaiproject.site.api.SiteService.REFERENCE_ROOT;
052:
053: public static java.lang.String SITE_VISIT = org.sakaiproject.site.api.SiteService.SITE_VISIT;
054:
055: public static java.lang.String SITE_VISIT_UNPUBLISHED = org.sakaiproject.site.api.SiteService.SITE_VISIT_UNPUBLISHED;
056:
057: public static java.lang.String SECURE_ADD_SITE = org.sakaiproject.site.api.SiteService.SECURE_ADD_SITE;
058:
059: public static java.lang.String SECURE_ADD_USER_SITE = org.sakaiproject.site.api.SiteService.SECURE_ADD_USER_SITE;
060:
061: public static java.lang.String SECURE_REMOVE_SITE = org.sakaiproject.site.api.SiteService.SECURE_REMOVE_SITE;
062:
063: public static java.lang.String SECURE_UPDATE_SITE = org.sakaiproject.site.api.SiteService.SECURE_UPDATE_SITE;
064:
065: public static java.lang.String SECURE_VIEW_ROSTER = org.sakaiproject.site.api.SiteService.SECURE_VIEW_ROSTER;
066:
067: public static java.lang.String MAIN_CONTAINER = org.sakaiproject.site.api.SiteService.MAIN_CONTAINER;
068:
069: public static java.lang.String SITE_TEMPLATE = org.sakaiproject.site.api.SiteService.SITE_TEMPLATE;
070:
071: public static java.lang.String USER_SITE_TEMPLATE = org.sakaiproject.site.api.SiteService.USER_SITE_TEMPLATE;
072:
073: public static java.lang.String SITE_ERROR = org.sakaiproject.site.api.SiteService.SITE_ERROR;
074:
075: public static java.lang.String URL_ERROR = org.sakaiproject.site.api.SiteService.URL_ERROR;
076:
077: public static java.lang.String SITE_SUBTYPE = org.sakaiproject.site.api.SiteService.SITE_SUBTYPE;
078:
079: public static java.lang.String GROUP_SUBTYPE = org.sakaiproject.site.api.SiteService.GROUP_SUBTYPE;
080:
081: public static java.lang.String PAGE_SUBTYPE = org.sakaiproject.site.api.SiteService.PAGE_SUBTYPE;
082:
083: public static java.lang.String TOOL_SUBTYPE = org.sakaiproject.site.api.SiteService.TOOL_SUBTYPE;
084:
085: public static boolean allowAccessSite(java.lang.String param0) {
086: org.sakaiproject.site.api.SiteService service = getInstance();
087: if (service == null)
088: return false;
089:
090: return service.allowAccessSite(param0);
091: }
092:
093: public static org.sakaiproject.site.api.Site getSite(
094: java.lang.String param0)
095: throws org.sakaiproject.exception.IdUnusedException {
096: org.sakaiproject.site.api.SiteService service = getInstance();
097: if (service == null)
098: return null;
099:
100: return service.getSite(param0);
101: }
102:
103: public static boolean siteExists(java.lang.String param0) {
104: org.sakaiproject.site.api.SiteService service = getInstance();
105: if (service == null)
106: return false;
107:
108: return service.siteExists(param0);
109: }
110:
111: public static org.sakaiproject.site.api.Site getSiteVisit(
112: java.lang.String param0)
113: throws org.sakaiproject.exception.IdUnusedException,
114: org.sakaiproject.exception.PermissionException {
115: org.sakaiproject.site.api.SiteService service = getInstance();
116: if (service == null)
117: return null;
118:
119: return service.getSiteVisit(param0);
120: }
121:
122: public static boolean allowUpdateSite(java.lang.String param0) {
123: org.sakaiproject.site.api.SiteService service = getInstance();
124: if (service == null)
125: return false;
126:
127: return service.allowUpdateSite(param0);
128: }
129:
130: public static boolean allowUpdateSiteMembership(
131: java.lang.String param0) {
132: org.sakaiproject.site.api.SiteService service = getInstance();
133: if (service == null)
134: return false;
135:
136: return service.allowUpdateSiteMembership(param0);
137: }
138:
139: public static boolean allowUpdateGroupMembership(
140: java.lang.String param0) {
141: org.sakaiproject.site.api.SiteService service = getInstance();
142: if (service == null)
143: return false;
144:
145: return service.allowUpdateGroupMembership(param0);
146: }
147:
148: public static void save(org.sakaiproject.site.api.Site param0)
149: throws org.sakaiproject.exception.IdUnusedException,
150: org.sakaiproject.exception.PermissionException {
151: org.sakaiproject.site.api.SiteService service = getInstance();
152: if (service == null)
153: return;
154:
155: service.save(param0);
156: }
157:
158: public static void saveSiteMembership(
159: org.sakaiproject.site.api.Site param0)
160: throws org.sakaiproject.exception.IdUnusedException,
161: org.sakaiproject.exception.PermissionException {
162: org.sakaiproject.site.api.SiteService service = getInstance();
163: if (service == null)
164: return;
165:
166: service.saveSiteMembership(param0);
167: }
168:
169: public static void saveGroupMembership(
170: org.sakaiproject.site.api.Site param0)
171: throws org.sakaiproject.exception.IdUnusedException,
172: org.sakaiproject.exception.PermissionException {
173: org.sakaiproject.site.api.SiteService service = getInstance();
174: if (service == null)
175: return;
176:
177: service.saveGroupMembership(param0);
178: }
179:
180: public static void saveSiteInfo(java.lang.String param0,
181: java.lang.String param1, java.lang.String param2)
182: throws org.sakaiproject.exception.IdUnusedException,
183: org.sakaiproject.exception.PermissionException {
184: org.sakaiproject.site.api.SiteService service = getInstance();
185: if (service == null)
186: return;
187:
188: service.saveSiteInfo(param0, param1, param2);
189: }
190:
191: public static boolean allowAddSite(java.lang.String param0) {
192: org.sakaiproject.site.api.SiteService service = getInstance();
193: if (service == null)
194: return false;
195:
196: return service.allowAddSite(param0);
197: }
198:
199: public static org.sakaiproject.site.api.Site addSite(
200: java.lang.String param0, java.lang.String param1)
201: throws org.sakaiproject.exception.IdInvalidException,
202: org.sakaiproject.exception.IdUsedException,
203: org.sakaiproject.exception.PermissionException {
204: org.sakaiproject.site.api.SiteService service = getInstance();
205: if (service == null)
206: return null;
207:
208: return service.addSite(param0, param1);
209: }
210:
211: public static org.sakaiproject.site.api.Site addSite(
212: java.lang.String param0,
213: org.sakaiproject.site.api.Site param1)
214: throws org.sakaiproject.exception.IdInvalidException,
215: org.sakaiproject.exception.IdUsedException,
216: org.sakaiproject.exception.PermissionException {
217: org.sakaiproject.site.api.SiteService service = getInstance();
218: if (service == null)
219: return null;
220:
221: return service.addSite(param0, param1);
222: }
223:
224: public static boolean allowRemoveSite(java.lang.String param0) {
225: org.sakaiproject.site.api.SiteService service = getInstance();
226: if (service == null)
227: return false;
228:
229: return service.allowRemoveSite(param0);
230: }
231:
232: public static void removeSite(org.sakaiproject.site.api.Site param0)
233: throws org.sakaiproject.exception.PermissionException {
234: org.sakaiproject.site.api.SiteService service = getInstance();
235: if (service == null)
236: return;
237:
238: service.removeSite(param0);
239: }
240:
241: public static java.lang.String siteReference(java.lang.String param0) {
242: org.sakaiproject.site.api.SiteService service = getInstance();
243: if (service == null)
244: return null;
245:
246: return service.siteReference(param0);
247: }
248:
249: public static java.lang.String sitePageReference(
250: java.lang.String param0, java.lang.String param1) {
251: org.sakaiproject.site.api.SiteService service = getInstance();
252: if (service == null)
253: return null;
254:
255: return service.sitePageReference(param0, param1);
256: }
257:
258: public static java.lang.String siteToolReference(
259: java.lang.String param0, java.lang.String param1) {
260: org.sakaiproject.site.api.SiteService service = getInstance();
261: if (service == null)
262: return null;
263:
264: return service.siteToolReference(param0, param1);
265: }
266:
267: public static java.lang.String siteGroupReference(
268: java.lang.String param0, java.lang.String param1) {
269: org.sakaiproject.site.api.SiteService service = getInstance();
270: if (service == null)
271: return null;
272:
273: return service.siteGroupReference(param0, param1);
274: }
275:
276: public static boolean isUserSite(java.lang.String param0) {
277: org.sakaiproject.site.api.SiteService service = getInstance();
278: if (service == null)
279: return false;
280:
281: return service.isUserSite(param0);
282: }
283:
284: public static java.lang.String getSiteUserId(java.lang.String param0) {
285: org.sakaiproject.site.api.SiteService service = getInstance();
286: if (service == null)
287: return null;
288:
289: return service.getSiteUserId(param0);
290: }
291:
292: public static java.lang.String getUserSiteId(java.lang.String param0) {
293: org.sakaiproject.site.api.SiteService service = getInstance();
294: if (service == null)
295: return null;
296:
297: return service.getUserSiteId(param0);
298: }
299:
300: public static boolean isSpecialSite(java.lang.String param0) {
301: org.sakaiproject.site.api.SiteService service = getInstance();
302: if (service == null)
303: return false;
304:
305: return service.isSpecialSite(param0);
306: }
307:
308: public static java.lang.String getSiteSpecialId(
309: java.lang.String param0) {
310: org.sakaiproject.site.api.SiteService service = getInstance();
311: if (service == null)
312: return null;
313:
314: return service.getSiteSpecialId(param0);
315: }
316:
317: public static java.lang.String getSpecialSiteId(
318: java.lang.String param0) {
319: org.sakaiproject.site.api.SiteService service = getInstance();
320: if (service == null)
321: return null;
322:
323: return service.getSpecialSiteId(param0);
324: }
325:
326: public static java.lang.String getSiteDisplay(
327: java.lang.String param0) {
328: org.sakaiproject.site.api.SiteService service = getInstance();
329: if (service == null)
330: return null;
331:
332: return service.getSiteDisplay(param0);
333: }
334:
335: public static org.sakaiproject.site.api.ToolConfiguration findTool(
336: java.lang.String param0) {
337: org.sakaiproject.site.api.SiteService service = getInstance();
338: if (service == null)
339: return null;
340:
341: return service.findTool(param0);
342: }
343:
344: public static org.sakaiproject.site.api.SitePage findPage(
345: java.lang.String param0) {
346: org.sakaiproject.site.api.SiteService service = getInstance();
347: if (service == null)
348: return null;
349:
350: return service.findPage(param0);
351: }
352:
353: public static boolean allowViewRoster(java.lang.String param0) {
354: org.sakaiproject.site.api.SiteService service = getInstance();
355: if (service == null)
356: return false;
357:
358: return service.allowViewRoster(param0);
359: }
360:
361: public static void unjoin(java.lang.String param0)
362: throws org.sakaiproject.exception.IdUnusedException,
363: org.sakaiproject.exception.PermissionException,
364: org.sakaiproject.exception.InUseException {
365: org.sakaiproject.site.api.SiteService service = getInstance();
366: if (service == null)
367: return;
368:
369: service.unjoin(param0);
370: }
371:
372: public static boolean allowUnjoinSite(java.lang.String param0) {
373: org.sakaiproject.site.api.SiteService service = getInstance();
374: if (service == null)
375: return false;
376:
377: return service.allowUnjoinSite(param0);
378: }
379:
380: public static java.lang.String getSiteSkin(java.lang.String param0) {
381: org.sakaiproject.site.api.SiteService service = getInstance();
382: if (service == null)
383: return null;
384:
385: return service.getSiteSkin(param0);
386: }
387:
388: public static java.util.List getSiteTypes() {
389: org.sakaiproject.site.api.SiteService service = getInstance();
390: if (service == null)
391: return null;
392:
393: return service.getSiteTypes();
394: }
395:
396: public static java.util.List getSites(
397: org.sakaiproject.site.api.SiteService.SelectionType param0,
398: java.lang.Object param1, java.lang.String param2,
399: java.util.Map param3,
400: org.sakaiproject.site.api.SiteService.SortType param4,
401: org.sakaiproject.javax.PagingPosition param5) {
402: org.sakaiproject.site.api.SiteService service = getInstance();
403: if (service == null)
404: return null;
405:
406: return service.getSites(param0, param1, param2, param3, param4,
407: param5);
408: }
409:
410: public static int countSites(
411: org.sakaiproject.site.api.SiteService.SelectionType param0,
412: java.lang.Object param1, java.lang.String param2,
413: java.util.Map param3) {
414: org.sakaiproject.site.api.SiteService service = getInstance();
415: if (service == null)
416: return 0;
417:
418: return service.countSites(param0, param1, param2, param3);
419: }
420:
421: public static void setSiteSecurity(java.lang.String param0,
422: java.util.Set param1, java.util.Set param2,
423: java.util.Set param3) {
424: org.sakaiproject.site.api.SiteService service = getInstance();
425: if (service == null)
426: return;
427:
428: service.setSiteSecurity(param0, param1, param2, param3);
429: }
430:
431: public static void setUserSecurity(java.lang.String param0,
432: java.util.Set param1, java.util.Set param2,
433: java.util.Set param3) {
434: org.sakaiproject.site.api.SiteService service = getInstance();
435: if (service == null)
436: return;
437:
438: service.setUserSecurity(param0, param1, param2, param3);
439: }
440:
441: public static void join(java.lang.String param0)
442: throws org.sakaiproject.exception.IdUnusedException,
443: org.sakaiproject.exception.PermissionException,
444: org.sakaiproject.exception.InUseException {
445: org.sakaiproject.site.api.SiteService service = getInstance();
446: if (service == null)
447: return;
448:
449: service.join(param0);
450: }
451:
452: public static java.lang.String merge(java.lang.String param0,
453: org.w3c.dom.Element param1, java.lang.String param2) {
454: org.sakaiproject.site.api.SiteService service = getInstance();
455: if (service == null)
456: return null;
457:
458: return service.merge(param0, param1, param2);
459: }
460:
461: public static org.sakaiproject.site.api.Group findGroup(
462: java.lang.String param0) {
463: org.sakaiproject.site.api.SiteService service = getInstance();
464: if (service == null)
465: return null;
466:
467: return service.findGroup(param0);
468: }
469:
470: public static java.lang.String[] getLayoutNames() {
471: org.sakaiproject.site.api.SiteService service = getInstance();
472: if (service == null)
473: return null;
474:
475: return service.getLayoutNames();
476: }
477:
478: }
|