org.sakaiproject.citation.tool

Class CitationHelperAction

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.sakaiproject.vm.ComponentServlet

org.sakaiproject.vm.VmServlet

org.sakaiproject.cheftool.VmServlet

org.sakaiproject.cheftool.ToolServlet

org.sakaiproject.cheftool.VelocityPortletPaneledAction

org.sakaiproject.citation.tool.CitationHelperAction

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

Direct Known Subclasses:

EditorIntegrationHelperAction

public class CitationHelperAction
extends org.sakaiproject.cheftool.VelocityPortletPaneledAction

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CitationHelperAction.AdvancedSearchHelper This class contains constants and utility methods to maintain state of the advanced search form UI and process submitted data
static class	CitationHelperAction.Caller
class	CitationHelperAction.CitationListSecurityAdviser
static class	CitationHelperAction.Mode Mode defines a complete set of values describing the user's navigation intentions
static class	CitationHelperAction.QuotedTextValidator

Nested classes/interfaces inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction

org.sakaiproject.cheftool.VelocityPortletPaneledAction.MyLogger

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHARSET_UTF8
static String	CHECK_FOR_UPDATES
static String	CITATION_ACTION
static String	CITATIONS_HELPER_CALLER The calling application reflects the nature of our caller
protected org.sakaiproject.citation.api.CitationService	citationService
protected org.sakaiproject.citation.api.ConfigurationService	configurationService
protected org.sakaiproject.content.api.ContentHostingService	contentService
static String	CREATE_RESOURCE
static Integer	DEFAULT_LIST_PAGE_SIZE
static Integer	DEFAULT_RESULTS_PAGE_SIZE
static Integer	defaultListPageSize
protected static String	ELEMENT_ID_CREATE_FORM
protected static String	ELEMENT_ID_EDIT_FORM
protected static String	ELEMENT_ID_LIST_FORM
protected static String	ELEMENT_ID_RESULTS_FORM
protected static String	ELEMENT_ID_SEARCH_FORM
protected static String	ELEMENT_ID_VIEW_FORM
protected org.sakaiproject.entity.api.EntityManager	entityManager
protected static org.sakaiproject.util.api.FormattedText	formattedText
protected static Set<CitationHelperAction.Mode>	ignoreModes
static String	IMPORT_CITATIONS
protected static org.apache.commons.logging.Log	logger
static String	MIMETYPE_HTML
static String	MIMETYPE_JSON
static long	ONE_DAY A long representing the number of milliseconds in one week.
static long	ONE_WEEK A long representing the number of milliseconds in one week.
protected static String	PARAM_FORM_NAME
protected static String	PROP_ACCESS_MODE
protected static String	PROP_IS_COLLECTION
protected static String	PROP_IS_DROPBOX
protected static String	PROP_IS_GROUP_INHERITED
protected static String	PROP_IS_GROUP_POSSIBLE
protected static String	PROP_IS_HIDDEN
protected static String	PROP_IS_PUBVIEW
protected static String	PROP_IS_PUBVIEW_INHERITED
protected static String	PROP_IS_PUBVIEW_POSSIBLE
protected static String	PROP_IS_SINGLE_GROUP_INHERITED
protected static String	PROP_IS_SITE_COLLECTION
protected static String	PROP_IS_SITE_ONLY
protected static String	PROP_IS_USER_SITE
protected static String	PROP_POSSIBLE_GROUPS
protected static String	PROP_RELEASE_DATE
protected static String	PROP_RELEASE_DATE_STR
protected static String	PROP_RETRACT_DATE
protected static String	PROP_RETRACT_DATE_STR
protected static String	PROP_USE_RELEASE_DATE
protected static String	PROP_USE_RETRACT_DATE
static org.sakaiproject.util.ResourceLoader	rb
static String	REQUESTED_MIMETYPE
protected org.sakaiproject.citation.api.SearchManager	searchManager
protected org.sakaiproject.tool.api.SessionManager	sessionManager
protected static String	STATE_BASIC_SEARCH
protected static String	STATE_CANCEL_PAGE
protected static String	STATE_CITATION_COLLECTION
protected static String	STATE_CITATION_COLLECTION_ID
protected static String	STATE_CITATION_ID
protected static String	STATE_COLLECTION_TITLE
protected static String	STATE_CURRENT_DATABASES
protected static String	STATE_CURRENT_REPOSITORY
protected static String	STATE_CURRENT_RESULTS
protected static String	STATE_DEFAULT_CATEGORY
protected static String	STATE_KEYWORDS
protected static String	STATE_LIST_ITERATOR
protected static String	STATE_LIST_NO_SCROLL
protected static String	STATE_LIST_PAGE
protected static String	STATE_LIST_PAGE_SIZE
protected static String	STATE_NO_DATABASES
protected static String	STATE_NO_KEYWORDS
protected static String	STATE_NO_RESULTS
protected static String	STATE_REPOSITORY_MAP
protected static String	STATE_RESOURCE_ENTITY_PROPERTIES
protected static String	STATE_RESOURCES_ADD
protected static String	STATE_RESULTS_PAGE_SIZE
protected static String	STATE_SEARCH_HIERARCHY
protected static String	STATE_SEARCH_INFO
protected static String	STATE_SEARCH_RESULTS
protected static String	STATE_SELECTED_CATEGORY
protected static String	STATE_SORT
protected static String	STATE_UNAUTHORIZED_DB
protected static String	TEMPLATE_ADD_CITATIONS
protected static String	TEMPLATE_CREATE
protected static String	TEMPLATE_DATABASE
protected static String	TEMPLATE_EDIT
protected static String	TEMPLATE_ERROR
protected static String	TEMPLATE_ERROR_FATAL
protected static String	TEMPLATE_IMPORT_CITATIONS
protected static String	TEMPLATE_LIST
protected static String	TEMPLATE_MESSAGE
protected static String	TEMPLATE_NEW_RESOURCE
protected static String	TEMPLATE_REORDER
protected static String	TEMPLATE_RESULTS
protected static String	TEMPLATE_SEARCH
protected static String	TEMPLATE_VIEW
protected static org.sakaiproject.tool.api.ToolManager	toolManager
static String	UPDATE_RESOURCE
static String	UPDATE_SAVED_SORT

