01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/message/tags/sakai_2-4-1/message-api/api/src/java/org/sakaiproject/message/api/MessageHeaderEdit.java $
03: * $Id: MessageHeaderEdit.java 10272 2006-06-07 13:39:32Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 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.message.api;
21:
22: import java.util.Collection;
23:
24: import org.sakaiproject.entity.api.AttachmentContainerEdit;
25: import org.sakaiproject.exception.PermissionException;
26: import org.sakaiproject.time.api.Time;
27: import org.sakaiproject.user.api.User;
28:
29: /**
30: * <p>
31: * MessageHeader is the base Interface for a Sakai Message headers. Header fields common to all message service message headers are defined here.
32: * </p>
33: *
34: * @author Sakai Software Development Team
35: */
36: public interface MessageHeaderEdit extends MessageHeader,
37: AttachmentContainerEdit {
38: /**
39: * Set the date/time the message was sent to the channel.
40: *
41: * @param date
42: * The date/time the message was sent to the channel.
43: */
44: void setDate(Time date);
45:
46: /**
47: * Set the User who sent the message to the channel.
48: *
49: * @param user
50: * The User who sent the message to the channel.
51: */
52: void setFrom(User user);
53:
54: /**
55: * Set the draft status of the message.
56: *
57: * @param draft
58: * True if the message is a draft, false if not.
59: */
60: void setDraft(boolean draft);
61:
62: /**
63: * Set these as the message's groups, replacing the access and groups already defined.
64: *
65: * @param Collection
66: * groups The colelction of Group objects to use for this message.
67: * @throws PermissionException
68: * if the end user does not have permission to remove from the groups that would be removed or add to the groups that would be added.
69: */
70: void setGroupAccess(Collection groups) throws PermissionException;
71:
72: /**
73: * Remove any grouping for this message; the access mode reverts to channel and any groups are removed.
74: *
75: * @throws PermissionException
76: * if the end user does not have permission to do this.
77: */
78: void clearGroupAccess() throws PermissionException;
79: }
|