lumis.service.pagepersonalization.bean

Class WidgetInstance

java.lang.Object

lumis.service.pagepersonalization.bean.WidgetInstance

All Implemented Interfaces:

Serializable

public class WidgetInstance
extends Object
implements Serializable

A Widget instance.

Since:

10.2.0

Version:

$Revision: 20412 $ $Date: 2017-07-20 19:55:43 +0000 (Thu, 20 Jul 2017) $

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static WidgetInstance	findByInterfaceInstanceId(String interfaceInstanceId) Returns the widget instance defined with the specified interface instance.
static List<WidgetInstance>	findByWidgetContentId(String widgetContentId) Returns the widget instances that belong to the specified widget content.
WidgetInstanceHolder	getHolder() Returns the holder on which this widget instance is.
int	getHolderPosition() Returns the position of this widget instance on its holder.
String	getId() Returns the identifier of this widget instance.
String	getInterfaceInstanceId() Returns the identifier of the service interface instance that corresponds to this widget instance.
String	getWidgetContentId() Returns the identifier of the content of the widget this instance is of.
void	moveTo(WidgetInstanceHolder destHolder, int position) Moves this widget instance to a holder at the specified position.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Returns the identifier of this widget instance.

Returns:

the identifier of this widget instance.

Since:

10.2.0

getInterfaceInstanceId

public String getInterfaceInstanceId()

Returns the identifier of the service interface instance that corresponds to this widget instance.

Returns:

the identifier of the service interface instance.

Since:

10.2.0

getWidgetContentId

public String getWidgetContentId()

Returns the identifier of the content of the widget this instance is of.

Returns:

the widget content identifier.

Since:

10.2.0

getHolder

public WidgetInstanceHolder getHolder()

Returns the holder on which this widget instance is.

Returns:

this widget instance's holder.

Since:

10.2.0

getHolderPosition

public int getHolderPosition()

Returns the position of this widget instance on its holder. When displayed on a holder, its widget instances are ordered by this value.

Returns:

the position.

Since:

10.2.0

moveTo

public void moveTo(WidgetInstanceHolder destHolder,
                   int position)
            throws PortalException

Moves this widget instance to a holder at the specified position. The destination holder must be of same type of the this widget instance's holder.

Parameters:

destHolder - the destination holder.

position - the position for the widget instance in the destination holder.

Throws:

PortalException

Since:

10.2.0

findByInterfaceInstanceId

public static WidgetInstance findByInterfaceInstanceId(String interfaceInstanceId)

Returns the widget instance defined with the specified interface instance.

Parameters:

interfaceInstanceId - the interface instance identifier.

Returns:

the widget or null if it was not found.

Since:

10.2.0

findByWidgetContentId

public static List<WidgetInstance> findByWidgetContentId(String widgetContentId)

Returns the widget instances that belong to the specified widget content.

Parameters:

widgetContentId - the widget content identifier.

Returns:

the widget instances, or an empty list if none was found.

Since:

10.2.0