Fields inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction

ATTR_CONFIG, ATTR_CONTEXT, ATTR_FRAME_FOCUS, ATTR_FRAME_REFRESH, ATTR_PORTLET, ATTR_RUNDATA, ATTR_TOP_REFRESH, BUTTON, CONTEXT_SITE_COLLECTION_ID, CONTEXT_SITE_COLLECTION_URL, HELPER_LINK_MODE, HELPER_MODE_DONE, LAYOUT_MAIN, Log, MODE_OPTIONS, SAKAI_CSRF_TOKEN, STATE_ACTION, STATE_FLOAT, STATE_HELPER, STATE_MESSAGE, STATE_MODE, STATE_NEW_PANEL, STATE_OBSERVER, STATE_OBSERVER2, STATE_PRESENCE_OBSERVER, STATE_TOOL

Fields inherited from class org.sakaiproject.cheftool.ToolServlet

ALERT_ATTR, ALERT_STATE_INITED, HELPER_ID, MAIN_PANEL, MENU_ATTR, PARAM_ACTION, PARAM_ACTION_COMBO, TITLE_PANEL, TOOL_MODE_ATTR, TOOL_MODE_DEFAULT

Fields inherited from class org.sakaiproject.cheftool.VmServlet

m_validator

Fields inherited from class org.sakaiproject.vm.ComponentServlet

ATTR_PARAMS

Constructor Summary

Constructors

Constructor and Description
CitationHelperAction()

Method Summary

Methods

