com.crossingchannels.portal.websphere.specification.wp.dom

Class PortletItem

java.lang.Object

com.crossingchannels.portal.websphere.specification.wp.dom.PortletItem

public class PortletItem
extends java.lang.Object

A portlet that can be displayed on a page. Corresponds to the concrete-portlet tag in portlet.xml (in the IBM API).

Java class for portletItem complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="portletItem">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="localedata" type="{}localeData" maxOccurs="unbounded" minOccurs="0"/>
         <element name="parameter" type="{}parameterData" maxOccurs="unbounded" minOccurs="0"/>
         <element name="preferences" type="{}preferencesData" maxOccurs="unbounded" minOccurs="0"/>
         <element name="access-control" type="{}accessControlData" minOccurs="0"/>
       </sequence>
       <attGroup ref="{}defaultResourceAttr"/>
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute ref="{}active"/>
       <attribute name="provided" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="handle" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="defaultlocale" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="servletref" type="{}referenceType" />
       <attribute name="remote-cache-scope-private" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="cache-expiration" type="{http://www.w3.org/2001/XMLSchema}string" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessControlData	accessControl
protected AllActions	action
protected java.lang.Boolean	active
protected java.lang.String	cacheExpiration
protected java.lang.String	defaultlocale
protected java.lang.String	domain
protected java.lang.String	handle
protected java.util.List<LocaleData>	localedata
protected java.lang.String	name
protected java.lang.String	objectid
protected java.util.List<ParameterData>	parameter
protected java.util.List<PreferencesData>	preferences
protected java.lang.Boolean	provided
protected java.lang.Boolean	remoteCacheScopePrivate
protected java.lang.String	servletref
protected java.lang.String	uniquename

Constructor Summary

Constructors

Constructor and Description
PortletItem()

Method Summary

Methods

Modifier and Type	Method and Description
AccessControlData	getAccessControl() Gets the value of the accessControl property.
AllActions	getAction() Gets the value of the action property.
java.lang.String	getCacheExpiration() Gets the value of the cacheExpiration property.
java.lang.String	getDefaultlocale() Gets the value of the defaultlocale property.
java.lang.String	getDomain() Gets the value of the domain property.
java.lang.String	getHandle() Gets the value of the handle property.
java.util.List<LocaleData>	getLocaledata() Gets the value of the localedata property.
java.lang.String	getName() Gets the value of the name property.
java.lang.String	getObjectid() Gets the value of the objectid property.
java.util.List<ParameterData>	getParameter() Gets the value of the parameter property.
java.util.List<PreferencesData>	getPreferences() Gets the value of the preferences property.
java.lang.String	getServletref() Gets the value of the servletref property.
java.lang.String	getUniquename() Gets the value of the uniquename property.
java.lang.Boolean	isActive() If the portlet is not active, it cannot be accessed.
java.lang.Boolean	isProvided() Gets the value of the provided property.
java.lang.Boolean	isRemoteCacheScopePrivate() Gets the value of the remoteCacheScopePrivate property.
void	setAccessControl(AccessControlData value) Sets the value of the accessControl property.
void	setAction(AllActions value) Sets the value of the action property.
void	setActive(java.lang.Boolean value) Sets the value of the active property.
void	setCacheExpiration(java.lang.String value) Sets the value of the cacheExpiration property.
void	setDefaultlocale(java.lang.String value) Sets the value of the defaultlocale property.
void	setDomain(java.lang.String value) Sets the value of the domain property.
void	setHandle(java.lang.String value) Sets the value of the handle property.
void	setName(java.lang.String value) Sets the value of the name property.
void	setObjectid(java.lang.String value) Sets the value of the objectid property.
void	setProvided(java.lang.Boolean value) Sets the value of the provided property.
void	setRemoteCacheScopePrivate(java.lang.Boolean value) Sets the value of the remoteCacheScopePrivate property.
void	setServletref(java.lang.String value) Sets the value of the servletref property.
void	setUniquename(java.lang.String value) Sets the value of the uniquename property.

Methods inherited from class java.lang.Object

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

Field Detail

localedata

protected java.util.List<LocaleData> localedata

parameter

protected java.util.List<ParameterData> parameter

preferences

protected java.util.List<PreferencesData> preferences

accessControl

protected AccessControlData accessControl

name

protected java.lang.String name

active

protected java.lang.Boolean active

provided

protected java.lang.Boolean provided

handle

protected java.lang.String handle

