01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/assignment/tags/taggable_sakai_2-4-1/api/AssignmentActivityProducer.java $
03: * $Id: AssignmentActivityProducer.java 22244 2007-03-06 21:50:03Z jmpease@syr.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2007 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.assignment.taggable.api;
21:
22: import org.sakaiproject.assignment.api.Assignment;
23: import org.sakaiproject.assignment.api.AssignmentSubmission;
24:
25: /**
26: * A producer of assignments as taggable activities.
27: *
28: * @author The Sakai Foundation.
29: */
30: public interface AssignmentActivityProducer extends
31: TaggableActivityProducer {
32:
33: /**
34: * The type name of this producer.
35: */
36: public static final String PRODUCER_ID = AssignmentActivityProducer.class
37: .getName();
38:
39: /**
40: * Method to wrap the given assignment as a taggable activity.
41: *
42: * @param assignment
43: * The assignment.
44: * @return The assignment represented as a taggable activity.
45: */
46: public TaggableActivity getActivity(Assignment assignment);
47:
48: /**
49: * Method to wrap the given assignment submission as a taggable item.
50: *
51: * @param assignmentSubmission
52: * The assignment submission.
53: * @param userId
54: * The identifier of the user that this item belongs to.
55: * @return The assignment submission represented as a taggable item.
56: */
57: public TaggableItem getItem(
58: AssignmentSubmission assignmentSubmission, String userId);
59: }
|