Modifier and Type	Method and Description
String	buildAddCitationsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
String	buildCreatePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state) build the context.
String	buildDatabasePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
String	buildEditPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
String	buildImportCitationsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
String	buildListPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state) build the context.
String	buildMainPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state) build the context.
String	buildMessagePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
String	buildNewResourcePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
String	buildReorderPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
String	buildResultsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
String	buildSearchPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
String	buildViewPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
protected void	captureAccess(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, org.sakaiproject.content.api.ContentResourceEdit edit, Map<String,Object> results)
protected void	captureAvailability(org.sakaiproject.util.ParameterParser params, org.sakaiproject.content.api.ContentResourceEdit edit, Map<String,Object> results)
protected void	captureDisplayName(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, org.sakaiproject.content.api.ContentResourceEdit edit, Map<String,Object> results)
protected Map<String,Object>	checkForUpdates(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
protected void	cleanup(org.sakaiproject.tool.api.ToolSession toolSession, String prefix, org.sakaiproject.event.api.SessionState sessionState) Cleans up tool state used internally.
SortedSet<String>	convertToRefs(Collection<String> groupIds, Map<String,String> possibleGroupMap)
protected Map<String,Object>	createCitationList(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
protected org.sakaiproject.content.api.ContentResource	createTemporaryResource(org.sakaiproject.content.api.ResourceToolActionPipe pipe)
void	doAddCitation(org.sakaiproject.cheftool.RunData data) Adds a citation to the current citation collection.
void	doAddCitations(org.sakaiproject.cheftool.RunData data)
protected void	doAdvancedSearch(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, org.sakaiproject.citation.api.ActiveSearch search) Sets up an advanced search.
protected void	doBasicSearch(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, org.sakaiproject.citation.api.ActiveSearch search) Sets up a basic search.
void	doBeginSearch(org.sakaiproject.cheftool.RunData data)
void	doCancel(org.sakaiproject.cheftool.RunData data) Cancel the action for which the helper was launched.
void	doCancelSearch(org.sakaiproject.cheftool.RunData data)
void	doChangeListPageSize(org.sakaiproject.cheftool.RunData data)
void	doChangeSearchPageSize(org.sakaiproject.cheftool.RunData data)
void	doCreate(org.sakaiproject.cheftool.RunData data)
void	doCreateCitation(org.sakaiproject.cheftool.RunData data)
void	doCreateResource(org.sakaiproject.cheftool.RunData data)
void	doDatabasePopulate(org.sakaiproject.cheftool.RunData data)
void	doEdit(org.sakaiproject.cheftool.RunData data)
void	doFinish(org.sakaiproject.cheftool.RunData data)
void	doFirstListPage(org.sakaiproject.cheftool.RunData data)
void	doFirstSearchPage(org.sakaiproject.cheftool.RunData data)
void	doGet(HttpServletRequest req, HttpServletResponse res)
protected void	doGetHtmlFragmentResponse(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
protected void	doGetJsonResponse(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
void	doImport(org.sakaiproject.cheftool.RunData data)
void	doImportCitationFromResourceUrl(org.sakaiproject.cheftool.RunData data)
void	doImportPage(org.sakaiproject.cheftool.RunData data)
void	doLastListPage(org.sakaiproject.cheftool.RunData data)
void	doList(org.sakaiproject.cheftool.RunData data)
void	doMessageFrame(org.sakaiproject.cheftool.RunData data)
void	doNextListPage(org.sakaiproject.cheftool.RunData data)
void	doNextSearchPage(org.sakaiproject.cheftool.RunData data)
void	doPost(HttpServletRequest req, HttpServletResponse res)
protected void	doPostHtmlFragmentResponse(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
protected void	doPostJsonResponse(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
void	doPrevListPage(org.sakaiproject.cheftool.RunData data)
void	doPrevSearchPage(org.sakaiproject.cheftool.RunData data)
void	doRemove(org.sakaiproject.cheftool.RunData data) Removes a citation from the current citation collection.
void	doRemoveAllCitations(org.sakaiproject.cheftool.RunData data)
void	doRemoveSelectedCitations(org.sakaiproject.cheftool.RunData data)
void	doReorderCitations(org.sakaiproject.cheftool.RunData data)
void	doResults(org.sakaiproject.cheftool.RunData data)
void	doReviseCitation(org.sakaiproject.cheftool.RunData data)
void	doSaveCollection(org.sakaiproject.cheftool.RunData data)
void	doSearch(org.sakaiproject.cheftool.RunData data) Resources Tool/Citation Helper search
protected void	doSearchCommon(org.sakaiproject.event.api.SessionState state, CitationHelperAction.Mode errorMode) Common "doSearch()" support
void	doShowReorderCitations(org.sakaiproject.cheftool.RunData data)
void	doSortCollection(org.sakaiproject.cheftool.RunData data)
void	doView(org.sakaiproject.cheftool.RunData data)
protected Map<String,Object>	ensureCitationListExists(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res) Check whether we are editing an existing resource or working on a new citation list.
protected CitationHelperAction.Caller	getCaller(org.sakaiproject.event.api.SessionState state) Fetch the calling application
protected org.sakaiproject.citation.api.CitationCollection	getCitationCollection(org.sakaiproject.event.api.SessionState state, boolean create) This method retrieves the CitationCollection for the current session.
protected org.sakaiproject.citation.api.CitationService	getCitationService()
protected org.sakaiproject.citation.api.ConfigurationService	getConfigurationService()
protected org.sakaiproject.content.api.ContentHostingService	getContentService()
protected org.sakaiproject.entity.api.EntityManager	getEntityManager()
protected static org.sakaiproject.util.api.FormattedText	getFormattedText()
protected Map<String,Object>	getProperties(org.sakaiproject.content.api.ContentEntity entity, org.sakaiproject.event.api.SessionState state)
protected org.sakaiproject.citation.api.SearchManager	getSearchManager()
protected org.sakaiproject.tool.api.SessionManager	getSessionManager()
protected static org.sakaiproject.tool.api.ToolManager	getToolManager()
void	init()
protected boolean	initHelper(org.sakaiproject.event.api.SessionState state) This method is called upon each Citations Helper request to properly initialize the Citations Helper in case of a null Mode.
protected void	loadSearchFormState(org.sakaiproject.cheftool.Context context, org.sakaiproject.event.api.SessionState state)
protected void	preserveEntityIds(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state)
static int	preserveRequestState(org.sakaiproject.event.api.SessionState state, String[] prefixes)
protected void	putCitationCollectionDetails(org.sakaiproject.cheftool.Context context, org.sakaiproject.event.api.SessionState state)
static void	restoreRequestState(org.sakaiproject.event.api.SessionState state, String[] prefixes, int requestStateId)
protected void	setCaller(org.sakaiproject.event.api.SessionState state, CitationHelperAction.Caller caller) Set the calling applcation
protected void	setMode(org.sakaiproject.event.api.SessionState state, CitationHelperAction.Mode new_mode)
protected void	toolModeDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res) Check for the helper-done case locally and handle it before letting the VPPA.toolModeDispatch() handle the actual dispatch.
protected void	updateCitationFromParams(org.sakaiproject.citation.api.Citation citation, org.sakaiproject.util.ParameterParser params)
protected Map<String,Object>	updateCitationList(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
protected Map<String,Object>	updateSavedSort(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
protected CitationHelperAction.Mode	validateState() This method is used to ensure the Citations Helper is not invoked by the Resources tool in a state other than ADD_CITATIONS or LIST.
protected String	validateURL(String url)

Methods inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction

actionDispatch, addAlert, addOptionsMenu, allowedToOptions, cancelOptions, checkCSRFToken, clientWindowId, disableObservers, doOptions, doReset, enableObservers, getContext, getDateFormatString, getTimeFormatString, helperActionDispatch, initState, initState, justDelivered, mainPanelUpdateId, panelMethodName, processAction, resetTool, saveOptions, scheduleFocusRefresh, schedulePeerFrameRefresh, scheduleTopRefresh, setVmCourier, setVmStdRef, switchPanel, titlePanelUpdateId, updateState

Methods inherited from class org.sakaiproject.cheftool.ToolServlet

getAlert, getAlert, getMenu, getPid, getState, getToolMode, prepState, sendToHelper, setToolMode, startHelper, startHelper

Methods inherited from class org.sakaiproject.vm.VmServlet

getActionURL, getVmReference, includeVm, setVmReference

Methods inherited from class org.sakaiproject.vm.ComponentServlet

sendParentRedirect, service, setNoCacheHeaders

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.apache.commons.logging.Log logger

rb

public static org.sakaiproject.util.ResourceLoader rb

citationService

protected org.sakaiproject.citation.api.CitationService citationService

configurationService

protected org.sakaiproject.citation.api.ConfigurationService configurationService

searchManager

protected org.sakaiproject.citation.api.SearchManager searchManager

contentService

protected org.sakaiproject.content.api.ContentHostingService contentService

entityManager

protected org.sakaiproject.entity.api.EntityManager entityManager

sessionManager

protected org.sakaiproject.tool.api.SessionManager sessionManager

formattedText

protected static org.sakaiproject.util.api.FormattedText formattedText

toolManager

protected static org.sakaiproject.tool.api.ToolManager toolManager

DEFAULT_RESULTS_PAGE_SIZE

public static final Integer DEFAULT_RESULTS_PAGE_SIZE

DEFAULT_LIST_PAGE_SIZE

public static final Integer DEFAULT_LIST_PAGE_SIZE

defaultListPageSize

public static Integer defaultListPageSize

ELEMENT_ID_CREATE_FORM

protected static final String ELEMENT_ID_CREATE_FORM

See Also:

Constant Field Values

ELEMENT_ID_EDIT_FORM

protected static final String ELEMENT_ID_EDIT_FORM

See Also:

Constant Field Values

ELEMENT_ID_LIST_FORM

protected static final String ELEMENT_ID_LIST_FORM

See Also:

Constant Field Values

ELEMENT_ID_SEARCH_FORM

protected static final String ELEMENT_ID_SEARCH_FORM

See Also:

Constant Field Values

ELEMENT_ID_RESULTS_FORM

protected static final String ELEMENT_ID_RESULTS_FORM

See Also:

Constant Field Values

ELEMENT_ID_VIEW_FORM

protected static final String ELEMENT_ID_VIEW_FORM

See Also:

Constant Field Values

CITATIONS_HELPER_CALLER

public static final String CITATIONS_HELPER_CALLER

The calling application reflects the nature of our caller

See Also:

Constant Field Values

ignoreModes

protected static Set<CitationHelperAction.Mode> ignoreModes

PARAM_FORM_NAME

protected static final String PARAM_FORM_NAME

See Also:

Constant Field Values

STATE_RESOURCES_ADD

protected static final String STATE_RESOURCES_ADD

See Also:

Constant Field Values

STATE_CURRENT_DATABASES

protected static final String STATE_CURRENT_DATABASES

See Also:

Constant Field Values

STATE_CANCEL_PAGE

protected static final String STATE_CANCEL_PAGE

See Also:

Constant Field Values

STATE_CITATION_COLLECTION_ID

protected static final String STATE_CITATION_COLLECTION_ID

See Also:

Constant Field Values

STATE_CITATION_COLLECTION

protected static final String STATE_CITATION_COLLECTION

See Also:

Constant Field Values

STATE_CITATION_ID

protected static final String STATE_CITATION_ID

See Also:

Constant Field Values

STATE_COLLECTION_TITLE

protected static final String STATE_COLLECTION_TITLE

See Also:

Constant Field Values

STATE_CURRENT_REPOSITORY

protected static final String STATE_CURRENT_REPOSITORY

See Also:

Constant Field Values

STATE_CURRENT_RESULTS

protected static final String STATE_CURRENT_RESULTS

See Also:

Constant Field Values

STATE_LIST_ITERATOR

protected static final String STATE_LIST_ITERATOR

See Also:

Constant Field Values

STATE_LIST_PAGE

protected static final String STATE_LIST_PAGE

See Also:

Constant Field Values

STATE_LIST_PAGE_SIZE

protected static final String STATE_LIST_PAGE_SIZE

See Also:

Constant Field Values

STATE_LIST_NO_SCROLL

protected static final String STATE_LIST_NO_SCROLL

See Also:

Constant Field Values

STATE_NO_KEYWORDS

protected static final String STATE_NO_KEYWORDS

See Also:

Constant Field Values

STATE_NO_DATABASES

protected static final String STATE_NO_DATABASES

See Also:

Constant Field Values

STATE_NO_RESULTS

protected static final String STATE_NO_RESULTS

See Also:

Constant Field Values

STATE_SEARCH_HIERARCHY

protected static final String STATE_SEARCH_HIERARCHY

See Also:

Constant Field Values

STATE_SELECTED_CATEGORY

protected static final String STATE_SELECTED_CATEGORY

See Also:

Constant Field Values

STATE_DEFAULT_CATEGORY

protected static final String STATE_DEFAULT_CATEGORY

See Also:

Constant Field Values

STATE_UNAUTHORIZED_DB

protected static final String STATE_UNAUTHORIZED_DB

See Also:

Constant Field Values

STATE_REPOSITORY_MAP

protected static final String STATE_REPOSITORY_MAP

See Also:

Constant Field Values

STATE_RESULTS_PAGE_SIZE

protected static final String STATE_RESULTS_PAGE_SIZE

See Also:

Constant Field Values

STATE_KEYWORDS

protected static final String STATE_KEYWORDS

See Also:

Constant Field Values

STATE_SEARCH_INFO

protected static final String STATE_SEARCH_INFO

See Also:

Constant Field Values

STATE_BASIC_SEARCH

protected static final String STATE_BASIC_SEARCH

See Also:

Constant Field Values

STATE_SEARCH_RESULTS

protected static final String STATE_SEARCH_RESULTS

See Also:

Constant Field Values

STATE_RESOURCE_ENTITY_PROPERTIES

protected static final String STATE_RESOURCE_ENTITY_PROPERTIES

See Also:

Constant Field Values

STATE_SORT

protected static final String STATE_SORT

See Also:

Constant Field Values

TEMPLATE_NEW_RESOURCE

protected static final String TEMPLATE_NEW_RESOURCE

See Also:

Constant Field Values

TEMPLATE_CREATE

protected static final String TEMPLATE_CREATE

See Also:

Constant Field Values

TEMPLATE_EDIT

protected static final String TEMPLATE_EDIT

See Also:

Constant Field Values

TEMPLATE_ERROR

protected static final String TEMPLATE_ERROR

See Also:

Constant Field Values

TEMPLATE_ERROR_FATAL

protected static final String TEMPLATE_ERROR_FATAL

See Also:

Constant Field Values

TEMPLATE_LIST

protected static final String TEMPLATE_LIST

See Also:

Constant Field Values

TEMPLATE_REORDER

protected static final String TEMPLATE_REORDER

See Also:

Constant Field Values

TEMPLATE_ADD_CITATIONS

protected static final String TEMPLATE_ADD_CITATIONS

See Also:

Constant Field Values

TEMPLATE_IMPORT_CITATIONS

protected static final String TEMPLATE_IMPORT_CITATIONS

See Also:

Constant Field Values

TEMPLATE_MESSAGE

protected static final String TEMPLATE_MESSAGE

See Also:

Constant Field Values

TEMPLATE_SEARCH

protected static final String TEMPLATE_SEARCH

See Also:

Constant Field Values

TEMPLATE_RESULTS

protected static final String TEMPLATE_RESULTS

See Also:

Constant Field Values

TEMPLATE_VIEW

protected static final String TEMPLATE_VIEW

See Also:

Constant Field Values

TEMPLATE_DATABASE

protected static final String TEMPLATE_DATABASE

See Also:

Constant Field Values

PROP_ACCESS_MODE

protected static final String PROP_ACCESS_MODE

See Also:

Constant Field Values

PROP_IS_COLLECTION

protected static final String PROP_IS_COLLECTION

See Also:

Constant Field Values

PROP_IS_DROPBOX

protected static final String PROP_IS_DROPBOX

See Also:

Constant Field Values

PROP_IS_GROUP_INHERITED

protected static final String PROP_IS_GROUP_INHERITED

See Also:

Constant Field Values

PROP_IS_GROUP_POSSIBLE

protected static final String PROP_IS_GROUP_POSSIBLE

See Also:

Constant Field Values

PROP_IS_HIDDEN

protected static final String PROP_IS_HIDDEN

See Also:

Constant Field Values

PROP_IS_PUBVIEW

protected static final String PROP_IS_PUBVIEW

See Also:

Constant Field Values

PROP_IS_PUBVIEW_INHERITED

protected static final String PROP_IS_PUBVIEW_INHERITED

See Also:

Constant Field Values

PROP_IS_PUBVIEW_POSSIBLE

protected static final String PROP_IS_PUBVIEW_POSSIBLE

See Also:

Constant Field Values

PROP_IS_SINGLE_GROUP_INHERITED

protected static final String PROP_IS_SINGLE_GROUP_INHERITED

See Also:

Constant Field Values

PROP_IS_SITE_COLLECTION

protected static final String PROP_IS_SITE_COLLECTION

See Also:

Constant Field Values

PROP_IS_SITE_ONLY

protected static final String PROP_IS_SITE_ONLY

See Also:

Constant Field Values

PROP_IS_USER_SITE

protected static final String PROP_IS_USER_SITE

See Also:

Constant Field Values

PROP_POSSIBLE_GROUPS

protected static final String PROP_POSSIBLE_GROUPS

See Also:

Constant Field Values

PROP_RELEASE_DATE

protected static final String PROP_RELEASE_DATE

See Also:

Constant Field Values

PROP_RELEASE_DATE_STR

protected static final String PROP_RELEASE_DATE_STR

See Also:

Constant Field Values

PROP_RETRACT_DATE

protected static final String PROP_RETRACT_DATE

See Also:

Constant Field Values

PROP_RETRACT_DATE_STR

protected static final String PROP_RETRACT_DATE_STR

See Also:

Constant Field Values

PROP_USE_RELEASE_DATE

protected static final String PROP_USE_RELEASE_DATE

See Also:

Constant Field Values

PROP_USE_RETRACT_DATE

protected static final String PROP_USE_RETRACT_DATE

See Also:

Constant Field Values

CITATION_ACTION

public static final String CITATION_ACTION

See Also:

Constant Field Values

UPDATE_RESOURCE

public static final String UPDATE_RESOURCE

See Also:

Constant Field Values

CREATE_RESOURCE

public static final String CREATE_RESOURCE

See Also:

Constant Field Values

IMPORT_CITATIONS

public static final String IMPORT_CITATIONS

See Also:

Constant Field Values

UPDATE_SAVED_SORT

public static final String UPDATE_SAVED_SORT

See Also:

Constant Field Values

CHECK_FOR_UPDATES

public static final String CHECK_FOR_UPDATES

See Also:

Constant Field Values

MIMETYPE_JSON

public static final String MIMETYPE_JSON

See Also:

Constant Field Values

MIMETYPE_HTML

public static final String MIMETYPE_HTML

See Also:

Constant Field Values

REQUESTED_MIMETYPE

public static final String REQUESTED_MIMETYPE

See Also:

Constant Field Values

CHARSET_UTF8

public static final String CHARSET_UTF8

See Also:

Constant Field Values

ONE_DAY

public static final long ONE_DAY

A long representing the number of milliseconds in one week. Used for date calculations

See Also:

Constant Field Values

ONE_WEEK

public static final long ONE_WEEK

A long representing the number of milliseconds in one week. Used for date calculations

See Also:

Constant Field Values

Constructor Detail

CitationHelperAction

public CitationHelperAction()

Method Detail

init

public void init()
          throws ServletException

Overrides:

init in class GenericServlet

Throws:

ServletException

toolModeDispatch

protected void toolModeDispatch(String methodBase,
                    String methodExt,
                    HttpServletRequest req,
                    HttpServletResponse res)
                         throws org.sakaiproject.tool.api.ToolException

Check for the helper-done case locally and handle it before letting the VPPA.toolModeDispatch() handle the actual dispatch.

Overrides:

toolModeDispatch in class org.sakaiproject.cheftool.VelocityPortletPaneledAction

Throws:

org.sakaiproject.tool.api.ToolException

See Also:

VelocityPortletPaneledAction.toolModeDispatch(java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doGet

public void doGet(HttpServletRequest req,
         HttpServletResponse res)
           throws ServletException

Overrides:

doGet in class org.sakaiproject.cheftool.VelocityPortletPaneledAction

Throws:

ServletException

doGetHtmlFragmentResponse

protected void doGetHtmlFragmentResponse(org.sakaiproject.util.ParameterParser params,
                             org.sakaiproject.event.api.SessionState state,
                             HttpServletRequest req,
                             HttpServletResponse res)

doGetJsonResponse

protected void doGetJsonResponse(org.sakaiproject.util.ParameterParser params,
                     org.sakaiproject.event.api.SessionState state,
                     HttpServletRequest req,
                     HttpServletResponse res)

checkForUpdates

protected Map<String,Object> checkForUpdates(org.sakaiproject.util.ParameterParser params,
                                 org.sakaiproject.event.api.SessionState state,
                                 HttpServletRequest req,
                                 HttpServletResponse res)

doPost

public void doPost(HttpServletRequest req,
          HttpServletResponse res)
            throws ServletException

Overrides:

doPost in class org.sakaiproject.cheftool.ToolServlet

Throws:

ServletException

doPostHtmlFragmentResponse

protected void doPostHtmlFragmentResponse(org.sakaiproject.util.ParameterParser params,
                              org.sakaiproject.event.api.SessionState state,
                              HttpServletRequest req,
                              HttpServletResponse res)

doPostJsonResponse

protected void doPostJsonResponse(org.sakaiproject.util.ParameterParser params,
                      org.sakaiproject.event.api.SessionState state,
                      HttpServletRequest req,
                      HttpServletResponse res)

updateSavedSort

protected Map<String,Object> updateSavedSort(org.sakaiproject.util.ParameterParser params,
                                 org.sakaiproject.event.api.SessionState state,
                                 HttpServletRequest req,
                                 HttpServletResponse res)

createCitationList

protected Map<String,Object> createCitationList(org.sakaiproject.util.ParameterParser params,
                                    org.sakaiproject.event.api.SessionState state,
                                    HttpServletRequest req,
                                    HttpServletResponse res)

updateCitationList

protected Map<String,Object> updateCitationList(org.sakaiproject.util.ParameterParser params,
                                    org.sakaiproject.event.api.SessionState state,
                                    HttpServletRequest req,
                                    HttpServletResponse res)

ensureCitationListExists

protected Map<String,Object> ensureCitationListExists(org.sakaiproject.util.ParameterParser params,
                                          org.sakaiproject.event.api.SessionState state,
                                          HttpServletRequest req,
                                          HttpServletResponse res)

Check whether we are editing an existing resource or working on a new citation list. If it exists, we'll update any attributes that have changed. If it's new, we will create it and return the resourceUuid, along with other attributes, in a map.

Parameters:

params -

state -

req -

res -

Returns:

captureDisplayName

protected void captureDisplayName(org.sakaiproject.util.ParameterParser params,
                      org.sakaiproject.event.api.SessionState state,
                      org.sakaiproject.content.api.ContentResourceEdit edit,
                      Map<String,Object> results)

captureAvailability

protected void captureAvailability(org.sakaiproject.util.ParameterParser params,
                       org.sakaiproject.content.api.ContentResourceEdit edit,
                       Map<String,Object> results)

Parameters:

params -

edit -

results - TODO

captureAccess

protected void captureAccess(org.sakaiproject.util.ParameterParser params,
                 org.sakaiproject.event.api.SessionState state,
                 org.sakaiproject.content.api.ContentResourceEdit edit,
                 Map<String,Object> results)

convertToRefs

public SortedSet<String> convertToRefs(Collection<String> groupIds,
                              Map<String,String> possibleGroupMap)

preserveEntityIds

protected void preserveEntityIds(org.sakaiproject.util.ParameterParser params,
                     org.sakaiproject.event.api.SessionState state)

putCitationCollectionDetails

protected void putCitationCollectionDetails(org.sakaiproject.cheftool.Context context,
                                org.sakaiproject.event.api.SessionState state)

buildImportCitationsPanelContext

public String buildImportCitationsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                      org.sakaiproject.cheftool.Context context,
                                      org.sakaiproject.cheftool.RunData rundata,
                                      org.sakaiproject.event.api.SessionState state)

buildAddCitationsPanelContext

public String buildAddCitationsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                   org.sakaiproject.cheftool.Context context,
                                   org.sakaiproject.cheftool.RunData rundata,
                                   org.sakaiproject.event.api.SessionState state)

Parameters:

portlet -

context -

rundata -

state -

Returns:

buildCreatePanelContext

public String buildCreatePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                             org.sakaiproject.cheftool.Context context,
                             org.sakaiproject.cheftool.RunData rundata,
                             org.sakaiproject.event.api.SessionState state)

build the context.

Returns:

The name of the template to use.

buildDatabasePanelContext

public String buildDatabasePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                               org.sakaiproject.cheftool.Context context,
                               org.sakaiproject.cheftool.RunData rundata,
                               org.sakaiproject.event.api.SessionState state)

Parameters:

portlet -

context -

rundata -

state -

Returns:

buildEditPanelContext

public String buildEditPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                           org.sakaiproject.cheftool.Context context,
                           org.sakaiproject.cheftool.RunData rundata,
                           org.sakaiproject.event.api.SessionState state)

Parameters:

portlet -

context -

rundata -

state -

Returns:

buildListPanelContext

public String buildListPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                           org.sakaiproject.cheftool.Context context,
                           org.sakaiproject.cheftool.RunData rundata,
                           org.sakaiproject.event.api.SessionState state)

build the context.

Returns:

The name of the template to use.

buildReorderPanelContext

public String buildReorderPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                              org.sakaiproject.cheftool.Context context,
                              org.sakaiproject.cheftool.RunData rundata,
                              org.sakaiproject.event.api.SessionState state)

getCitationCollection

protected org.sakaiproject.citation.api.CitationCollection getCitationCollection(org.sakaiproject.event.api.SessionState state,
                                                                     boolean create)

This method retrieves the CitationCollection for the current session. If the CitationCollection is already in session-state and has not been updated in the persistent storage since it was last accessed, the copy in session-state will be returned. If it has been updated in storage, the copy in session-state will be updated and returned. If the CitationCollection has not yet been created in storage and the second parameter is true, this method will create the collection and return it. In that case, values will be added to session-state for attributes named STATE_CITATION_COLLECTION and STATE_CITATION_COLLECTION_ID. If the CitationCollection has not yet been created in storage and the second parameter is false, the method will return null.

Parameters:

state - The SessionState object for the current session.

create - A flag indicating whether the collection should be created if it does not already exist.

Returns:

The CitationCollection for the current session, or null.

buildMainPanelContext

public String buildMainPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                           org.sakaiproject.cheftool.Context context,
                           org.sakaiproject.cheftool.RunData rundata,
                           org.sakaiproject.event.api.SessionState state)

