org.apache.jetspeed.om.common.portlet
Interface MutablePortletApplication

All Superinterfaces:

org.apache.pluto.om.Model, PortletApplication, org.apache.pluto.om.portlet.PortletApplicationDefinition, Serializable

public interface MutablePortletApplication

extends PortletApplication, Serializable

MutablePortletApplication Extends the org.apache.pluto.om.portlet.PortletApplicationDefinition interface adding mutator methods for those attributes that do not have them so as to make manipulating the portlet OM easier.

Version:

$Id: MutablePortletApplication.java 187635 2004-09-29 20:31:35Z jford $

Author:

David Sean Taylor, Scott T. Weaver

Field Summary

static int	LOCAL Marks this application as a LOCAL portlet application, stored in Jetspeed managed portlet application space.
static String	PREFS_ROOT
static int	WEBAPP Marks this application as a standard web application, stored in the web application server's web application space.

Method Summary

void	addJetspeedService(JetspeedServiceReference service) Adds a Jetspeed component service to the collection of component services allowed for this application.
void	addPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition pd)
void	addUserAttribute(String name, String description) Adds a user attribute to the user attribute set.
void	addUserAttribute(UserAttribute userAttribute) Adds a user attribute to the user attribute set.
void	addUserAttributeRef(UserAttributeRef userAttributeRef) Adds a user attribute ref to the user attribute ref set.
long	getChecksum() The checksum on the portlet XML from the last deployment
void	setApplicationIdentifier(String applicationIndentifier)
void	setApplicationType(int type) Sets the Portlet Application type.
void	setChecksum(long checksum) The checksum on the portlet XML from the last deployment
void	setDescription(String string)
void	setId(String objectID)
void	setMetadata(GenericMetadata metadata) Sets the metadata from the extended jetspeed-portlet.xml
void	setName(String name)
void	setPortletDefinitionList(org.apache.pluto.om.portlet.PortletDefinitionList portlets)
void	setUserAttributeRefs(Collection userAttributeRefs) Sets a user-attribute-ref to the collection of user attribute refs associated with this portlet application.
void	setUserAttributes(Collection userAttributes) Sets a user-attribute to the collection of user attributes associated with this portlet application.
void	setVersion(String version)
void	setWebApplicationDefinition(org.apache.pluto.om.servlet.WebApplicationDefinition wad) Associates the web application definition with this portlet application defintion.

Methods inherited from interface org.apache.jetspeed.om.common.portlet.PortletApplication

getApplicationIdentifier, getApplicationType, getDescription, getJetspeedServices, getMetadata, getName, getPortletDefinitionByName, getPortletDefinitions, getUserAttributeRefs, getUserAttributes

Methods inherited from interface org.apache.pluto.om.portlet.PortletApplicationDefinition

getId, getPortletDefinitionList, getVersion, getWebApplicationDefinition

Field Detail

PREFS_ROOT

public static final String PREFS_ROOT

See Also:

Constant Field Values

WEBAPP

public static final int WEBAPP

Marks this application as a standard web application, stored in the web application server's web application space.

See Also:

Constant Field Values

LOCAL

public static final int LOCAL

Marks this application as a LOCAL portlet application, stored in Jetspeed managed portlet application space.

See Also:

Constant Field Values

Method Detail

setMetadata

public void setMetadata(GenericMetadata metadata)

Sets the metadata from the extended jetspeed-portlet.xml

Parameters:

metadata -

setWebApplicationDefinition

public void setWebApplicationDefinition(org.apache.pluto.om.servlet.WebApplicationDefinition wad)

Associates the web application definition with this portlet application defintion.

Parameters:

wad -

setName

public void setName(String name)

Parameters:

name -

addPortletDefinition

public void addPortletDefinition(org.apache.pluto.om.portlet.PortletDefinition pd)

Parameters:

pd -

setPortletDefinitionList

public void setPortletDefinitionList(org.apache.pluto.om.portlet.PortletDefinitionList portlets)

Parameters:

portlets -

addUserAttribute

public void addUserAttribute(UserAttribute userAttribute)

Adds a user attribute to the user attribute set.

Parameters:

userAttribute - The user attribute.

addUserAttribute

public void addUserAttribute(String name,
                             String description)

Adds a user attribute to the user attribute set.

setUserAttributeRefs

public void setUserAttributeRefs(Collection userAttributeRefs)

Sets a user-attribute-ref to the collection of user attribute refs associated with this portlet application.

addUserAttributeRef

public void addUserAttributeRef(UserAttributeRef userAttributeRef)

Adds a user attribute ref to the user attribute ref set.

Parameters:

userAttributeRef - The user attribute ref.

setUserAttributes

public void setUserAttributes(Collection userAttributes)

Sets a user-attribute to the collection of user attributes associated with this portlet application.

setApplicationIdentifier

public void setApplicationIdentifier(String applicationIndentifier)

setDescription

public void setDescription(String string)

Parameters:

string -

setId

public void setId(String objectID)

Parameters:

objectID -

setVersion

public void setVersion(String version)

Parameters:

version -

setApplicationType

public void setApplicationType(int type)

Sets the Portlet Application type. Valid values are:

WEBAPP - A standard web application, stored in the web application server's web application space.

LOCAL - A local portlet application stored within Jetspeed's web application.

Parameters:

type - The type of portlet application.

addJetspeedService

public void addJetspeedService(JetspeedServiceReference service)

Adds a Jetspeed component service to the collection of component services allowed for this application.

Parameters:

service - The component service being added.

setChecksum

public void setChecksum(long checksum)

The checksum on the portlet XML from the last deployment

Parameters:

checksum -

getChecksum

public long getChecksum()

The checksum on the portlet XML from the last deployment

Returns: