001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/help/tags/sakai_2-4-1/help-api/src/java/org/sakaiproject/api/app/help/RestConfiguration.java $
003: * $Id: RestConfiguration.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: * @author <a href="mailto:jlannan.iupui.edu">Jarrod Lannan</a>
024: * @version $Id: RestConfiguration.java 7653 2006-04-12 12:10:02Z marquard@ched.uct.ac.za $
025: *
026: */
027: public interface RestConfiguration {
028: /**
029: * get organization
030: * @return organization
031: */
032: public String getOrganization();
033:
034: /**
035: * set organization
036: * @param organization
037: */
038: public void setOrganization(String organization);
039:
040: /**
041: * get REST credentials
042: * @return REST credentails
043: */
044: public String getRestCredentials();
045:
046: /**
047: * set REST credentials
048: * @param credentials
049: */
050: public void setRestCredentials(String credentials);
051:
052: /**
053: * get REST URL
054: * @return REST URL
055: */
056: public String getRestUrl();
057:
058: /**
059: * set REST URL
060: * @param url
061: */
062: public void setRestUrl(String url);
063:
064: /**
065: * get REST domain
066: * @return REST domain
067: */
068: public String getRestDomain();
069:
070: /**
071: * set REST domain
072: * @param domain
073: */
074: public void setRestDomain(String domain);
075:
076: /**
077: * get cache interval
078: * @return cache interval
079: */
080: public long getCacheInterval();
081:
082: /**
083: * set cache interval
084: * @param interval
085: */
086: public void setCacheInterval(long interval);
087:
088: /**
089: * get REST URL with domain
090: * @return a String of the URL
091: */
092: public String getRestUrlInDomain();
093:
094: /**
095: * gets the REST URL for corpus xml document
096: * @return REST corpus URL as String
097: */
098: public String getRestCorpusUrl();
099:
100: /**
101: * get corpus document (xml containing all available docs in domain)
102: * @return a String containing the corpus document
103: */
104: public String getCorpusDocument();
105:
106: /**
107: * upon initialization of the help tool this method will get the resource name out of the xml
108: * @param xml
109: * @return name of document
110: */
111: public String getResourceNameFromCorpusDoc(String xml);
112:
113: }
|