build the context.

Returns:

The name of the template to use.

buildNewResourcePanelContext

public String buildNewResourcePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                                  org.sakaiproject.cheftool.Context context,
                                  org.sakaiproject.cheftool.RunData rundata,
                                  org.sakaiproject.event.api.SessionState state)

buildMessagePanelContext

public String buildMessagePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                              org.sakaiproject.cheftool.Context context,
                              org.sakaiproject.cheftool.RunData rundata,
                              org.sakaiproject.event.api.SessionState state)

Parameters:

portlet -

context -

rundata -

state -

Returns:

buildResultsPanelContext

public String buildResultsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                              org.sakaiproject.cheftool.Context context,
                              org.sakaiproject.cheftool.RunData rundata,
                              org.sakaiproject.event.api.SessionState state)

Parameters:

portlet -

context -

rundata -

state -

Returns:

buildSearchPanelContext

public String buildSearchPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                             org.sakaiproject.cheftool.Context context,
                             org.sakaiproject.cheftool.RunData rundata,
                             org.sakaiproject.event.api.SessionState state)

Parameters:

portlet -

context -

rundata -

state -

Returns:

buildViewPanelContext

public String buildViewPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                           org.sakaiproject.cheftool.Context context,
                           org.sakaiproject.cheftool.RunData rundata,
                           org.sakaiproject.event.api.SessionState state)

