uk.ac.cam.caret.sakai.rwiki.tool.bean

Class HistoryBean

java.lang.Object

uk.ac.cam.caret.sakai.rwiki.tool.bean.ViewBean

uk.ac.cam.caret.sakai.rwiki.tool.bean.HistoryBean

public class HistoryBean
extends ViewBean

General value bean for creating history views.

Author:

andrew

Field Summary

Fields

Modifier and Type	Field and Description
static String	LEFT_PARAM Parameter name for requesting a left version for a diff.
static String	REVISION_PARAM Parameter name for requesting a revision.
static String	RIGHT_PARAM Parameter name for requesting a right version for a diff.
static String	VERSION_PARAM Parameter name for version.

Fields inherited from class uk.ac.cam.caret.sakai.rwiki.tool.bean.ViewBean

ACTION_PARAM, ACTION_URL_ENCODED, DISBLE_BREADCRUMBS_ENCODED, MAIN_PANEL, MAIN_URL_ENCODED, PAGE_NAME_PARAM, PAGE_URL_ENCODED, PAGENAME_URL_ENCODED, PANEL_PARAM, PANEL_URL_ENCODED, PARAM_BREADCRUMB_NAME, REALM_URL_ENCODED, SEARCH_URL_ENCODED

Constructor Summary

Constructors

Constructor and Description
HistoryBean()
HistoryBean(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwikiObject, String defaultRealm) Creates a HistoryBean using the rwikiObject to fill most of it's fields
HistoryBean(String pageName, String defaultRealm, int defaultInterestedRevision, long time) Creates a HistoryBean

Method Summary

Methods

Modifier and Type	Method and Description
String	getDiffToCurrentUrl() Using the currently set interestedRevision returns an url that will generate a diff to the current revision from the interested revision
String	getDiffToPreviousUrl() Using the currently set interestedRevision returns an url that will generate a diff from that revision to it's previous revision.
int	getInterestedRevision() The currently set interestedRevision
String	getRevertToRevisionUrl() Using the currently set interestedRevision returns an url that will cause a revert to that revision.
String	getViewRevisionUrl() Using the currently set interestedRevision returns an url that will generate a view of that revision.
void	setInterestedRevision(int interestedRevision) Sets the currently interestedRevision

Methods inherited from class uk.ac.cam.caret.sakai.rwiki.tool.bean.ViewBean

getActionUrl, getActionUrl, getActionUrl, getActionUrl, getActionUrl, getAnchor, getBaseAccessUrl, getEditCommentURL, getEditUrl, getEditUrl, getExportUrl, getHistoryUrl, getHistoryUrl, getInfoUrl, getInfoUrl, getListCommentsURL, getListPageChatURL, getListPresenceURL, getListSpaceChatURL, getLocalName, getLocalSpace, getNewCommentURL, getOpenPageChatURL, getOpenSpaceChatURL, getPageName, getPageSpace, getPageUrl, getPageUrl, getPageUrl, getPreferencesUrl, getPrintViewUrl, getPrintViewUrl, getPublicViewUrl, getPublicViewUrl, getRssAccessUrl, getSearch, getSearchUrl, getViewUrl, getViewUrl, setAnchor, setLocalSpace, setPageName, setSearch, urlEncode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION_PARAM

public static final String VERSION_PARAM

Parameter name for version. This parameter is sent when reverting a RWikiObject. It is used to know when we have a VersionException

See Also:

Constant Field Values

LEFT_PARAM

public static final String LEFT_PARAM

Parameter name for requesting a left version for a diff. This parameter is sent when requesting a diff.

See Also:

Constant Field Values

RIGHT_PARAM

public static final String RIGHT_PARAM

Parameter name for requesting a right version for a diff. This parameter is sent when requesting a diff.

See Also:

Constant Field Values

REVISION_PARAM

public static final String REVISION_PARAM

Parameter name for requesting a revision. This parameter is sent when requesting a review of a particular revision or a reversion.

See Also:

Constant Field Values

Constructor Detail

HistoryBean

public HistoryBean()

HistoryBean

public HistoryBean(uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject rwikiObject,
           String defaultRealm)

Creates a HistoryBean using the rwikiObject to fill most of it's fields

Parameters:

rwikiObject - exemplar

defaultRealm - the defaultRealm

HistoryBean

public HistoryBean(String pageName,
           String defaultRealm,
           int defaultInterestedRevision,
           long time)

Creates a HistoryBean

Parameters:

pageName -

defaultRealm -

defaultInterestedRevision -

time -

Method Detail

getDiffToCurrentUrl

public String getDiffToCurrentUrl()

Using the currently set interestedRevision returns an url that will generate a diff to the current revision from the interested revision

Returns:

url as String

getDiffToPreviousUrl

public String getDiffToPreviousUrl()

Using the currently set interestedRevision returns an url that will generate a diff from that revision to it's previous revision.

Returns:

url as String

getViewRevisionUrl

public String getViewRevisionUrl()

Using the currently set interestedRevision returns an url that will generate a view of that revision.

Returns:

url as String

getRevertToRevisionUrl

public String getRevertToRevisionUrl()

Using the currently set interestedRevision returns an url that will cause a revert to that revision.

Returns:

url as String

getInterestedRevision

public int getInterestedRevision()

The currently set interestedRevision

Returns:

current interestedRevision

setInterestedRevision

public void setInterestedRevision(int interestedRevision)

Sets the currently interestedRevision

Parameters:

interestedRevision - to set