001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/discussion/tags/sakai_2-4-1/discussion-api/api/src/java/org/sakaiproject/discussion/cover/DiscussionService.java $
003: * $Id: DiscussionService.java 20990 2007-02-04 02:48:47Z csev@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.discussion.cover;
021:
022: import org.sakaiproject.component.cover.ComponentManager;
023:
024: /**
025: * <p>
026: * DiscussionService is a static Cover for the {@link org.sakaiproject.discussion.api.DiscussionService DiscussionService}; see that interface for usage details.
027: * </p>
028: */
029: public class DiscussionService {
030: /**
031: * Access the component instance: special cover only method.
032: *
033: * @return the component instance.
034: */
035: public static org.sakaiproject.discussion.api.DiscussionService getInstance() {
036: if (ComponentManager.CACHE_COMPONENTS) {
037: if (m_instance == null)
038: m_instance = (org.sakaiproject.discussion.api.DiscussionService) ComponentManager
039: .get(org.sakaiproject.discussion.api.DiscussionService.class);
040: return m_instance;
041: } else {
042: return (org.sakaiproject.discussion.api.DiscussionService) ComponentManager
043: .get(org.sakaiproject.discussion.api.DiscussionService.class);
044: }
045: }
046:
047: private static org.sakaiproject.discussion.api.DiscussionService m_instance = null;
048:
049: public static java.lang.String APPLICATION_ID = org.sakaiproject.discussion.api.DiscussionService.APPLICATION_ID;
050:
051: public static java.lang.String REFERENCE_ROOT = org.sakaiproject.discussion.api.DiscussionService.REFERENCE_ROOT;
052:
053: public static java.lang.String SECURE_ADD_TOPIC = org.sakaiproject.discussion.api.DiscussionService.SECURE_ADD_TOPIC;
054:
055: public static java.lang.String SECURE_READ = org.sakaiproject.discussion.api.DiscussionService.SECURE_READ;
056:
057: public static java.lang.String SECURE_ADD = org.sakaiproject.discussion.api.DiscussionService.SECURE_ADD;
058:
059: public static java.lang.String SECURE_REMOVE_OWN = org.sakaiproject.discussion.api.DiscussionService.SECURE_REMOVE_OWN;
060:
061: public static java.lang.String SECURE_REMOVE_ANY = org.sakaiproject.discussion.api.DiscussionService.SECURE_REMOVE_ANY;
062:
063: public static java.lang.String SECURE_UPDATE_OWN = org.sakaiproject.discussion.api.DiscussionService.SECURE_UPDATE_OWN;
064:
065: public static java.lang.String SECURE_UPDATE_ANY = org.sakaiproject.discussion.api.DiscussionService.SECURE_UPDATE_ANY;
066:
067: public static java.lang.String REF_TYPE_CHANNEL = org.sakaiproject.discussion.api.DiscussionService.REF_TYPE_CHANNEL;
068:
069: public static java.lang.String REF_TYPE_MESSAGE = org.sakaiproject.discussion.api.DiscussionService.REF_TYPE_MESSAGE;
070:
071: public static org.sakaiproject.discussion.api.DiscussionChannel getDiscussionChannel(
072: java.lang.String param0)
073: throws org.sakaiproject.exception.IdUnusedException,
074: org.sakaiproject.exception.PermissionException {
075: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
076: if (service == null)
077: return null;
078:
079: return service.getDiscussionChannel(param0);
080: }
081:
082: public static org.sakaiproject.discussion.api.DiscussionChannelEdit addDiscussionChannel(
083: java.lang.String param0)
084: throws org.sakaiproject.exception.IdUsedException,
085: org.sakaiproject.exception.IdInvalidException,
086: org.sakaiproject.exception.PermissionException {
087: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
088: if (service == null)
089: return null;
090:
091: return service.addDiscussionChannel(param0);
092: }
093:
094: public static java.util.List getChannels() {
095: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
096: if (service == null)
097: return null;
098:
099: return service.getChannels();
100: }
101:
102: public static boolean allowGetChannel(java.lang.String param0) {
103: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
104: if (service == null)
105: return false;
106:
107: return service.allowGetChannel(param0);
108: }
109:
110: public static boolean allowAddChannel(java.lang.String param0) {
111: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
112: if (service == null)
113: return false;
114:
115: return service.allowAddChannel(param0);
116: }
117:
118: public static org.sakaiproject.message.api.MessageChannelEdit addChannel(
119: java.lang.String param0)
120: throws org.sakaiproject.exception.IdUsedException,
121: org.sakaiproject.exception.IdInvalidException,
122: org.sakaiproject.exception.PermissionException {
123: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
124: if (service == null)
125: return null;
126:
127: return service.addChannel(param0);
128: }
129:
130: public static boolean allowEditChannel(java.lang.String param0) {
131: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
132: if (service == null)
133: return false;
134:
135: return service.allowEditChannel(param0);
136: }
137:
138: public static org.sakaiproject.message.api.MessageChannelEdit editChannel(
139: java.lang.String param0)
140: throws org.sakaiproject.exception.IdUnusedException,
141: org.sakaiproject.exception.PermissionException,
142: org.sakaiproject.exception.InUseException {
143: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
144: if (service == null)
145: return null;
146:
147: return service.editChannel(param0);
148: }
149:
150: public static void commitChannel(
151: org.sakaiproject.message.api.MessageChannelEdit param0) {
152: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
153: if (service == null)
154: return;
155:
156: service.commitChannel(param0);
157: }
158:
159: public static void cancelChannel(
160: org.sakaiproject.message.api.MessageChannelEdit param0) {
161: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
162: if (service == null)
163: return;
164:
165: service.cancelChannel(param0);
166: }
167:
168: public static boolean allowRemoveChannel(java.lang.String param0) {
169: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
170: if (service == null)
171: return false;
172:
173: return service.allowRemoveChannel(param0);
174: }
175:
176: public static void removeChannel(
177: org.sakaiproject.message.api.MessageChannelEdit param0)
178: throws org.sakaiproject.exception.PermissionException {
179: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
180: if (service == null)
181: return;
182:
183: service.removeChannel(param0);
184: }
185:
186: public static java.lang.String channelReference(
187: java.lang.String param0, java.lang.String param1) {
188: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
189: if (service == null)
190: return null;
191:
192: return service.channelReference(param0, param1);
193: }
194:
195: public static java.lang.String messageReference(
196: java.lang.String param0, java.lang.String param1,
197: java.lang.String param2) {
198: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
199: if (service == null)
200: return null;
201:
202: return service.messageReference(param0, param1, param2);
203: }
204:
205: public static java.lang.String messageReference(
206: java.lang.String param0, java.lang.String param1) {
207: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
208: if (service == null)
209: return null;
210:
211: return service.messageReference(param0, param1);
212: }
213:
214: public static void cancelMessage(
215: org.sakaiproject.message.api.MessageEdit param0) {
216: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
217: if (service == null)
218: return;
219:
220: service.cancelMessage(param0);
221: }
222:
223: public static java.util.List getMessages(java.lang.String param0,
224: org.sakaiproject.time.api.Time param1, int param2,
225: boolean param3, boolean param4, boolean param5)
226: throws org.sakaiproject.exception.PermissionException {
227: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
228: if (service == null)
229: return null;
230:
231: return service.getMessages(param0, param1, param2, param3,
232: param4, param5);
233: }
234:
235: public static java.util.List getChannelIds(java.lang.String param0) {
236: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
237: if (service == null)
238: return null;
239:
240: return service.getChannelIds(param0);
241: }
242:
243: public static org.sakaiproject.message.api.Message getMessage(
244: org.sakaiproject.entity.api.Reference param0)
245: throws org.sakaiproject.exception.IdUnusedException,
246: org.sakaiproject.exception.PermissionException {
247: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
248: if (service == null)
249: return null;
250:
251: return service.getMessage(param0);
252: }
253:
254: public static org.sakaiproject.message.api.MessageChannel getChannel(
255: java.lang.String param0)
256: throws org.sakaiproject.exception.IdUnusedException,
257: org.sakaiproject.exception.PermissionException {
258: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
259: if (service == null)
260: return null;
261:
262: return service.getChannel(param0);
263: }
264:
265: public static java.lang.String merge(java.lang.String param0,
266: org.w3c.dom.Element param1, java.lang.String param2,
267: java.lang.String param3, java.util.Map param4,
268: java.util.HashMap param5, java.util.Set param6) {
269: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
270: if (service == null)
271: return null;
272:
273: return service.merge(param0, param1, param2, param3, param4,
274: param5, param6);
275: }
276:
277: public static java.lang.String getLabel() {
278: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
279: if (service == null)
280: return null;
281:
282: return service.getLabel();
283: }
284:
285: public static java.lang.String archive(java.lang.String param0,
286: org.w3c.dom.Document param1, java.util.Stack param2,
287: java.lang.String param3, java.util.List param4) {
288: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
289: if (service == null)
290: return null;
291:
292: return service.archive(param0, param1, param2, param3, param4);
293: }
294:
295: public static java.util.Map getSummary(java.lang.String param0,
296: int param1, int param2)
297: throws org.sakaiproject.exception.IdUsedException,
298: org.sakaiproject.exception.IdInvalidException,
299: org.sakaiproject.exception.PermissionException {
300: org.sakaiproject.discussion.api.DiscussionService service = getInstance();
301: if (service == null)
302: return null;
303:
304: return service.getSummary(param0, param1, param2);
305: }
306: }
|