Parameters:

portlet -

context -

rundata -

state -

Returns:

loadSearchFormState

protected void loadSearchFormState(org.sakaiproject.cheftool.Context context,
                       org.sakaiproject.event.api.SessionState state)

Parameters:

context -

state -

doFinish

public void doFinish(org.sakaiproject.cheftool.RunData data)

doCancel

public void doCancel(org.sakaiproject.cheftool.RunData data)

Cancel the action for which the helper was launched.

doAddCitation

public void doAddCitation(org.sakaiproject.cheftool.RunData data)

Adds a citation to the current citation collection. Called from the search-results popup.

doRemove

public void doRemove(org.sakaiproject.cheftool.RunData data)

Removes a citation from the current citation collection. Called from the search-results popup.

doDatabasePopulate

public void doDatabasePopulate(org.sakaiproject.cheftool.RunData data)

doImportPage

public void doImportPage(org.sakaiproject.cheftool.RunData data)

Parameters:

data -

doImport

public void doImport(org.sakaiproject.cheftool.RunData data)

Parameters:

data -

doCreateResource

public void doCreateResource(org.sakaiproject.cheftool.RunData data)

doCreate

public void doCreate(org.sakaiproject.cheftool.RunData data)

getCaller

protected CitationHelperAction.Caller getCaller(org.sakaiproject.event.api.SessionState state)

