java.lang.Object
- com.jalios.jcms.context.JcmsContext
- - com.jalios.jcms.context.JcmsJspContext
  - - com.jalios.jcms.handler.JcmsFormHandler
    - - com.jalios.jcms.handler.PubBrowserHandler

All Implemented Interfaces:: JcmsConstants, JaliosConstants

public class PubBrowserHandler
extends JcmsFormHandler

Field Summary

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`ability`
`protected boolean`	`caddyFilter`
`protected Category`	`category`
`protected java.lang.Class`	`currentClass`
`protected boolean`	`detailMode`
`protected java.lang.String[]`	`documentKinds`
`protected Group[]`	`groups`
`protected boolean`	`isAllMode`
`protected boolean`	`isContentMode`
`protected boolean`	`isDeleteMode`
`protected boolean`	`isFormMode`
`protected boolean`	`isMineMode`
`protected boolean`	`isPortletMode`
`protected boolean`	`isUGCMode`
`protected Member`	`member`
`static java.lang.String`	`MINE_GROUPS`
`static java.lang.String`	`MINE_PORTAL`
`protected java.lang.String`	`mode`
`static java.lang.String`	`MODE_ALL`
`static java.lang.String`	`MODE_DELETE`
`static java.lang.String`	`MODE_MINE`
`protected java.lang.String`	`oldType`
`protected boolean`	`pagerAll`
`protected int`	`pageSize`
`protected java.util.TreeSet`	`portals`
`protected int`	`pstatus`
`static java.lang.String`	`PUBBROWSER_QUERY`	QueryHandler attribute used to indicate that we are processing a pub browser query.
`protected int`	`pubCount`
`protected QueryResultSet`	`qrs`
`protected QueryHandler`	`queryHandler`
`protected java.util.Set`	`resultSet`
`static java.lang.String`	`REVISION`
`protected boolean`	`showAllTypesFilter`
`protected boolean`	`showCaddy`
`protected boolean`	`showCategories`
`protected boolean`	`showReadRightsPub`
`protected boolean`	`sortReverse`
`protected java.lang.String`	`sortType`
`protected int`	`start`
`protected java.util.List<java.lang.Class<?>>`	`subTypeList`
`protected java.lang.Class`	`superClass`
`protected java.lang.String`	`text`
`protected boolean`	`workspaceFilter`

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForced

Fields inherited from class com.jalios.jcms.context.JcmsJspContext
AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADER

Fields inherited from class com.jalios.jcms.context.JcmsContext
browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspace

Fields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Fields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Constructor Summary

Constructors
Constructor Description

