01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/assignment/tags/taggable_sakai_2-4-1/api/TaggingHelperInfo.java $
03: * $Id: TaggingHelperInfo.java 20874 2007-02-01 19:03:08Z jmpease@syr.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2006, 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 java.util.Map;
23:
24: /**
25: * An object that can provide the necessary data to interact with a specific
26: * helper tool.
27: *
28: * @author The Sakai Foundation.
29: */
30: public interface TaggingHelperInfo {
31:
32: /**
33: * @return The identifier of the helper that will be called.
34: */
35: public String getHelperId();
36:
37: /**
38: * @return The provider of the helper that this tagging helper information
39: * relates to.
40: */
41: public TaggingProvider getProvider();
42:
43: /**
44: * @return The description of this helper.
45: */
46: public String getDescription();
47:
48: /**
49: * @return The name of this helper.
50: */
51: public String getName();
52:
53: /**
54: * @return A map of parameter names and values to pass to the helper.
55: */
56: public Map<String, ? extends Object> getParameterMap();
57: }
|