com.appiancorp.suiteapi.portal

Class PortletType

java.lang.Object

com.appiancorp.suiteapi.portal.PortletType

All Implemented Interfaces:

java.io.Serializable

Deprecated.

The Portal functionality will be removed in a future release. Use the Tempo Interface for similar functionality.

@Deprecated
public class PortletType
extends java.lang.Object
implements java.io.Serializable

Holds information about a portlet type.

See Also:

Portlet.getPortletType(), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFINITION_JSR168 Deprecated.
static java.lang.String	DEFINITION_WSRP Deprecated.
static java.lang.String	EXTENSION_ADDED_THROUGH_CONSOLE Deprecated.
static java.lang.String	EXTENSION_JSR168_PORTLET_NAME Deprecated.
static java.lang.String	EXTENSION_JSR168_PORTLET_WEB_APP_CONTEXT_PATH Deprecated.
static java.lang.String	EXTENSION_PORTLET_IX_HELPER_CLASS Deprecated.
static java.lang.String	EXTENSION_WSRP_PORTLET_HANDLE Deprecated.
static java.lang.String	EXTENSION_WSRP_PRODUCER_ID Deprecated.
static java.lang.String	FILTER_JSR168 Deprecated.
static java.lang.String	FILTER_WSRP Deprecated.
static java.lang.Integer	SORT_BY_DEFINITION Deprecated.
static java.lang.Integer	SORT_BY_DESCRIPTION Deprecated.
static java.lang.Integer	SORT_BY_NAME Deprecated.
static java.lang.Integer	SORT_BY_STATE Deprecated.
static java.lang.String	STATE_ACTIVE Deprecated.
static java.lang.String	STATE_INACTIVE Deprecated.

Constructor Summary

Constructors

Constructor and Description
PortletType() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefinition() Deprecated. A unique key name that is used by the application to define how this type of portlet is rendered.
java.lang.String	getDescription() Deprecated. A text description for this type of portlet.
java.lang.Boolean	getEditable() Deprecated. Method to check if the portlet type is editable or not.
java.lang.Object	getExtension(java.lang.String extensionKey_) Deprecated. Convenience method to retrieve an individual extension.
java.util.Map<java.lang.String,java.lang.Object>	getExtensions() Deprecated. Method to retrieve the extensions map which contains key value pairs which save additional information for the portlet type.
java.lang.String	getName() Deprecated. The displayable name of this type of portlet.
java.lang.String	getState() Deprecated. A string value.
java.lang.String	getStringExtension(java.lang.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 type
static boolean	isJsr168(java.lang.String portletTypeDefinition_) Deprecated. Returns true if the definition provided is a JSR-168 portlet type
boolean	isWsrp() Deprecated. Returns true if the current Portlet type's definition is a WSRP portlet type
static boolean	isWsrp(java.lang.String portletTypeDefinition_) Deprecated. Returns true if the definition provided is a WSRP portlet type
void	setDefinition(java.lang.String definition_) Deprecated. Set the definition for this portlet.
void	setDescription(java.lang.String description_) Deprecated. See getDescription()
void	setEditable(java.lang.Boolean editable_) Deprecated. Method to set if the portlet type is editable or not.
void	setExtension(java.lang.String extensionKey_, java.lang.Object value_) Deprecated. Convenience method to set an individual extension.
void	setExtensions(java.util.Map<java.lang.String,java.lang.Object> extensions_) Deprecated. Method to set the Extensions map in the Portlet Type bean
void	setName(java.lang.String name_) Deprecated. Sets the displayable name of this type of portlet.
void	setState(java.lang.String state_) Deprecated. A string value.
void	setStringExtension(java.lang.String extensionKey_, java.lang.String value_) Deprecated. Convenience method to set an individual string extension.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SORT_BY_NAME

public static final java.lang.Integer SORT_BY_NAME

Deprecated.

SORT_BY_DEFINITION

public static final java.lang.Integer SORT_BY_DEFINITION

Deprecated.

SORT_BY_DESCRIPTION

public static final java.lang.Integer SORT_BY_DESCRIPTION

Deprecated.

SORT_BY_STATE

public static final java.lang.Integer SORT_BY_STATE

Deprecated.

STATE_ACTIVE

public static final java.lang.String STATE_ACTIVE

Deprecated.

See Also:

Constant Field Values

STATE_INACTIVE

public static final java.lang.String STATE_INACTIVE

Deprecated.

See Also:

Constant Field Values

DEFINITION_JSR168

public static final java.lang.String DEFINITION_JSR168

Deprecated.

See Also:

Constant Field Values

DEFINITION_WSRP

public static final java.lang.String DEFINITION_WSRP

Deprecated.

See Also:

Constant Field Values

FILTER_JSR168

public static final java.lang.String FILTER_JSR168

Deprecated.

See Also:

Constant Field Values

FILTER_WSRP

public static final java.lang.String FILTER_WSRP

Deprecated.

See Also:

Constant Field Values

EXTENSION_ADDED_THROUGH_CONSOLE

public static final java.lang.String EXTENSION_ADDED_THROUGH_CONSOLE

Deprecated.

See Also:

Constant Field Values

EXTENSION_JSR168_PORTLET_WEB_APP_CONTEXT_PATH

public static final java.lang.String EXTENSION_JSR168_PORTLET_WEB_APP_CONTEXT_PATH

Deprecated.

See Also:

Constant Field Values

EXTENSION_JSR168_PORTLET_NAME

public static final java.lang.String EXTENSION_JSR168_PORTLET_NAME

Deprecated.

See Also:

Constant Field Values

EXTENSION_WSRP_PRODUCER_ID

public static final java.lang.String EXTENSION_WSRP_PRODUCER_ID

Deprecated.

See Also:

Constant Field Values

EXTENSION_WSRP_PORTLET_HANDLE

public static final java.lang.String EXTENSION_WSRP_PORTLET_HANDLE

Deprecated.

See Also:

Constant Field Values

EXTENSION_PORTLET_IX_HELPER_CLASS

public static final java.lang.String EXTENSION_PORTLET_IX_HELPER_CLASS

Deprecated.

See Also:

Constant Field Values

Constructor Detail

PortletType

public PortletType()

Deprecated.

Method Detail

setDefinition

public void setDefinition(java.lang.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 java.lang.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(java.lang.String name_)

Deprecated.

Sets the displayable name of this type of portlet. See getName()

getName

public java.lang.String getName()

Deprecated.

The displayable name of this type of portlet.

setDescription

public void setDescription(java.lang.String description_)

Deprecated.

See getDescription()

getDescription

public java.lang.String getDescription()

Deprecated.

A text description for this type of portlet.

setState

public void setState(java.lang.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 java.lang.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 java.lang.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(java.lang.Boolean editable_)

Deprecated.

Method to set if the portlet type is editable or not.

Parameters:

editable_ - The _editable to set.

getExtensions

public java.util.Map<java.lang.String,java.lang.Object> getExtensions()

Deprecated.

Method to retrieve the extensions map which contains key value pairs which save additional information for the portlet type.

Returns:

the extensions map

setExtensions

public void setExtensions(java.util.Map<java.lang.String,java.lang.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 java.lang.String getStringExtension(java.lang.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:

getExtensions()

setStringExtension

public void setStringExtension(java.lang.String extensionKey_,
                               java.lang.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 java.lang.Object getExtension(java.lang.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:

getExtensions()

setExtension

public void setExtension(java.lang.String extensionKey_,
                         java.lang.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(java.lang.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(java.lang.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