PubBrowserHandler()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`boolean`	`canPublish()`
`java.lang.String`	`getAbility()`	Retrieves the current the portal element's ability defined for this handler.
`Category`	`getCategory()`
`java.lang.Class`	`getCurrentClass()`
`java.lang.String[]`	`getDocumentKinds()`	Retrieve the kind of document defined for this PubBrowser
`Group[]`	`getGroups()`
`Member`	`getMember()`
`java.lang.Class`	`getOldTypeClass()`
`java.lang.String`	`getOpCaddy()`	Deprecated. use `isCaddyFilter()`
`java.util.TreeSet`	`getPortals()`
`java.util.TreeSet`	`getPortalSet()`
`int`	`getPstatus()`
`java.lang.String`	`getPubBrowserDescription()`	Returns the description of the pubBrowser class
`java.lang.String`	`getPubBrowserTitle(java.lang.Class clazz)`	Returns the title of the pubBrowser
`int`	`getPubCount()`
`QueryHandler`	`getQueryHandler()`
`java.lang.String`	`getQueryStatusMessage(java.lang.String userLang)`
`java.util.Set`	`getResultSet()`
`Group`	`getSelectedGroup()`
`java.util.List<java.lang.Class<?>>`	`getSubTypeList()`
`java.lang.Class`	`getSuperClass()`
`java.lang.String`	`getText()`
`boolean`	`isAllMode()`
`boolean`	`isAllWorkspaceFilter()`
`boolean`	`isCaddyFilter()`	Retrieve a boolean (as a string) indicating if the pub browser is filtered using content of the caddy
`boolean`	`isContentMode()`
`boolean`	`isDeleteMode()`
`boolean`	`isDetailMode()`
`boolean`	`isExactType()`
`boolean`	`isFormMode()`
`boolean`	`isHybrid()`
`boolean`	`isMineMode()`
`boolean`	`isPortletMode()`
`boolean`	`isPubCountAccurate()`
`boolean`	`isUGCMode()`
`boolean`	`isWorkspaceFilter()`
`boolean`	`processAction()`	Method to be implemented to check/validate action to be performed and process them.
`protected void`	`queryData()`	Execute the query to prepare resultSet
`boolean`	`selectGroup(Group g)`
`boolean`	`selectPortal(Portal p)`
`void`	`setAbility(java.lang.String ability)`	Sets the portal element's ability to match when PortalElement are found.
`void`	`setAllWorkspaceFilter(boolean allWorkspaceFilter)`
`void`	`setCaddyFilter(boolean filter)`	Set whether content of pub browser should be filtered by using content in caddy.
`void`	`setCid(java.lang.String cid)`
`void`	`setClassname(java.lang.String type)`
`void`	`setDetail(boolean detail)`
`void`	`setDocumentKinds(java.lang.String[] kinds)`	Set the kind of document to match for this PubBrowser
`void`	`setExactType(boolean exactType)`
`void`	`setGid(java.lang.String gid)`
`void`	`setMid(java.lang.String mid)`
`void`	`setMode(java.lang.String mode)`
`void`	`setOldType(java.lang.String string)`
`void`	`setOpCaddy(java.lang.String filter)`	Deprecated. use `setCaddyFilter(boolean)`
`void`	`setPagerAll(boolean pagerAll)`
`void`	`setPageSize(int pageSize)`
`void`	`setPortalId(java.lang.String portalId)`
`void`	`setPstatus(int i)`
`void`	`setReverse(boolean reverse)`
`void`	`setShowCategories(boolean b)`	Set the value of showCategories to b except if this parameter is forced as request parameter
`void`	`setShowReadRightPubs(boolean v)`
`void`	`setSort(java.lang.String sort)`
`void`	`setStart(int start)`
`void`	`setSuper(java.lang.String superType)`
`void`	`setText(java.lang.String string)`
`void`	`setWorkspaceFilter(boolean workspaceFilter)`
`boolean`	`showAllTypesFilter()`
`boolean`	`showCaddy()`
`boolean`	`showCategories()`
`boolean`	`showGroupFilter()`
`boolean`	`showMemberFilter()`
`boolean`	`showPortalFilter()`
`boolean`	`showPstatusFilter()`
`boolean`	`showQueryStatusMessage()`
`boolean`	`showTextFilter()`

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
afterValidation, checkMissingField, getAvailableMainLanguage, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getModalRedirect, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performFinish, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, updateUploadedField, updateUploadedFields, updateUploadedFields, validate, validateCSRF, validateFinish, validateNext, validatePrevious

Methods inherited from class com.jalios.jcms.context.JcmsJspContext
addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug

Methods inherited from class com.jalios.jcms.context.JcmsContext
addCookie, addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFile, getUploadedFileList, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, retrieveUploadedFile, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - REVISION
```
public static final java.lang.String REVISION
```
    See Also:
    
    Constant Field Values
  - PUBBROWSER_QUERY
```
public static final java.lang.String PUBBROWSER_QUERY
```
    QueryHandler attribute used to indicate that we are processing a pub browser query.
  - MINE_PORTAL
```
public static final java.lang.String MINE_PORTAL
```
    See Also:
    
    Constant Field Values
  - MINE_GROUPS
```
public static final java.lang.String MINE_GROUPS
```
    See Also:
    
    Constant Field Values
  - MODE_MINE
```
public static final java.lang.String MODE_MINE
```
    See Also:
    
    Constant Field Values
  - MODE_ALL
```
public static final java.lang.String MODE_ALL
```
    See Also:
    
    Constant Field Values
  - MODE_DELETE
```
public static final java.lang.String MODE_DELETE
```
    See Also:
    
    Constant Field Values
  - queryHandler
```
protected QueryHandler queryHandler
```
  - superClass
```
protected java.lang.Class superClass
```
  - currentClass
```
protected java.lang.Class currentClass
```
  - member
```
protected Member member
```
  - category
```
protected Category category
```
  - groups
```
protected Group[] groups
```
  - mode
```
protected java.lang.String mode
```
  - showCategories
```
protected boolean showCategories
```
  - showAllTypesFilter
```
protected boolean showAllTypesFilter
```
  - showReadRightsPub
