com.arsdigita.portal
Class PortletSetup

java.lang.Object
  extended bycom.arsdigita.portal.PortletSetup
Direct Known Subclasses:
AppPortletSetup

public class PortletSetup
extends Object

This class is a convenience class for easily initializing a Portlet.

The usage pattern for this class is:

Necessary values that are uninitialized when run() is called throw an exception.

Version:
$Id: //core-platform/dev/src/com/arsdigita/portal/PortletSetup.java#11 $
Author:
Justin Ross

Field Summary
protected  org.apache.log4j.Category m_category
           
protected  String m_description
           
protected  DomainObjectInstantiator m_instantiator
           
protected  String m_key
           
protected  String m_profile
           
protected  ApplicationType m_provider
           
protected  String m_stylesheet
           
protected  String m_title
           
protected  String m_typeName
           
static String versionId
           
 
Constructor Summary
PortletSetup(org.apache.log4j.Category category)
           
 
Method Summary
protected  void notice(String message)
           
protected  PortletType process()
           
 PortletType run()
           
 void setDescription(String description)
           
 void setInstantiator(DomainObjectInstantiator instantiator)
           
 void setKey(String key)
           
 void setPortletObjectType(String portletObjectType)
           
 void setProfile(String profile)
           
 void setProviderApplicationType(ApplicationType provider)
           
 void setProviderApplicationType(String applicationObjectType)
           
 void setStylesheet(String stylesheet)
           
 void setTitle(String title)
           
protected  List validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values

m_profile

protected String m_profile

m_key

protected String m_key

m_typeName

protected String m_typeName

m_category

protected org.apache.log4j.Category m_category

m_title

protected String m_title

m_description

protected String m_description

m_provider

protected ApplicationType m_provider

m_stylesheet

protected String m_stylesheet

m_instantiator

protected DomainObjectInstantiator m_instantiator
Constructor Detail

PortletSetup

public PortletSetup(org.apache.log4j.Category category)
Method Detail

setPortletObjectType

public void setPortletObjectType(String portletObjectType)

setProfile

public void setProfile(String profile)

setKey

public void setKey(String key)

setTitle

public void setTitle(String title)

setDescription

public void setDescription(String description)

setStylesheet

public void setStylesheet(String stylesheet)

setInstantiator

public void setInstantiator(DomainObjectInstantiator instantiator)

setProviderApplicationType

public void setProviderApplicationType(ApplicationType provider)

setProviderApplicationType

public void setProviderApplicationType(String applicationObjectType)

notice

protected void notice(String message)

run

public PortletType run()

validate

protected List validate()

process

protected PortletType process()


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC