com.appiancorp.suiteapi.portal

Class Portlet

java.lang.Object

com.appiancorp.suiteapi.portal.Portlet

All Implemented Interfaces:

LocalId, java.io.Serializable

Deprecated.

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

@Deprecated
public class Portlet
extends java.lang.Object
implements LocalId

Holds all the information about a portlet necessary for rendering.

See Also:

PortletService, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	PORTLET_ACCESS_LEVEL_ADMIN Deprecated. A constant indicating that the current user has administrative access to a particular portlet
static int	PORTLET_ACCESS_LEVEL_EDIT Deprecated. A constant indicating that the current user has editor access to a particular portlet
static int	PORTLET_ACCESS_LEVEL_NONE Deprecated. A constant indicating that the current user has no access to view to a particular portlet
static int	PORTLET_ACCESS_LEVEL_VIEW Deprecated. A constant indicating that the current user has view access to a particular portlet
static java.lang.Integer	SORT_BY_CREATOR Deprecated. A constant for sorting portlets by the portlet's Creator
static java.lang.Integer	SORT_BY_DATE_CREATED Deprecated. A constant for sorting portlets by the dates they were created
static java.lang.Integer	SORT_BY_FRAME Deprecated. A constant for sorting portlets by Frame
static java.lang.Integer	SORT_BY_ID Deprecated. A constant for sorting portlets by unique Id
static java.lang.Integer	SORT_BY_INHERITS_SECURITY Deprecated. A constant for sorting portlets by whether or not they inherit security from their parent portal page
static java.lang.Integer	SORT_BY_NAME Deprecated. A constant for sorting portlets by Name
static java.lang.Integer	SORT_BY_PORTLET_TYPE Deprecated. A constant for sorting portlets by Portlet Type
static java.lang.Integer	SORT_BY_PUBLIC Deprecated. A constant for sorting portlets by whther or not they are public
static java.lang.Integer	SORT_BY_SHAREABLE Deprecated. A constant for sorting portlets by whether or not the portlet allowed to be shared on other pages.

Constructor Summary

Constructors

Constructor and Description
Portlet() Deprecated.
Portlet(java.lang.String portletType, java.lang.String name, java.lang.String frame, boolean isShared, boolean isPublic, boolean inheritSecurity) Deprecated. Instantiate a portlet with the fields that must be populated in order to create the portlet in the database.

Method Summary

Modifier and Type	Method and Description
int	getAccessLevel() Deprecated. The current user's access level with respect to this portlet.
java.lang.String	getCreator() Deprecated. The user id of the creator of this portlet.
java.sql.Timestamp	getDateCreated() Deprecated. The timestamp indicating when this portlet was created.
java.lang.String	getFrame() Deprecated. The unique identifier of the frame that this portlet should be displayed in.
java.lang.Long	getId() Deprecated. The unique identifier of this portlet.
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.
java.lang.String	getName() Deprecated. The displayable name of this portlet.
java.util.Map<java.lang.String,java.lang.Object>	getParameters() Deprecated. The map of name-value pair parameters for this portlet.
java.lang.String	getPortletType() Deprecated. The unique identifier of the type of this portlet: PortletType.getDefinition()
java.lang.Boolean	getPortletTypeEditable() Deprecated. Returns the editable setting (PortletType.getEditable()) of this portlet's type (getPortletType()).
PortalRoleMap	getRoleMap() Deprecated. The portlet role map.
java.lang.String	getUuid() Deprecated. Returns the UUID of this Portlet.
boolean	isPublic() Deprecated. Indicates whether this portlet can be seen by everybody.
boolean	isShareable() Deprecated. Indicates whether this portlet can be shared between pages.
void	setAccessLevel(int p_) Deprecated. See getAccessLevel()
void	setCreator(java.lang.String p_) Deprecated. See getCreator()
void	setDateCreated(java.sql.Timestamp p_) Deprecated. See getDateCreated()
void	setFrame(java.lang.String p_) Deprecated. See getFrame()
void	setId(java.lang.Long id_) Deprecated. See getId()
void	setInheritsSecurity(boolean p_) Deprecated. See getInheritsSecurity()
void	setName(java.lang.String string_) Deprecated. See getName()
void	setParameters(java.util.Map<java.lang.String,java.lang.Object> p_) Deprecated. See getParameters()
void	setPortletType(java.lang.String p_) Deprecated. See getPortletType()
void	setPortletTypeEditable(java.lang.Boolean typeEditable_) Deprecated. See getPortletTypeEditable().
void	setPublic(boolean p_) Deprecated. See isPublic()
void	setRoleMap(PortalRoleMap p_) Deprecated. See getRoleMap()
void	setShareable(boolean p_) Deprecated. See isShareable()
void	setUuid(java.lang.String uuid) Deprecated. Set the UUID of this Portlet.
java.lang.String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

