Package com.appiancorp.suiteapi.portal

Class PortletType

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

  • Field Details

  • Constructor Details

    • PortletType

      public PortletType()
      Deprecated.

  • Method Details

    • setDefinition

      public void setDefinition(String definition_)
      Deprecated.
      Set the definition for this portlet. The definition is a unique key which holds information about how this portlet is rendered. See getDefinition()

    • getDefinition

      public String getDefinition()
      Deprecated.
      A unique key name that is used by the application to define how this type of portlet is rendered. In the current implementation, this is a tiles definition stated in the portal tiles configuration xml file which is mapped in the portlet-type-config.xml file.
      Returns:
      Returns the portlet type definition

    • setName

      public void setName(String name_)
      Deprecated.
      Sets the displayable name of this type of portlet. See getName()

    • getName

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

    • setDescription

      public void setDescription(String description_)
      Deprecated.
      See getDescription()

    • getDescription

      public String getDescription()
      Deprecated.
      A text description for this type of portlet.

    • setState

      public void setState(String state_)
      Deprecated.
      A string value. There are two options: "active" or "inactive". These options are used to establish whether or not it is permitted to create portlets of this type.

    • getState

      public String getState()
      Deprecated.
      A string value. There are two options: "active" or "inactive". These options are used to establish whether or not it is possible to create portlets of this type.
      Returns:
      Returns "active" if is possible to create portlets of this type, or "inactive" if is not possible.

    • getEditable

      public Boolean getEditable()
      Deprecated.
      Method to check if the portlet type is editable or not.
      Returns:
      Returns true if portlet type is editable and false if not.

    • setEditable

      public void setEditable(Boolean editable_)
      Deprecated.
      Method to set if the portlet type is editable or not.
      Parameters:
      editable_ - The _editable to set.

    • getExtensions

      public Map<String,Object> getExtensions()
      Deprecated.
      Method to retrieve the extensions map which contains key value pairs <String,String> which save additional information for the portlet type.
      Returns:
      the extensions map

    • setExtensions

      public void setExtensions(Map<String,Object> extensions_)
      Deprecated.
      Method to set the Extensions map in the Portlet Type bean
      Parameters:
      extensions_ - the extensions map that will be set for the current Portlet Type; if null is passed in, the extensions will be set to an empty map

    • getStringExtension

      public String getStringExtension(String extensionKey_)
      Deprecated.
      Convenience method to retrieve an individual string extension.
      Parameters:
      extensionKey_ - The key of the string extension to retrieve.
      Returns:
      The value of the target string extension.
      See Also:

    • setStringExtension

      public void setStringExtension(String extensionKey_, String value_)
      Deprecated.
      Convenience method to set an individual string extension.
      Parameters:
      extensionKey_ - The key of the string extension to set.
      value_ - The value to set for the target string extension.

    • getExtension

      public Object getExtension(String extensionKey_)
      Deprecated.
      Convenience method to retrieve an individual extension.
      Parameters:
      extensionKey_ - The key of the extension to retrieve.
      Returns:
      The value of the target extension.
      See Also:

    • setExtension

      public void setExtension(String extensionKey_, Object value_)
      Deprecated.
      Convenience method to set an individual extension.
      Parameters:
      extensionKey_ - The key of the extenstion to set.
      value_ - The value to set for the target extension.

    • isJsr168

      public static boolean isJsr168(String portletTypeDefinition_)
      Deprecated.
      Returns true if the definition provided is a JSR-168 portlet type
      Parameters:
      portletTypeDefinition_ - the definition to check
      Returns:
      true if the definition is a JSR-168 portlet

    • isJsr168

      public boolean isJsr168()
      Deprecated.
      Returns true if the current Portlet type's definition is a JSR-168 portlet type
      Returns:
      true if the definition is a JSR-168 portlet

    • isWsrp

      public static boolean isWsrp(String portletTypeDefinition_)
      Deprecated.
      Returns true if the definition provided is a WSRP portlet type
      Parameters:
      portletTypeDefinition_ - the definition to check
      Returns:
      true if the definition is a WSRP portlet

    • isWsrp

      public boolean isWsrp()
      Deprecated.
      Returns true if the current Portlet type's definition is a WSRP portlet type
      Returns:
      true if type is a WSRP portlet