Fetch the calling application

Parameters:

state - The session state

Returns:

The calling application (default to Resources if nothing is set)

setCaller

protected void setCaller(org.sakaiproject.event.api.SessionState state,
             CitationHelperAction.Caller caller)

Set the calling applcation

Parameters:

state - The session state

caller - The calling application

setMode

protected void setMode(org.sakaiproject.event.api.SessionState state,
           CitationHelperAction.Mode new_mode)

Parameters:

state -

new_mode -

doCreateCitation

public void doCreateCitation(org.sakaiproject.cheftool.RunData data)

updateCitationFromParams

protected void updateCitationFromParams(org.sakaiproject.citation.api.Citation citation,
                            org.sakaiproject.util.ParameterParser params)

Parameters:

citation -

params -

doEdit

public void doEdit(org.sakaiproject.cheftool.RunData data)

doList

public void doList(org.sakaiproject.cheftool.RunData data)

doResults

public void doResults(org.sakaiproject.cheftool.RunData data)

doAddCitations

public void doAddCitations(org.sakaiproject.cheftool.RunData data)

doMessageFrame

public void doMessageFrame(org.sakaiproject.cheftool.RunData data)

doRemoveAllCitations

public void doRemoveAllCitations(org.sakaiproject.cheftool.RunData data)

