001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/help/tags/sakai_2-4-1/help-api/src/java/org/sakaiproject/api/app/help/Resource.java $
003: * $Id: Resource.java 7653 2006-04-12 12:10:02Z marquard@ched.uct.ac.za $
004: ***********************************************************************************
005: *
006: * Copyright (c) 2003, 2004 The Sakai Foundation.
007: *
008: * Licensed under the Educational Community License, Version 1.0 (the "License");
009: * you may not use this file except in compliance with the License.
010: * You may obtain a copy of the License at
011: *
012: * http://www.opensource.org/licenses/ecl1.php
013: *
014: * Unless required by applicable law or agreed to in writing, software
015: * distributed under the License is distributed on an "AS IS" BASIS,
016: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017: * See the License for the specific language governing permissions and
018: * limitations under the License.
019: *
020: **********************************************************************************/package org.sakaiproject.api.app.help;
021:
022: /**
023: * Resource in the help system
024: * @version $Id: Resource.java 7653 2006-04-12 12:10:02Z marquard@ched.uct.ac.za $
025: */
026: public interface Resource {
027: /**
028: * get the doc id for the resource
029: * @return doc id
030: */
031: public String getDocId();
032:
033: /**
034: * set the doc id for the resource
035: * @param docId
036: */
037: public void setDocId(String docId);
038:
039: /**
040: * get the location of this resource
041: * @return location
042: */
043: public String getLocation();
044:
045: /**
046: * set the location of this resource
047: * @param location
048: */
049: public void setLocation(String source);
050:
051: /**
052: * get the source of this resource
053: * @return source
054: */
055: public String getSource();
056:
057: /**
058: * set the source of this resource
059: * @param source
060: */
061: public void setSource(String source);
062:
063: /**
064: * get the time stamp of this resource
065: * @return tstamp
066: */
067: public Long getTstamp();
068:
069: /**
070: * set the time stamp of this resource
071: * @param tstamp
072: */
073: public void setTstamp(Long tstamp);
074:
075: /**
076: * get the name of this resource
077: * @return name
078: */
079: public String getName();
080:
081: /**
082: * set the name of this resource
083: * @param name
084: */
085: public void setName(String name);
086:
087: /**
088: * get the score for this resource
089: * @return score
090: */
091: public float getScore();
092:
093: /**
094: * set the score for this resource
095: * @param score
096: */
097: public void setScore(float score);
098:
099: /**
100: * get the formatted score for this resource
101: * @return formatted score
102: */
103: public String getFormattedScore();
104:
105: /**
106: * get the category for this resource
107: * @param category
108: */
109: public void setCategory(Category category);
110:
111: /**
112: * determine if this document is the default for a tool
113: * @return
114: */
115: public String getDefaultForTool();
116:
117: /**
118: * set whether this resource is the default for a tool
119: * @param defaultForTool
120: */
121: public void setDefaultForTool(String defaultForTool);
122:
123: /**
124: * determine if this document welcome page for the help tool
125: * @return
126: */
127: public String getWelcomePage();
128:
129: /**
130: * set whether this resource is the welcome page for the tool
131: * @param defaultForTool
132: */
133: public void setWelcomePage(String welcomePage);
134: }
|