```
protected boolean showReadRightsPub
```
  - showCaddy
```
protected boolean showCaddy
```
  - detailMode
```
protected boolean detailMode
```
  - qrs
```
protected QueryResultSet qrs
```
  - resultSet
```
protected java.util.Set resultSet
```
  - portals
```
protected java.util.TreeSet portals
```
  - pstatus
```
protected int pstatus
```
  - oldType
```
protected java.lang.String oldType
```
  - text
```
protected java.lang.String text
```
  - caddyFilter
```
protected boolean caddyFilter
```
  - workspaceFilter
```
protected boolean workspaceFilter
```
  - ability
```
protected java.lang.String ability
```
  - documentKinds
```
protected java.lang.String[] documentKinds
```
  - start
```
protected int start
```
  - pageSize
```
protected int pageSize
```
  - pagerAll
```
protected boolean pagerAll
```
  - pubCount
```
protected int pubCount
```
  - sortType
```
protected java.lang.String sortType
```
  - sortReverse
```
protected boolean sortReverse
```
  - isContentMode
```
protected boolean isContentMode
```
  - isPortletMode
```
protected boolean isPortletMode
```
  - isFormMode
```
protected boolean isFormMode
```
  - isUGCMode
```
protected boolean isUGCMode
```
  - isDeleteMode
```
protected boolean isDeleteMode
```
  - isAllMode
```
protected boolean isAllMode
```
  - isMineMode
```
protected boolean isMineMode
```
  - subTypeList
```
protected java.util.List<java.lang.Class<?>> subTypeList
```
- Constructor Detail
  - PubBrowserHandler
```
public PubBrowserHandler()
```
- Method Detail
  - processAction
```
public boolean processAction()
                      throws java.io.IOException
```
    Description copied from class: JcmsFormHandler
    
    Method to be implemented to check/validate action to be performed and process them.
    Default implementation is to return false. No need to call super method.
    This method may NOT be invoked at all if security validation are not met.
    You must ensure your handler and JSP can work properly without any code invoked in this method.
    
    Overrides:
    
    processAction in class JcmsFormHandler
    
    Returns:
    
    false if no redirection is needed, true otherwise
    
    Throws:
    
    java.io.IOException - IO Exception
  - queryData
```
protected void queryData()
                  throws LogException
```
    Execute the query to prepare resultSet
    
    Throws:
    
    LogException - if an exception occurs
  - getOldTypeClass
```
public java.lang.Class getOldTypeClass()
```
    Returns:
    
    the old type
  - getSuperClass
```
public java.lang.Class getSuperClass()
```
    Returns:
    
    the refine super class
    
    Since:
    
    jcms-4.0
  - getCurrentClass
```
public java.lang.Class getCurrentClass()
```
    Returns:
    
    the refine class
    
    Since:
    
    jcms-4.0
  - getMember
```
public Member getMember()
```
    Returns:
    
    the refine member
    
    Since:
    
    jcms-4.0
  - getCategory
```
public Category getCategory()
```
    Returns:
    
    the refine category
    
    Since:
    
    jcms-4.0
  - getGroups
```
public Group[] getGroups()
```
    Returns:
    
    all the groups
    
    Since:
    
    jcms-4.0
  - canPublish
```
public boolean canPublish()
```
    Returns:
    
    true if LoggedMember can publish current type
    
    Since:
    
    jcms-4.0
  - getPortals
```
public java.util.TreeSet getPortals()
```
  - getPortalSet
```
public java.util.TreeSet getPortalSet()
```
  - showCategories
```
public boolean showCategories()
```
    Returns:
    
    true if pubBrowser must show Category tree
    
    Since:
    
    jcms-4.0
  - showAllTypesFilter
```
public boolean showAllTypesFilter()
```
    Returns:
    
    true if the pubBrowser must show the "All types" filter option
    
    Since:
    
    jcms-6.0.0
  - showCaddy
```
public boolean showCaddy()
```
    Returns:
    
    true if the caddy icons must be shown.
    
    Since:
    
    jcms-6.0.0
  - isDetailMode
```
public boolean isDetailMode()
```
    Returns:
    
    if the table is in detailed mode
    
    Since:
    
    jcms-4.0
  - selectGroup
```
public boolean selectGroup(Group g)
```
    Parameters:
    
    g - the group
    
    Returns:
    
    true if the current group should be selected
    
    Since:
    
    jcms-4.0
  - getSelectedGroup