defaultlocale

protected java.lang.String defaultlocale

servletref

protected java.lang.String servletref

remoteCacheScopePrivate

protected java.lang.Boolean remoteCacheScopePrivate

cacheExpiration

protected java.lang.String cacheExpiration

action

protected AllActions action

objectid

protected java.lang.String objectid

uniquename

protected java.lang.String uniquename

domain

protected java.lang.String domain

Constructor Detail

PortletItem

public PortletItem()

Method Detail

getLocaledata

public java.util.List<LocaleData> getLocaledata()

Gets the value of the localedata property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the localedata property.

For example, to add a new item, do as follows:

    getLocaledata().add(newItem);
 

Objects of the following type(s) are allowed in the list LocaleData

getParameter

public java.util.List<ParameterData> getParameter()

Gets the value of the parameter property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the parameter property.

For example, to add a new item, do as follows:

    getParameter().add(newItem);
 

Objects of the following type(s) are allowed in the list ParameterData

getPreferences

public java.util.List<PreferencesData> getPreferences()

Gets the value of the preferences property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the preferences property.

For example, to add a new item, do as follows:

    getPreferences().add(newItem);
 

Objects of the following type(s) are allowed in the list PreferencesData

getAccessControl

public AccessControlData getAccessControl()

Gets the value of the accessControl property.

Returns:

possible object is AccessControlData

setAccessControl

public void setAccessControl(AccessControlData value)

Sets the value of the accessControl property.

Parameters:

value - allowed object is AccessControlData

getName

public java.lang.String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public void setName(java.lang.String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

isActive

public java.lang.Boolean isActive()

If the portlet is not active, it cannot be accessed.

Returns:

possible object is Boolean

setActive

public void setActive(java.lang.Boolean value)

Sets the value of the active property.

Parameters:

value - allowed object is Boolean

isProvided

public java.lang.Boolean isProvided()

Gets the value of the provided property.

Returns:

possible object is Boolean

setProvided

public void setProvided(java.lang.Boolean value)

Sets the value of the provided property.

Parameters:

value - allowed object is Boolean

getHandle

public java.lang.String getHandle()

Gets the value of the handle property.

Returns:

possible object is String

setHandle

public void setHandle(java.lang.String value)

Sets the value of the handle property.

Parameters:

value - allowed object is String

getDefaultlocale

public java.lang.String getDefaultlocale()

Gets the value of the defaultlocale property.

Returns:

possible object is String

setDefaultlocale

public void setDefaultlocale(java.lang.String value)

Sets the value of the defaultlocale property.

Parameters:

value - allowed object is String

getServletref

public java.lang.String getServletref()

Gets the value of the servletref property.

Returns:

possible object is String

setServletref

public void setServletref(java.lang.String value)

Sets the value of the servletref property.

Parameters:

value - allowed object is String

isRemoteCacheScopePrivate

public java.lang.Boolean isRemoteCacheScopePrivate()

Gets the value of the remoteCacheScopePrivate property.

Returns:

possible object is Boolean

setRemoteCacheScopePrivate

public void setRemoteCacheScopePrivate(java.lang.Boolean value)

Sets the value of the remoteCacheScopePrivate property.

Parameters:

value - allowed object is Boolean

getCacheExpiration

public java.lang.String getCacheExpiration()

Gets the value of the cacheExpiration property.

Returns:

possible object is String

setCacheExpiration

public void setCacheExpiration(java.lang.String value)

Sets the value of the cacheExpiration property.

Parameters:

value - allowed object is String

getAction

public AllActions getAction()

Gets the value of the action property.

Returns:

possible object is AllActions

setAction

public void setAction(AllActions value)

Sets the value of the action property.

Parameters:

value - allowed object is AllActions

getObjectid

public java.lang.String getObjectid()

Gets the value of the objectid property.

Returns:

possible object is String

setObjectid

public void setObjectid(java.lang.String value)

Sets the value of the objectid property.

Parameters:

value - allowed object is String

getUniquename

public java.lang.String getUniquename()

Gets the value of the uniquename property.

Returns:

possible object is String

setUniquename

public void setUniquename(java.lang.String value)

Sets the value of the uniquename property.

Parameters:

value - allowed object is String

getDomain

public java.lang.String getDomain()

Gets the value of the domain property.

Returns:

possible object is String

setDomain

public void setDomain(java.lang.String value)

Sets the value of the domain property.

Parameters:

value - allowed object is String