Package com.appiancorp.suiteapi.portal
Class PortletType
java.lang.Object
com.appiancorp.suiteapi.portal.PortletType
- All Implemented Interfaces:
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 Summary
Modifier and TypeFieldDescriptionstatic final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final String
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final String
Deprecated.static final String
Deprecated. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.A unique key name that is used by the application to define how this type of portlet is rendered.Deprecated.A text description for this type of portlet.Deprecated.Method to check if the portlet type is editable or not.getExtension
(String extensionKey_) Deprecated.Convenience method to retrieve an individual extension.Deprecated.Method to retrieve the extensions map which contains key value pairs <String,String> which save additional information for the portlet type.getName()
Deprecated.The displayable name of this type of portlet.getState()
Deprecated.A string value.getStringExtension
(String extensionKey_) Deprecated.Convenience method to retrieve an individual string extension.boolean
isJsr168()
Deprecated.Returns true if the current Portlet type's definition is a JSR-168 portlet typestatic boolean
Deprecated.Returns true if the definition provided is a JSR-168 portlet typeboolean
isWsrp()
Deprecated.Returns true if the current Portlet type's definition is a WSRP portlet typestatic boolean
Deprecated.Returns true if the definition provided is a WSRP portlet typevoid
setDefinition
(String definition_) Deprecated.Set the definition for this portlet.void
setDescription
(String description_) Deprecated.SeegetDescription()
void
setEditable
(Boolean editable_) Deprecated.Method to set if the portlet type is editable or not.void
setExtension
(String extensionKey_, Object value_) Deprecated.Convenience method to set an individual extension.void
setExtensions
(Map<String, Object> extensions_) Deprecated.Method to set the Extensions map in the Portlet Type beanvoid
Deprecated.Sets the displayable name of this type of portlet.void
Deprecated.A string value.void
setStringExtension
(String extensionKey_, String value_) Deprecated.Convenience method to set an individual string extension.
-
Field Details
-
SORT_BY_NAME
Deprecated. -
SORT_BY_DEFINITION
Deprecated. -
SORT_BY_DESCRIPTION
Deprecated. -
SORT_BY_STATE
Deprecated. -
STATE_ACTIVE
Deprecated.- See Also:
-
STATE_INACTIVE
Deprecated.- See Also:
-
DEFINITION_JSR168
Deprecated.- See Also:
-
DEFINITION_WSRP
Deprecated.- See Also:
-
FILTER_JSR168
Deprecated.- See Also:
-
FILTER_WSRP
Deprecated.- See Also:
-
EXTENSION_ADDED_THROUGH_CONSOLE
Deprecated.- See Also:
-
EXTENSION_JSR168_PORTLET_WEB_APP_CONTEXT_PATH
Deprecated.- See Also:
-
EXTENSION_JSR168_PORTLET_NAME
Deprecated.- See Also:
-
EXTENSION_WSRP_PRODUCER_ID
Deprecated.- See Also:
-
EXTENSION_WSRP_PORTLET_HANDLE
Deprecated.- See Also:
-
EXTENSION_PORTLET_IX_HELPER_CLASS
Deprecated.- See Also:
-
-
Constructor Details
-
PortletType
public PortletType()Deprecated.
-
-
Method Details
-
setDefinition
Deprecated.Set the definition for this portlet. The definition is a unique key which holds information about how this portlet is rendered. SeegetDefinition()
-
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 theportlet-type-config.xml
file.- Returns:
- Returns the portlet type definition
-
setName
Deprecated.Sets the displayable name of this type of portlet. SeegetName()
-
getName
Deprecated.The displayable name of this type of portlet. -
setDescription
Deprecated.SeegetDescription()
-
getDescription
Deprecated.A text description for this type of portlet. -
setState
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
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
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
Deprecated.Method to set if the portlet type is editable or not.- Parameters:
editable_
- The _editable to set.
-
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
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
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
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
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
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
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
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
-