```
public Group getSelectedGroup()
```
    Returns:
    
    the selected group
  - selectPortal
```
public boolean selectPortal(Portal p)
```
    Parameters:
    
    p - the portal
    
    Returns:
    
    true if the current portal should be selected
    
    Since:
    
    jcms-4.0
  - isPortletMode
```
public boolean isPortletMode()
```
    Returns:
    
    true if pubBrowser show Portlet
    
    Since:
    
    jcms-4.0
  - isFormMode
```
public boolean isFormMode()
```
    Returns:
    
    true if pubBrowser show Form
    
    Since:
    
    jcms-4.0
  - isContentMode
```
public boolean isContentMode()
```
    Returns:
    
    true if pubBrowser show Content
    
    Since:
    
    jcms-4.0
  - isUGCMode
```
public boolean isUGCMode()
```
    Returns:
    
    true if pubBrowser show UGC
    
    Since:
    
    jcms-6.0.0
  - isDeleteMode
```
public boolean isDeleteMode()
```
    Returns:
    
    true if pubBrowser show Deleted Publication
    
    Since:
    
    jcms-4.0
  - isAllMode
```
public boolean isAllMode()
```
    Returns:
    
    true if pubBrowser show All Publication
    
    Since:
    
    jcms-4.0
  - isMineMode
```
public boolean isMineMode()
```
    Returns:
    
    true if pubBrowser show My Publication
    
    Since:
    
    jcms-4.0
  - showPstatusFilter
```
public boolean showPstatusFilter()
```
  - showGroupFilter
```
public boolean showGroupFilter()
```
  - showMemberFilter
```
public boolean showMemberFilter()
```
  - showPortalFilter
```
public boolean showPortalFilter()
```
  - showTextFilter
```
public boolean showTextFilter()
```
  - getResultSet
```
public java.util.Set getResultSet()
```
    Returns:
    
    the result of publication
    
    Since:
    
    jcms-4.0
  - getPubCount
```
public int getPubCount()
```
  - getPubBrowserTitle
```
public java.lang.String getPubBrowserTitle(java.lang.Class clazz)
```
    Returns the title of the pubBrowser
    
    Parameters:
    
    clazz - the selected class
    
    Returns:
    
    title
    
    Since:
    
    jcms-4.0
  - getPubBrowserDescription
```
public java.lang.String getPubBrowserDescription()
```
    Returns the description of the pubBrowser class
    
    Returns:
    
    description
    
    Since:
    
    jcms-5.6.0
  - getSubTypeList
```
public java.util.List<java.lang.Class<?>> getSubTypeList()
```
  - setSuper
```
public void setSuper(java.lang.String superType)
```
  - setClassname
```
public void setClassname(java.lang.String type)
```
  - setMode
```
public void setMode(java.lang.String mode)
```
  - setMid
```
public void setMid(java.lang.String mid)
```
  - setDetail
```
public void setDetail(boolean detail)
```
  - setCid
```
public void setCid(java.lang.String cid)
```
  - setPortalId
```
public void setPortalId(java.lang.String portalId)
```
  - setGid
```
public void setGid(java.lang.String gid)
```
  - setShowCategories
```
public void setShowCategories(boolean b)
```
    Set the value of showCategories to b except if this parameter is forced as request parameter
    
    Parameters:
    
    b - the value
  - getPstatus
```
public int getPstatus()
```
  - setPstatus
```
public void setPstatus(int i)
```
  - setOldType
```
public void setOldType(java.lang.String string)
```
  - getText
```
public java.lang.String getText()
```
  - setText
```
public void setText(java.lang.String string)
```
  - setOpCaddy
```
public void setOpCaddy(java.lang.String filter)
```
    Deprecated.
    use setCaddyFilter(boolean)
    
    Set whether content of pub browser should be filtered by using content in caddy.
    
    Parameters:
    
    filter - true to display only content from caddy, false to use normal behavior
  - getOpCaddy
```
public java.lang.String getOpCaddy()
```
    Deprecated.
    use isCaddyFilter()
    
    Retrieve a boolean (as a string) indicating if the pub browser is filtered using content of the caddy
    
    Returns:
    
    "true" if caddy is filter, "false"
  - setCaddyFilter
```
public void setCaddyFilter(boolean filter)
```
    Set whether content of pub browser should be filtered by using content in caddy.
    
    Parameters:
    
    filter - true to display only content from caddy, false to use normal behavior
    
    Since:
    
    jcms-7.1.2 (fix JCMS-3209)
  - isCaddyFilter