doImportCitationFromResourceUrl

public void doImportCitationFromResourceUrl(org.sakaiproject.cheftool.RunData data)

doShowReorderCitations

public void doShowReorderCitations(org.sakaiproject.cheftool.RunData data)

doReorderCitations

public void doReorderCitations(org.sakaiproject.cheftool.RunData data)

doRemoveSelectedCitations

public void doRemoveSelectedCitations(org.sakaiproject.cheftool.RunData data)

doReviseCitation

public void doReviseCitation(org.sakaiproject.cheftool.RunData data)

doCancelSearch

public void doCancelSearch(org.sakaiproject.cheftool.RunData data)

Parameters:

data -

doSearch

public void doSearch(org.sakaiproject.cheftool.RunData data)

Resources Tool/Citation Helper search

Parameters:

data - Runtime data

doSearchCommon

protected void doSearchCommon(org.sakaiproject.event.api.SessionState state,
                  CitationHelperAction.Mode errorMode)

Common "doSearch()" support

Parameters:

state - Session state

errorMode - Next mode to set if we have database hierarchy problems

doBeginSearch

public void doBeginSearch(org.sakaiproject.cheftool.RunData data)

doBasicSearch

protected void doBasicSearch(org.sakaiproject.util.ParameterParser params,
                 org.sakaiproject.event.api.SessionState state,
                 org.sakaiproject.citation.api.ActiveSearch search)

