01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/osp/tags/sakai_2-4-1/common/api/src/java/org/theospi/portfolio/review/mgt/ReviewManager.java $
03: * $Id: ReviewManager.java 17193 2006-10-18 17:46:00Z andersjb@iupui.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 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.theospi.portfolio.review.mgt;
21:
22: import java.util.List;
23:
24: import org.sakaiproject.entity.api.Reference;
25: import org.sakaiproject.metaobj.shared.model.Id;
26: import org.theospi.portfolio.review.model.Review;
27: import org.theospi.portfolio.shared.model.Node;
28:
29: public interface ReviewManager {
30:
31: public final static String CURRENT_REVIEW = "org.theospi.portfolio.review.currentReview";
32: public final static String CURRENT_REVIEW_ID = "org.theospi.portfolio.review.currentReviewId";
33: public final static String CANCEL_REVIEW = "org.theospi.portfolio.review.cancelReview";
34:
35: public Review createNew(String description, String siteId);
36:
37: public Review getReview(Id reviewId);
38:
39: public Review saveReview(Review review);
40:
41: public void deleteReview(Review review);
42:
43: public List listReviews(String siteId);
44:
45: public Review getReview(String id);
46:
47: public Node getNode(Reference ref);
48:
49: public List getReviews();
50:
51: public List getReviewsByParent(String parentId);
52:
53: /**
54: * the top function for getting the reviews. This pushes these review content
55: * into the security advisor.
56: *
57: * @param parentId
58: * @param siteId
59: * @param producer
60: * @return List of Review
61: */
62: public List getReviewsByParent(String parentId, String siteId,
63: String producer);
64:
65: /**
66: * the top function for getting the reviews. This pushes these review content
67: * into the security advisor.
68: *
69: * @param parentId
70: * @param type
71: * @param siteId
72: * @param producer
73: * @return List of Review
74: */
75: public List getReviewsByParentAndType(String parentId, int type,
76: String siteId, String producer);
77: }
|