```
public boolean isCaddyFilter()
```
    Retrieve a boolean (as a string) indicating if the pub browser is filtered using content of the caddy
    
    Returns:
    
    "true" if caddy is filter, "false"
    
    Since:
    
    jcms-7.1.2 (fix JCMS-3209)
  - isWorkspaceFilter
```
public boolean isWorkspaceFilter()
```
  - setWorkspaceFilter
```
public void setWorkspaceFilter(boolean workspaceFilter)
```
  - setAbility
```
public void setAbility(java.lang.String ability)
```
    Sets the portal element's ability to match when PortalElement are found.
    
    Parameters:
    
    ability - an ability choosen from the PortalElement.getAllAbilities()
  - getAbility
```
public java.lang.String getAbility()
```
    Retrieves the current the portal element's ability defined for this handler.
    
    Returns:
    
    the ability defined for this query.
  - setDocumentKinds
```
public void setDocumentKinds(java.lang.String[] kinds)
```
    Set the kind of document to match for this PubBrowser
    
    Parameters:
    
    kinds - an array of document kind (e.g "pdf", "image", "spreadsheet", ...)
    
    Since:
    
    jcms-6.1
  - getDocumentKinds
```
public java.lang.String[] getDocumentKinds()
```
    Retrieve the kind of document defined for this PubBrowser
    
    Returns:
    
    a set of content type, never return null
    
    Since:
    
    jcms-6.1
  - setExactType
```
public void setExactType(boolean exactType)
```
  - isExactType
```
public boolean isExactType()
```
  - getQueryHandler
```
public QueryHandler getQueryHandler()
```
    Returns:
    
    the query handler that was used to find result of pubBrowser, or null if no handler was used.
  - setStart
```
public void setStart(int start)
```
  - setPageSize
```
public void setPageSize(int pageSize)
```
  - setPagerAll
```
public void setPagerAll(boolean pagerAll)
```
  - setSort
```
public void setSort(java.lang.String sort)
```
  - setReverse
```
public void setReverse(boolean reverse)
```
  - setShowReadRightPubs
```
public void setShowReadRightPubs(boolean v)
```
  - isHybrid
```
public boolean isHybrid()
```
  - isPubCountAccurate
```
public boolean isPubCountAccurate()
```
  - showQueryStatusMessage
```
public boolean showQueryStatusMessage()
```
  - getQueryStatusMessage
```
public java.lang.String getQueryStatusMessage(java.lang.String userLang)
```
  - isAllWorkspaceFilter
```
public boolean isAllWorkspaceFilter()
```
  - setAllWorkspaceFilter
```
public void setAllWorkspaceFilter(boolean allWorkspaceFilter)
```

Class PubBrowserHandler

Field Summary

Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler

Fields inherited from class com.jalios.jcms.context.JcmsJspContext

Fields inherited from class com.jalios.jcms.context.JcmsContext

Fields inherited from interface com.jalios.util.JaliosConstants

Fields inherited from interface com.jalios.jcms.JcmsConstants

Constructor Summary

Method Summary

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

Methods inherited from class com.jalios.jcms.context.JcmsJspContext

Methods inherited from class com.jalios.jcms.context.JcmsContext

Methods inherited from class java.lang.Object

Field Detail

REVISION

PUBBROWSER_QUERY

MINE_PORTAL

MINE_GROUPS

MODE_MINE

MODE_ALL

MODE_DELETE

queryHandler

superClass

currentClass

member

category

groups

mode

showCategories

showAllTypesFilter

showReadRightsPub

showCaddy

detailMode

qrs

resultSet

portals

pstatus

oldType

text

caddyFilter

workspaceFilter

ability

documentKinds

start

pageSize

pagerAll

pubCount

sortType

sortReverse

isContentMode

isPortletMode

isFormMode

isUGCMode

isDeleteMode

isAllMode

isMineMode

subTypeList

Constructor Detail

PubBrowserHandler

Method Detail

processAction

queryData

getOldTypeClass

getSuperClass

getCurrentClass

getMember

getCategory

getGroups

canPublish

getPortals

getPortalSet

showCategories

showAllTypesFilter

showCaddy

isDetailMode

selectGroup

getSelectedGroup

selectPortal

isPortletMode

isFormMode