01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/content/tags/sakai_2-4-1/content-api/api/src/java/org/sakaiproject/content/api/ContentResourceFilter.java $
03: * $Id: ContentResourceFilter.java 22558 2007-03-13 19:16:50Z jimeng@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.content.api;
21:
22: import java.util.List;
23:
24: public interface ContentResourceFilter {
25: /**
26: * Implement this method to control which actions are allowed for
27: * ContentCollections. This deals with "create" actions in particular.
28: * Implementation should inspect the actions in the list and include
29: * them in the returned list if they are can result in creation of
30: * resources that can be selected. Otherwise they should not be
31: * inclided.
32: * @param actions A collection of actions to test
33: * @return A list of actions that should be shown in the filepicker
34: * for each collection.
35: */
36: public List<ResourceToolAction> filterAllowedActions(
37: List<ResourceToolAction> actions);
38:
39: /**
40: * Implement this method to control which resources are allowed
41: * to be selected. Implementation should inspect the resource and
42: * return true if the resource should be selectable and false if not.
43: * @param contentResource resource to test
44: * @return true if resource should be selectable, false if not
45: */
46: public boolean allowSelect(ContentResource contentResource);
47:
48: /**
49: * Implement this method to control which resources are viewable.
50: * Implementation should inspect the resource and
51: * return true if the resource should be presented in the list
52: * and false if not.
53: * @param contentResource resource to test
54: * @return true if resource should be viewable, false if not
55: */
56: public boolean allowView(ContentResource contentResource);
57: }
|