Class CategoryCaddyHandler

All Implemented Interfaces:
JcmsConstants, JaliosConstants

public class CategoryCaddyHandler extends AbstractCaddyHandler<CategoryCaddyContext>
  • Constructor Details

    • CategoryCaddyHandler

      public CategoryCaddyHandler()
  • Method Details

    • processAction

      public boolean processAction() throws 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 AbstractCaddyHandler<CategoryCaddyContext>
      Returns:
      false if no redirection is needed, true otherwise
      Throws:
      IOException - IO Exception
    • getDataClass

      public Class<? extends Data> getDataClass()
      Description copied from class: AbstractCaddyHandler
      Retrieve the type of data being handled by this handler
      Specified by:
      getDataClass in class AbstractCaddyHandler<CategoryCaddyContext>
      Returns:
      a Data class
    • getNewCaddyContext

      protected CategoryCaddyContext getNewCaddyContext(Caddy caddy, Member member)
      Description copied from class: AbstractCaddyHandler
      Retrieve a new instance of CaddyContext.
      Specified by:
      getNewCaddyContext in class AbstractCaddyHandler<CategoryCaddyContext>
      Parameters:
      caddy - the current Caddy
      member - the logged Member
      Returns:
      a AbstractCaddyContext instance
    • getNewCaddyProcess

      protected CategoryCaddyProcess getNewCaddyProcess()
      Description copied from class: AbstractCaddyHandler
      Retrieve a new instance of CaddyProcess to start action when required.
      Specified by:
      getNewCaddyProcess in class AbstractCaddyHandler<CategoryCaddyContext>
      Returns:
      a AbstractCaddyProcess instance
    • getJsp

      protected String getJsp()
      Description copied from class: AbstractCaddyHandler
      Retrieve the path of the JSP.
      Specified by:
      getJsp in class AbstractCaddyHandler<CategoryCaddyContext>
      Returns:
      a path relative to the webapp root.
    • setNoSynonyms

      public void setNoSynonyms(boolean noSynonyms)
    • setNoIcon

      public void setNoIcon(boolean noIcon)
    • setNoImage

      public void setNoImage(boolean noImage)
    • setNoColor

      public void setNoColor(boolean noColor)
    • setSelectable

      public void setSelectable(String selectable)
    • setAlphaOrder

      public void setAlphaOrder(String v)
    • getToAlphaOrder

      public boolean getToAlphaOrder()
    • setPid

      public void setPid(String pid)
    • getRemoveFriendlyURLs

      public boolean getRemoveFriendlyURLs()
      Returns:
      true if the friendly URLs of categories in the caddy must be removed.
      Since:
      jcms-5.5.0
    • setRemoveFriendlyURLs

      public void setRemoveFriendlyURLs(boolean remove)
      Parameters:
      remove - set whether friendly URLs of categories in the caddy must be removed or not.
      Since:
      jcms-5.5.0
    • getGenerateFriendlyURLs

      public boolean getGenerateFriendlyURLs()
      Returns:
      true if Friendly URLs should be automatically generated for categories in the caddy
      Since:
      jcms-5.5.0
    • setGenerateFriendlyURLs

      public void setGenerateFriendlyURLs(boolean generate)
      Parameters:
      generate - set whether Friendly URLs should be automatically generated for categories in the caddy.
      Since:
      jcms-5.5.0
    • getCommonSelectable

      public boolean getCommonSelectable()
    • isCommonSelectableAvailable

      public boolean isCommonSelectableAvailable()
    • getCommonParent

      public Category getCommonParent()
    • isCommonParentAvailable

      public boolean isCommonParentAvailable()
    • setNoReadRight

      public void setNoReadRight(boolean v)
    • getNoReadRight

      public boolean getNoReadRight()
    • setAuthorizedMemberIds

      public void setAuthorizedMemberIds(String[] mbrIds)
    • getAvailableAuthorizedMemberSet

      public Set<Member> getAvailableAuthorizedMemberSet()
    • setAuthorizedMemberSetAddCount

      public void setAuthorizedMemberSetAddCount(int v)
    • getAuthorizedMemberSetCount

      public int getAuthorizedMemberSetCount()
    • setAuthorizedGroups

      public void setAuthorizedGroups(String[] v)
    • getAvailableAuthorizedGroups

      public Group[] getAvailableAuthorizedGroups()
    • setAuthorizedGroupsAddCount

      public void setAuthorizedGroupsAddCount(int v)
    • getAuthorizedGroupsCount

      public int getAuthorizedGroupsCount()