org.sakaiproject.api.app.help

Interface RestConfiguration

public interface RestConfiguration

Version:

$Id$

Author:

Jarrod Lannan

Method Summary

Modifier and Type	Method and Description
long	getCacheInterval() get cache interval
String	getCorpusDocument() get corpus document (xml containing all available docs in domain)
String	getOrganization() get organization
String	getResourceNameFromCorpusDoc(String xml) upon initialization of the help tool this method will get the resource name out of the xml
String	getRestCorpusUrl() gets the REST URL for corpus xml document
String	getRestCredentials() get REST credentials
String	getRestDomain() get REST domain
String	getRestUrl() get REST URL
String	getRestUrlInDomain() get REST URL with domain
void	setCacheInterval(long interval) set cache interval
void	setOrganization(String organization) set organization
void	setRestCredentials(String credentials) set REST credentials
void	setRestDomain(String domain) set REST domain
void	setRestUrl(String url) set REST URL

Method Detail

getOrganization

String getOrganization()

get organization

Returns:

organization

setOrganization

void setOrganization(String organization)

set organization

Parameters:

organization -

getRestCredentials

String getRestCredentials()

get REST credentials

Returns:

REST credentails

setRestCredentials

void setRestCredentials(String credentials)

set REST credentials

Parameters:

credentials -

getRestUrl

String getRestUrl()

get REST URL

Returns:

REST URL

setRestUrl

void setRestUrl(String url)

set REST URL

Parameters:

url -

getRestDomain

String getRestDomain()

get REST domain

Returns:

REST domain

setRestDomain

void setRestDomain(String domain)

set REST domain

Parameters:

domain -

getCacheInterval

long getCacheInterval()

get cache interval

Returns:

cache interval

setCacheInterval

void setCacheInterval(long interval)

set cache interval

Parameters:

interval -

getRestUrlInDomain

String getRestUrlInDomain()

get REST URL with domain

Returns:

a String of the URL

getRestCorpusUrl

String getRestCorpusUrl()

gets the REST URL for corpus xml document

Returns:

REST corpus URL as String

getCorpusDocument

String getCorpusDocument()

get corpus document (xml containing all available docs in domain)

Returns:

a String containing the corpus document

getResourceNameFromCorpusDoc

String getResourceNameFromCorpusDoc(String xml)

upon initialization of the help tool this method will get the resource name out of the xml

Parameters:

xml -

Returns:

name of document