01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/entity/tags/sakai_2-4-1/entity-api/api/src/java/org/sakaiproject/entity/api/AttachmentContainerEdit.java $
03: * $Id: AttachmentContainerEdit.java 7040 2006-03-27 03:04:33Z 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.entity.api;
21:
22: import java.util.List;
23:
24: /**
25: * <p>
26: * AttachmentContainer is a mutable AttachmentContainer.
27: * </p>
28: */
29: public interface AttachmentContainerEdit extends AttachmentContainer {
30: /**
31: * Add an attachment.
32: *
33: * @param ref
34: * The attachment Reference.
35: */
36: void addAttachment(Reference ref);
37:
38: /**
39: * Remove an attachment.
40: *
41: * @param ref
42: * The attachment Reference to remove (the one removed will equal this, they need not be ==).
43: */
44: void removeAttachment(Reference ref);
45:
46: /**
47: * Replace the attachment set.
48: *
49: * @param attachments
50: * A ReferenceVector that will become the new set of attachments.
51: */
52: void replaceAttachments(List attachments);
53:
54: /**
55: * Clear all attachments.
56: */
57: void clearAttachments();
58: }
|