Package com.appiancorp.suiteapi.portal

Class Portlet

java.lang.Object
com.appiancorp.suiteapi.portal.Portlet
All Implemented Interfaces:
LocalId, Serializable
@Deprecated public class Portlet extends Object implements LocalId
Deprecated.
The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.
Holds all the information about a portlet necessary for rendering.
See Also:

  • Field Details

    • SORT_BY_NAME

      public static final Integer SORT_BY_NAME
      Deprecated.
      A constant for sorting portlets by Name

    • SORT_BY_PORTLET_TYPE

      public static final Integer SORT_BY_PORTLET_TYPE
      Deprecated.
      A constant for sorting portlets by Portlet Type

    • SORT_BY_FRAME

      public static final Integer SORT_BY_FRAME
      Deprecated.
      A constant for sorting portlets by Frame

    • SORT_BY_CREATOR

      public static final Integer SORT_BY_CREATOR
      Deprecated.
      A constant for sorting portlets by the portlet's Creator

    • SORT_BY_DATE_CREATED

      public static final Integer SORT_BY_DATE_CREATED
      Deprecated.
      A constant for sorting portlets by the dates they were created

    • SORT_BY_INHERITS_SECURITY

      public static final Integer SORT_BY_INHERITS_SECURITY
      Deprecated.
      A constant for sorting portlets by whether or not they inherit security from their parent portal page

    • SORT_BY_SHAREABLE

      public static final Integer SORT_BY_SHAREABLE
      Deprecated.
      A constant for sorting portlets by whether or not the portlet allowed to be shared on other pages.

    • SORT_BY_PUBLIC

      public static final Integer SORT_BY_PUBLIC
      Deprecated.
      A constant for sorting portlets by whther or not they are public

    • SORT_BY_ID

      public static final Integer SORT_BY_ID
      Deprecated.
      A constant for sorting portlets by unique Id

    • PORTLET_ACCESS_LEVEL_NONE

      public static final int PORTLET_ACCESS_LEVEL_NONE
      Deprecated.
      A constant indicating that the current user has no access to view to a particular portlet
      See Also:

    • PORTLET_ACCESS_LEVEL_VIEW

      public static final int PORTLET_ACCESS_LEVEL_VIEW
      Deprecated.
      A constant indicating that the current user has view access to a particular portlet
      See Also:

    • PORTLET_ACCESS_LEVEL_EDIT

      public static final int PORTLET_ACCESS_LEVEL_EDIT
      Deprecated.
      A constant indicating that the current user has editor access to a particular portlet
      See Also:

    • PORTLET_ACCESS_LEVEL_ADMIN

      public static final int PORTLET_ACCESS_LEVEL_ADMIN
      Deprecated.
      A constant indicating that the current user has administrative access to a particular portlet
      See Also:

  • Constructor Details

  • Method Details

    • getId

      public Long getId()
      Deprecated.
      The unique identifier of this portlet.
      Specified by:
      getId in interface LocalId
      Returns:
      Object's Id
      See Also:

    • setId

      public void setId(Long id_)
      Deprecated.
      See getId()
      Specified by:
      setId in interface LocalId
      Parameters:
      id_ - Id to set
      See Also:

    • getUuid

      @ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()
      Deprecated.
      Returns the UUID of this Portlet. This field is not populated unless:
      • the portlet has previously been exported
      • the portlet was assigned a UUID when it was created
      • the portlet was assigned a UUID using the Import/Export API

    • setUuid

      public void setUuid(String uuid)
      Deprecated.
      Set the UUID of this Portlet. This value is ignored, except when the Portlet is being created.

    • getName

      public String getName()
      Deprecated.
      The displayable name of this portlet.

    • setName

      public void setName(String string_)
      Deprecated.
      See getName()

    • getInheritsSecurity

      public boolean getInheritsSecurity()
      Deprecated.
      Indicates whether the security of this portlet is determined based on the page this portlet is in, or based on its own role map. This property should be ignored if the portlet is shareable.
      Returns:
      true if the security settings of this portlet are the same as the security settings of the page that contains it; false if the security is based on this portlet's role map.
      See Also:

    • setInheritsSecurity

      public void setInheritsSecurity(boolean p_)
      Deprecated.
      See getInheritsSecurity()

    • isShareable

      public boolean isShareable()
      Deprecated.
      Indicates whether this portlet can be shared between pages. The security of shareable portlets is enforced through their role map.
      See Also:

    • setShareable

      public void setShareable(boolean p_)
      Deprecated.
      See isShareable()

    • isPublic

      public boolean isPublic()
      Deprecated.
      Indicates whether this portlet can be seen by everybody. Non public portlets are considered "targeted".
      See Also:

    • setPublic

      public void setPublic(boolean p_)
      Deprecated.
      See isPublic()

    • getPortletType

      public String getPortletType()
      Deprecated.
      The unique identifier of the type of this portlet: PortletType.getDefinition()

    • setPortletType

      public void setPortletType(String p_)
      Deprecated.
      See getPortletType()

    • getFrame

      public String getFrame()
      Deprecated.
      The unique identifier of the frame that this portlet should be displayed in. This must be the name of the tile definition to be used to surround the portlet content when rendering the portlet within a page. The built-in portlet frame tiles are in tiles-portal-base.xml. The portlet frame is also sometimes referred to as the "portlet template".

    • setFrame

      public void setFrame(String p_)
      Deprecated.
      See getFrame()

    • getCreator

      public String getCreator()
      Deprecated.
      The user id of the creator of this portlet. The creator of a page has complete ownership (i.e. ADMIN access level) on the page.

    • setCreator

      public void setCreator(String p_)
      Deprecated.
      See getCreator()

    • getDateCreated

      public Timestamp getDateCreated()
      Deprecated.
      The timestamp indicating when this portlet was created.

    • setDateCreated

      public void setDateCreated(Timestamp p_)
      Deprecated.
      See getDateCreated()

    • getParameters

      public Map<String,Object> getParameters()
      Deprecated.
      The map of name-value pair parameters for this portlet. Names must be single words, starting with a letter and containing only _, numbers and letters in the basic US character set. Values should be of type String, though future implementations (and experimentally, the current one) may allow other datatypes.
      See Also:

    • setParameters

      public void setParameters(Map<String,Object> p_)
      Deprecated.
      See getParameters()

    • getAccessLevel

      public int getAccessLevel()
      Deprecated.
      The current user's access level with respect to this portlet.
      Returns:
      The access level, see constants on this class.

    • setAccessLevel

      public void setAccessLevel(int p_)
      Deprecated.
      See getAccessLevel()

    • getRoleMap

      public PortalRoleMap getRoleMap()
      Deprecated.
      The portlet role map.

    • setRoleMap

      public void setRoleMap(PortalRoleMap p_)
      Deprecated.
      See getRoleMap()

    • getPortletTypeEditable

      public Boolean getPortletTypeEditable()
      Deprecated.
      Returns the editable setting (PortletType.getEditable()) of this portlet's type (getPortletType()).

    • setPortletTypeEditable

      public void setPortletTypeEditable(Boolean typeEditable_)
      Deprecated.
      See getPortletTypeEditable().

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object