01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/citations/tags/sakai_2-4-1/citations-api/api/src/java/org/sakaiproject/citation/api/CitationHelper.java $
03: * $Id: CitationHelper.java 22437 2007-03-12 18:13:35Z jimeng@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 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.citation.api;
21:
22: import org.sakaiproject.entity.api.Entity;
23:
24: /**
25: * CitationHelper describes the contract between the CitationHelper and its clients.
26: */
27: public interface CitationHelper {
28: /** The identifier by which the CitationHelper can be located (call ToolManager.getTool(HELPER_ID) */
29: public static final String CITATION_ID = "sakai.citation.tool";
30:
31: public static final String SPECIAL_HELPER_ID = "sakai.special.helper.id";
32:
33: public static final String REFERENCE_ROOT = Entity.SEPARATOR
34: + "citation";
35:
36: public static final String CITATION_PREFIX = "citation.";
37:
38: /** The name of the state attribute indicating which mode the helper is in */
39: public static final String STATE_HELPER_MODE = CITATION_PREFIX
40: + "helper.mode";
41:
42: public static final String CITATION_FRAME_ID = "Citations";
43:
44: /** The name that identifies a state attribute which carries an identifier fo the current ContentResource object */
45: public static final String RESOURCE_ID = CitationHelper.CITATION_PREFIX
46: + "resource_id";
47:
48: /** The name that identifies a state attribute which carries an identifier fo the current CitationCollection object */
49: public static final String CITATION_COLLECTION_ID = CITATION_PREFIX
50: + "current_collection_id";
51:
52: /** The name that identifies a state attribute which carries the id of the Citation object to edit */
53: public static final String CITATION_EDIT_ID = CITATION_PREFIX
54: + "edit_item_id";
55:
56: /** The name identifying a ResourceProperty containing the id of a CitationCollection */
57: public static final String PROP_CITATION_COLLECTION = "sakai:citation_collection_id";
58:
59: /** The name that identifies a state attribute which carries the actual Citation object that is being editted */
60: public static final String CITATION_EDIT_ITEM = CITATION_PREFIX
61: + "edit_item_item";
62:
63: public static final String CITATION_VIEW_ID = CITATION_PREFIX
64: + "edit_item_id";
65:
66: public static final String CITATION_VIEW_ITEM = CITATION_PREFIX
67: + "edit_item_item";
68:
69: public static final int DEFAULT_PAGESIZE = 10;
70:
71: }
|