SORT_BY_NAME

public static final java.lang.Integer SORT_BY_NAME

Deprecated.

A constant for sorting portlets by Name

SORT_BY_PORTLET_TYPE

public static final java.lang.Integer SORT_BY_PORTLET_TYPE

Deprecated.

A constant for sorting portlets by Portlet Type

SORT_BY_FRAME

public static final java.lang.Integer SORT_BY_FRAME

Deprecated.

A constant for sorting portlets by Frame

SORT_BY_CREATOR

public static final java.lang.Integer SORT_BY_CREATOR

Deprecated.

A constant for sorting portlets by the portlet's Creator

SORT_BY_DATE_CREATED

public static final java.lang.Integer SORT_BY_DATE_CREATED

Deprecated.

A constant for sorting portlets by the dates they were created

SORT_BY_INHERITS_SECURITY

public static final java.lang.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 java.lang.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 java.lang.Integer SORT_BY_PUBLIC

Deprecated.

A constant for sorting portlets by whther or not they are public

SORT_BY_ID

public static final java.lang.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:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

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:

Constant Field Values

Constructor Detail

Portlet

public Portlet()

Deprecated.

Portlet

public Portlet(java.lang.String portletType,
               java.lang.String name,
               java.lang.String frame,
               boolean isShared,
               boolean isPublic,
               boolean inheritSecurity)

Deprecated.

Instantiate a portlet with the fields that must be populated in order to create the portlet in the database.

Parameters:

portletType - getPortletType()

name - getName()

frame - getFrame()

isShared - isShareable()

isPublic - isPublic()

inheritSecurity - getInheritsSecurity()

Method Detail

getId

public java.lang.Long getId()

Deprecated.

The unique identifier of this portlet.

Specified by:

getId in interface LocalId

Returns:

Object's Id

See Also:

LocalId.setId(Long)

setId

public void setId(java.lang.Long id_)

Deprecated.

See getId()

Specified by:

setId in interface LocalId

Parameters:

id_ - Id to set

See Also:

LocalId.getId()

getUuid

@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
public java.lang.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(java.lang.String uuid)

Deprecated.

Set the UUID of this Portlet. This value is ignored, except when the Portlet is being created.

getName

public java.lang.String getName()

Deprecated.

The displayable name of this portlet.

setName

public void setName(java.lang.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:

PortletService.getRoleMapForPortlet(java.lang.Long), isShareable()

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:

PortletService.findPortlets(java.lang.String, java.lang.String, java.lang.Long, java.lang.Integer, java.lang.Integer)

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:

PortletService.findPortlets(java.lang.String, java.lang.String, java.lang.Long, java.lang.Integer, java.lang.Integer)

setPublic

public void setPublic(boolean p_)

Deprecated.

See isPublic()

getPortletType

public java.lang.String getPortletType()

Deprecated.

The unique identifier of the type of this portlet: PortletType.getDefinition()

setPortletType

public void setPortletType(java.lang.String p_)

Deprecated.

See getPortletType()

getFrame

public java.lang.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(java.lang.String p_)

Deprecated.

See getFrame()

getCreator

public java.lang.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(java.lang.String p_)

Deprecated.

See getCreator()

getDateCreated

public java.sql.Timestamp getDateCreated()

Deprecated.

The timestamp indicating when this portlet was created.

setDateCreated

public void setDateCreated(java.sql.Timestamp p_)

Deprecated.

See getDateCreated()

getParameters

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

PortletService.updatePortletParameters(java.lang.Long, java.util.Map)

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.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 java.lang.Boolean getPortletTypeEditable()

Deprecated.

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

setPortletTypeEditable

public void setPortletTypeEditable(java.lang.Boolean typeEditable_)

Deprecated.

See getPortletTypeEditable().

toString

public java.lang.String toString()

Deprecated.

Overrides:

toString in class java.lang.Object