Sets up a basic search.

Parameters:

params - request parameters from doBeginSearch

state - session state

search - current search

doAdvancedSearch

protected void doAdvancedSearch(org.sakaiproject.util.ParameterParser params,
                    org.sakaiproject.event.api.SessionState state,
                    org.sakaiproject.citation.api.ActiveSearch search)

Sets up an advanced search.

Parameters:

params - request parameters from doBeginSearch

state - session state

search - current search

doNextListPage

public void doNextListPage(org.sakaiproject.cheftool.RunData data)

doPrevListPage

public void doPrevListPage(org.sakaiproject.cheftool.RunData data)

doLastListPage

public void doLastListPage(org.sakaiproject.cheftool.RunData data)

doFirstListPage

public void doFirstListPage(org.sakaiproject.cheftool.RunData data)

doNextSearchPage

public void doNextSearchPage(org.sakaiproject.cheftool.RunData data)

doPrevSearchPage

public void doPrevSearchPage(org.sakaiproject.cheftool.RunData data)

doFirstSearchPage

public void doFirstSearchPage(org.sakaiproject.cheftool.RunData data)

doChangeSearchPageSize

public void doChangeSearchPageSize(org.sakaiproject.cheftool.RunData data)

doChangeListPageSize

public void doChangeListPageSize(org.sakaiproject.cheftool.RunData data)

doView

public void doView(org.sakaiproject.cheftool.RunData data)

validateState

protected CitationHelperAction.Mode validateState()

This method is used to ensure the Citations Helper is not invoked by the Resources tool in a state other than ADD_CITATIONS or LIST. It uses a simple state machine to accomplish this

Returns:

the Mode that the Citations Helper should be in

initHelper

protected boolean initHelper(org.sakaiproject.event.api.SessionState state)

This method is called upon each Citations Helper request to properly initialize the Citations Helper in case of a null Mode. Returns true if succeeded, false otherwise

Parameters:

state -

createTemporaryResource

protected org.sakaiproject.content.api.ContentResource createTemporaryResource(org.sakaiproject.content.api.ResourceToolActionPipe pipe)

Parameters:

pipe -

Returns:

validateURL

protected String validateURL(String url)
                      throws MalformedURLException

Throws:

MalformedURLException

cleanup

protected void cleanup(org.sakaiproject.tool.api.ToolSession toolSession,
           String prefix,
           org.sakaiproject.event.api.SessionState sessionState)

Cleans up tool state used internally. Useful before leaving helper mode.

Parameters:

toolSession -

prefix -

doSortCollection

public void doSortCollection(org.sakaiproject.cheftool.RunData data)

doSaveCollection

public void doSaveCollection(org.sakaiproject.cheftool.RunData data)

preserveRequestState

public static int preserveRequestState(org.sakaiproject.event.api.SessionState state,
                       String[] prefixes)

restoreRequestState

public static void restoreRequestState(org.sakaiproject.event.api.SessionState state,
                       String[] prefixes,
                       int requestStateId)

getProperties

protected Map<String,Object> getProperties(org.sakaiproject.content.api.ContentEntity entity,
                               org.sakaiproject.event.api.SessionState state)

getCitationService

protected org.sakaiproject.citation.api.CitationService getCitationService()

getConfigurationService

protected org.sakaiproject.citation.api.ConfigurationService getConfigurationService()

getSearchManager

protected org.sakaiproject.citation.api.SearchManager getSearchManager()

getContentService

protected org.sakaiproject.content.api.ContentHostingService getContentService()

getEntityManager

protected org.sakaiproject.entity.api.EntityManager getEntityManager()

getSessionManager

protected org.sakaiproject.tool.api.SessionManager getSessionManager()

getToolManager

protected static org.sakaiproject.tool.api.ToolManager getToolManager()

getFormattedText

protected static org.sakaiproject.util.api.FormattedText getFormattedText()