public class CitationHelperAction
extends org.sakaiproject.cheftool.VelocityPortletPaneledAction
| 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 |
| 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 |
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| Constructor and Description |
|---|
CitationHelperAction() |
| 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) |
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, updateStategetAlert, getAlert, getMenu, getPid, getState, getToolMode, prepState, sendToHelper, setToolMode, startHelper, startHelpergetActionURL, getVmReference, includeVm, setVmReferencesendParentRedirect, service, setNoCacheHeadersdoDelete, doHead, doOptions, doPut, doTrace, getLastModified, servicedestroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, logprotected static final org.apache.commons.logging.Log logger
public static org.sakaiproject.util.ResourceLoader rb
protected org.sakaiproject.citation.api.CitationService citationService
protected org.sakaiproject.citation.api.ConfigurationService configurationService
protected org.sakaiproject.citation.api.SearchManager searchManager
protected org.sakaiproject.content.api.ContentHostingService contentService
protected org.sakaiproject.entity.api.EntityManager entityManager
protected org.sakaiproject.tool.api.SessionManager sessionManager
protected static org.sakaiproject.util.api.FormattedText formattedText
protected static org.sakaiproject.tool.api.ToolManager toolManager
public static final Integer DEFAULT_RESULTS_PAGE_SIZE
public static final Integer DEFAULT_LIST_PAGE_SIZE
public static Integer defaultListPageSize
protected static final String ELEMENT_ID_CREATE_FORM
protected static final String ELEMENT_ID_EDIT_FORM
protected static final String ELEMENT_ID_LIST_FORM
protected static final String ELEMENT_ID_SEARCH_FORM
protected static final String ELEMENT_ID_RESULTS_FORM
protected static final String ELEMENT_ID_VIEW_FORM
public static final String CITATIONS_HELPER_CALLER
protected static Set<CitationHelperAction.Mode> ignoreModes
protected static final String PARAM_FORM_NAME
protected static final String STATE_RESOURCES_ADD
protected static final String STATE_CURRENT_DATABASES
protected static final String STATE_CANCEL_PAGE
protected static final String STATE_CITATION_COLLECTION_ID
protected static final String STATE_CITATION_COLLECTION
protected static final String STATE_CITATION_ID
protected static final String STATE_COLLECTION_TITLE
protected static final String STATE_CURRENT_REPOSITORY
protected static final String STATE_CURRENT_RESULTS
protected static final String STATE_LIST_ITERATOR
protected static final String STATE_LIST_PAGE
protected static final String STATE_LIST_PAGE_SIZE
protected static final String STATE_LIST_NO_SCROLL
protected static final String STATE_NO_KEYWORDS
protected static final String STATE_NO_DATABASES
protected static final String STATE_NO_RESULTS
protected static final String STATE_SEARCH_HIERARCHY
protected static final String STATE_SELECTED_CATEGORY
protected static final String STATE_DEFAULT_CATEGORY
protected static final String STATE_UNAUTHORIZED_DB
protected static final String STATE_REPOSITORY_MAP
protected static final String STATE_RESULTS_PAGE_SIZE
protected static final String STATE_KEYWORDS
protected static final String STATE_SEARCH_INFO
protected static final String STATE_BASIC_SEARCH
protected static final String STATE_SEARCH_RESULTS
protected static final String STATE_RESOURCE_ENTITY_PROPERTIES
protected static final String STATE_SORT
protected static final String TEMPLATE_NEW_RESOURCE
protected static final String TEMPLATE_CREATE
protected static final String TEMPLATE_EDIT
protected static final String TEMPLATE_ERROR
protected static final String TEMPLATE_ERROR_FATAL
protected static final String TEMPLATE_LIST
protected static final String TEMPLATE_REORDER
protected static final String TEMPLATE_ADD_CITATIONS
protected static final String TEMPLATE_IMPORT_CITATIONS
protected static final String TEMPLATE_MESSAGE
protected static final String TEMPLATE_SEARCH
protected static final String TEMPLATE_RESULTS
protected static final String TEMPLATE_VIEW
protected static final String TEMPLATE_DATABASE
protected static final String PROP_ACCESS_MODE
protected static final String PROP_IS_COLLECTION
protected static final String PROP_IS_DROPBOX
protected static final String PROP_IS_GROUP_INHERITED
protected static final String PROP_IS_GROUP_POSSIBLE
protected static final String PROP_IS_HIDDEN
protected static final String PROP_IS_PUBVIEW
protected static final String PROP_IS_PUBVIEW_INHERITED
protected static final String PROP_IS_PUBVIEW_POSSIBLE
protected static final String PROP_IS_SINGLE_GROUP_INHERITED
protected static final String PROP_IS_SITE_COLLECTION
protected static final String PROP_IS_SITE_ONLY
protected static final String PROP_IS_USER_SITE
protected static final String PROP_POSSIBLE_GROUPS
protected static final String PROP_RELEASE_DATE
protected static final String PROP_RELEASE_DATE_STR
protected static final String PROP_RETRACT_DATE
protected static final String PROP_RETRACT_DATE_STR
protected static final String PROP_USE_RELEASE_DATE
protected static final String PROP_USE_RETRACT_DATE
public static final String CITATION_ACTION
public static final String UPDATE_RESOURCE
public static final String CREATE_RESOURCE
public static final String IMPORT_CITATIONS
public static final String UPDATE_SAVED_SORT
public static final String CHECK_FOR_UPDATES
public static final String MIMETYPE_JSON
public static final String MIMETYPE_HTML
public static final String REQUESTED_MIMETYPE
public static final String CHARSET_UTF8
public static final long ONE_DAY
public static final long ONE_WEEK
public void init()
throws ServletException
init in class GenericServletServletExceptionprotected void toolModeDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res) throws org.sakaiproject.tool.api.ToolException
toolModeDispatch in class org.sakaiproject.cheftool.VelocityPortletPaneledActionorg.sakaiproject.tool.api.ToolExceptionVelocityPortletPaneledAction.toolModeDispatch(java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)public void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException
doGet in class org.sakaiproject.cheftool.VelocityPortletPaneledActionServletExceptionprotected 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)
protected Map<String,Object> checkForUpdates(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
public void doPost(HttpServletRequest req, HttpServletResponse res) throws ServletException
doPost in class org.sakaiproject.cheftool.ToolServletServletExceptionprotected 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)
protected Map<String,Object> updateSavedSort(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
protected Map<String,Object> createCitationList(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
protected Map<String,Object> updateCitationList(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
protected Map<String,Object> ensureCitationListExists(org.sakaiproject.util.ParameterParser params, org.sakaiproject.event.api.SessionState state, HttpServletRequest req, HttpServletResponse res)
params - state - req - res - 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 void captureAvailability(org.sakaiproject.util.ParameterParser params,
org.sakaiproject.content.api.ContentResourceEdit edit,
Map<String,Object> results)
params - edit - results - TODOprotected void captureAccess(org.sakaiproject.util.ParameterParser params,
org.sakaiproject.event.api.SessionState state,
org.sakaiproject.content.api.ContentResourceEdit edit,
Map<String,Object> results)
public SortedSet<String> convertToRefs(Collection<String> groupIds, Map<String,String> possibleGroupMap)
protected void preserveEntityIds(org.sakaiproject.util.ParameterParser params,
org.sakaiproject.event.api.SessionState state)
protected void putCitationCollectionDetails(org.sakaiproject.cheftool.Context context,
org.sakaiproject.event.api.SessionState state)
public String buildImportCitationsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
public String buildAddCitationsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
portlet - context - rundata - state - public String buildCreatePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
public String buildDatabasePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
portlet - context - rundata - state - public String buildEditPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
portlet - context - rundata - state - public String buildListPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
public String buildReorderPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
protected org.sakaiproject.citation.api.CitationCollection getCitationCollection(org.sakaiproject.event.api.SessionState state,
boolean create)
state - The SessionState object for the current session.create - A flag indicating whether the collection should be created
if it does not already exist.public String buildMainPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
public String buildNewResourcePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
public String buildMessagePanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
portlet - context - rundata - state - public String buildResultsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
portlet - context - rundata - state - public String buildSearchPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
portlet - context - rundata - state - public String buildViewPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state)
portlet - context - rundata - state - protected void loadSearchFormState(org.sakaiproject.cheftool.Context context,
org.sakaiproject.event.api.SessionState state)
context - state - public void doFinish(org.sakaiproject.cheftool.RunData data)
public void doCancel(org.sakaiproject.cheftool.RunData data)
public void doAddCitation(org.sakaiproject.cheftool.RunData data)
public void doRemove(org.sakaiproject.cheftool.RunData data)
public void doDatabasePopulate(org.sakaiproject.cheftool.RunData data)
public void doImportPage(org.sakaiproject.cheftool.RunData data)
data - public void doImport(org.sakaiproject.cheftool.RunData data)
data - public void doCreateResource(org.sakaiproject.cheftool.RunData data)
public void doCreate(org.sakaiproject.cheftool.RunData data)
protected CitationHelperAction.Caller getCaller(org.sakaiproject.event.api.SessionState state)
state - The session stateprotected void setCaller(org.sakaiproject.event.api.SessionState state,
CitationHelperAction.Caller caller)
state - The session statecaller - The calling applicationprotected void setMode(org.sakaiproject.event.api.SessionState state,
CitationHelperAction.Mode new_mode)
state - new_mode - public void doCreateCitation(org.sakaiproject.cheftool.RunData data)
protected void updateCitationFromParams(org.sakaiproject.citation.api.Citation citation,
org.sakaiproject.util.ParameterParser params)
citation - params - public void doEdit(org.sakaiproject.cheftool.RunData data)
public void doList(org.sakaiproject.cheftool.RunData data)
public void doResults(org.sakaiproject.cheftool.RunData data)
public void doAddCitations(org.sakaiproject.cheftool.RunData data)
public void doMessageFrame(org.sakaiproject.cheftool.RunData data)
public void doRemoveAllCitations(org.sakaiproject.cheftool.RunData data)
public void doImportCitationFromResourceUrl(org.sakaiproject.cheftool.RunData data)
public void doShowReorderCitations(org.sakaiproject.cheftool.RunData data)
public void doReorderCitations(org.sakaiproject.cheftool.RunData data)
public void doRemoveSelectedCitations(org.sakaiproject.cheftool.RunData data)
public void doReviseCitation(org.sakaiproject.cheftool.RunData data)
public void doCancelSearch(org.sakaiproject.cheftool.RunData data)
data - public void doSearch(org.sakaiproject.cheftool.RunData data)
data - Runtime dataprotected void doSearchCommon(org.sakaiproject.event.api.SessionState state,
CitationHelperAction.Mode errorMode)
state - Session stateerrorMode - Next mode to set if we have database hierarchy problemspublic void doBeginSearch(org.sakaiproject.cheftool.RunData data)
protected void doBasicSearch(org.sakaiproject.util.ParameterParser params,
org.sakaiproject.event.api.SessionState state,
org.sakaiproject.citation.api.ActiveSearch search)
params - request parameters from doBeginSearchstate - session statesearch - current searchprotected void doAdvancedSearch(org.sakaiproject.util.ParameterParser params,
org.sakaiproject.event.api.SessionState state,
org.sakaiproject.citation.api.ActiveSearch search)
params - request parameters from doBeginSearchstate - session statesearch - current searchpublic void doNextListPage(org.sakaiproject.cheftool.RunData data)
public void doPrevListPage(org.sakaiproject.cheftool.RunData data)
public void doLastListPage(org.sakaiproject.cheftool.RunData data)
public void doFirstListPage(org.sakaiproject.cheftool.RunData data)
public void doNextSearchPage(org.sakaiproject.cheftool.RunData data)
public void doPrevSearchPage(org.sakaiproject.cheftool.RunData data)
public void doFirstSearchPage(org.sakaiproject.cheftool.RunData data)
public void doChangeSearchPageSize(org.sakaiproject.cheftool.RunData data)
public void doChangeListPageSize(org.sakaiproject.cheftool.RunData data)
public void doView(org.sakaiproject.cheftool.RunData data)
protected CitationHelperAction.Mode validateState()
protected boolean initHelper(org.sakaiproject.event.api.SessionState state)
state - protected org.sakaiproject.content.api.ContentResource createTemporaryResource(org.sakaiproject.content.api.ResourceToolActionPipe pipe)
pipe - protected String validateURL(String url) throws MalformedURLException
MalformedURLExceptionprotected void cleanup(org.sakaiproject.tool.api.ToolSession toolSession,
String prefix,
org.sakaiproject.event.api.SessionState sessionState)
toolSession - prefix - public void doSortCollection(org.sakaiproject.cheftool.RunData data)
public void doSaveCollection(org.sakaiproject.cheftool.RunData data)
public static int preserveRequestState(org.sakaiproject.event.api.SessionState state,
String[] prefixes)
public static void restoreRequestState(org.sakaiproject.event.api.SessionState state,
String[] prefixes,
int requestStateId)
protected Map<String,Object> getProperties(org.sakaiproject.content.api.ContentEntity entity, org.sakaiproject.event.api.SessionState state)
protected org.sakaiproject.citation.api.CitationService getCitationService()
protected org.sakaiproject.citation.api.ConfigurationService getConfigurationService()
protected org.sakaiproject.citation.api.SearchManager getSearchManager()
protected org.sakaiproject.content.api.ContentHostingService getContentService()
protected org.sakaiproject.entity.api.EntityManager getEntityManager()
protected org.sakaiproject.tool.api.SessionManager getSessionManager()
protected static org.sakaiproject.tool.api.ToolManager getToolManager()
protected static org.sakaiproject.util.api.FormattedText getFormattedText()
Copyright © 2003-2015 The Sakai Foundation. All Rights Reserved.