Clearspace API (2.5.29) Core Javadocs

com.jivesoftware.community.widget
Class WidgetFrameBean

java.lang.Object
  extended by com.jivesoftware.community.widget.WidgetFrameBean

public class WidgetFrameBean
extends Object

A simple bean class to store WidgetFrame information.


Constructor Summary
WidgetFrameBean()
           
 
Method Summary
 int getContainerID()
          Gets the id of the container
 long getID()
          Gets the id of the WidgetFrame
 int getIndex()
          Gets the index of this WidgetFrame in the specified container.
 long getParentObjectID()
          Gets the object id of the parent
 int getParentObjectType()
          Gets the object type of the parent
 Map<String,String> getProperties()
          Gets the properties specific to this WidgetFrame
 long getWidgetID()
          Gets the internal id of the Widget
 boolean isPublished()
          True if this WidgetFrame is published, false otherwise.
 void setContainerID(int containerID)
          Sets the id of the container
 void setID(long ID)
          Sets the id of the WidgetFrame
 void setIndex(int index)
          Sets the index of this WidgetFrame in the specified container.
 void setParentObjectID(long parentObjectID)
          Sets the object id of the parent
 void setParentObjectType(int parentObjectType)
          Sets the object type of the parent
 void setProperties(Map<String,String> properties)
          Sets the properties specific to this WidgetFrame
 void setPublished(boolean published)
          True if this WidgetFrame is published, false otherwise.
 void setWidgetID(long widgetID)
          Sets the internal id of the Widget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WidgetFrameBean

public WidgetFrameBean()
Method Detail

getID

public long getID()
Gets the id of the WidgetFrame

Returns:
the id of the WidgetFrame

setID

public void setID(long ID)
Sets the id of the WidgetFrame

Parameters:
ID - the id of the WidgetFrame

getWidgetID

public long getWidgetID()
Gets the internal id of the Widget

Returns:
the internal id of the Widget

setWidgetID

public void setWidgetID(long widgetID)
Sets the internal id of the Widget

Parameters:
widgetID - the internal id of the Widget

getParentObjectType

public int getParentObjectType()
Gets the object type of the parent

Returns:
the object type of the parent

setParentObjectType

public void setParentObjectType(int parentObjectType)
Sets the object type of the parent

Parameters:
parentObjectType - the object type of the parent

getParentObjectID

public long getParentObjectID()
Gets the object id of the parent

Returns:
the object id of the parent

setParentObjectID

public void setParentObjectID(long parentObjectID)
Sets the object id of the parent

Parameters:
parentObjectID - the object id of the parent

getContainerID

public int getContainerID()
Gets the id of the container

Returns:
the id of the container

setContainerID

public void setContainerID(int containerID)
Sets the id of the container

Parameters:
containerID - the id of the container

getIndex

public int getIndex()
Gets the index of this WidgetFrame in the specified container.

Returns:
the index of this WidgetFrame in the specified container.

setIndex

public void setIndex(int index)
Sets the index of this WidgetFrame in the specified container.

Parameters:
index - the index of this WidgetFrame in the specified container.

isPublished

public boolean isPublished()
True if this WidgetFrame is published, false otherwise.

Returns:
true if this WidgetFrame is published, false otherwise.

setPublished

public void setPublished(boolean published)
True if this WidgetFrame is published, false otherwise.

Parameters:
published - true if this WidgetFrame is published, false otherwise.

getProperties

public Map<String,String> getProperties()
Gets the properties specific to this WidgetFrame

Returns:
the properties specific to this WidgetFrame

setProperties

public void setProperties(Map<String,String> properties)
Sets the properties specific to this WidgetFrame

Parameters:
properties - the properties specific to this WidgetFrame

Clearspace Project Page

Copyright © 1999-2007 Jive Software.