ProxyPortletInfo Class

com.bea.wsrp.consumer.management.portlet
ProxyPortletInfo Class

public class ProxyPortletInfo

    extends Object
    implements Serializable

Proxy portlet metadata.


Hierarchy
Object
  ProxyPortletInfo
All Implemented Interfaces

Serializable

Constructor Summary

ProxyPortletInfo(String producerHandle, String portletHandle, byte stateChangeFlag, boolean requiresUrlTemplates, boolean templatesStoredInSession, int proxyPortletId, byte portletState, String deleteErrorCause, boolean producerOfferedPortlet)

Creates an instance.

 

Method Summary

public String
getDeleteErrorCause()

Returns any error cause set if the consumer tries to destroy the portlet and the attempt failed.

public String
getPortletHandle()

Returns the portlet handle.

public byte[]
getPortletState()

Returns the optional binary portlet state.

public String
getProducerHandle()

Returns producer handle.

public int
getProxyPortletId()

Returns the unique ID used to store this proxy portlet in the database.

public byte
getStateChangeFlag()

Returns portlet state change flag.

public boolean
isProducerOfferedPortlet()

Returns whether this portlet is producer offered or consumer created.

public boolean
isRequiresUrlTemplates()

Returns whether the portlet requires URL templates.

public boolean
isTemplatesStoredInSession()

Returns whether the portlet stores URL templates in the session.

public void
setDeleteErrorCause(String deleteErrorCause)

Sets error cause set if the consumer tries to destroy the portlet and the attempt failed.

public void
setPortletHandle(String portletHandle)

Sets the portlet handle.

public void
setPortletState(byte[] portletState)

Sets the binary porltet state.

public void
setProducerHandle(String producerHandle)

Sets producer handle.

public void
setProducerOfferedPortlet(boolean producerOfferedPortlet)

Sets whether this portlet is producer offered or consumer created.

public void
setProxyPortletId(int proxyPortletId)

Sets the unique ID used to store this proxy portlet in the database.

public void
setRequiresUrlTemplates(boolean requiresUrlTemplates)

Sets whether the portlet requires URL templates.

public void
setStateChangeFlag(byte stateChangeFlag)

Sets portlet state change flag.

public void
setTemplatesStoredInSession(boolean templatesStoredInSession)

Sets whether the portlet stores URL templates in the session.

 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail

ProxyPortletInfo

public ProxyPortletInfo(String producerHandle, 
                        String portletHandle, 
                        byte stateChangeFlag, 
                        boolean requiresUrlTemplates, 
                        boolean templatesStoredInSession, 
                        int proxyPortletId, 
                        byte[] portletState, 
                        String deleteErrorCause, 
                        boolean producerOfferedPortlet)

Creates an instance.

* * @param producerHandle producer handle * @param portletHandle portlet handle * @param stateChangeFlag state change flag * @param requiresUrlTemplates requires templates * @param templatesStoredInSession templates stored in HTTP session * @param proxyPortletId proxy portlet ID * @param portletState optional binary portlet state * @param deleteErrorCause delete error cause * @param producerOfferedPortlet producer offered or consumer configured
 

Method Detail

getDeleteErrorCause() Method

public String getDeleteErrorCause()

Returns any error cause set if the consumer tries to destroy the portlet and the attempt failed.

* * @return error cause


getPortletHandle() Method

public String getPortletHandle()

Returns the portlet handle.

* * @return portlet handle


getPortletState() Method

public byte[] getPortletState()

Returns the optional binary portlet state. Some producers may return this during state updates

* * @return state


getProducerHandle() Method

public String getProducerHandle()

Returns producer handle.

* * @return producer handle


getProxyPortletId() Method

public int getProxyPortletId()

Returns the unique ID used to store this proxy portlet in the database.

* * @return id


getStateChangeFlag() Method

public byte getStateChangeFlag()

Returns portlet state change flag.

* * @return state change flag


isProducerOfferedPortlet() Method

public boolean isProducerOfferedPortlet()

Returns whether this portlet is producer offered or consumer created.

* * @return boolean


isRequiresUrlTemplates() Method

public boolean isRequiresUrlTemplates()

Returns whether the portlet requires URL templates.

* * @return boolean


isTemplatesStoredInSession() Method

public boolean isTemplatesStoredInSession()

Returns whether the portlet stores URL templates in the session.

* * @return boolean


setDeleteErrorCause(String) Method

public void setDeleteErrorCause(String deleteErrorCause)

Sets error cause set if the consumer tries to destroy the portlet and the attempt failed.

* * @param deleteErrorCause error cause


setPortletHandle(String) Method

public void setPortletHandle(String portletHandle)

Sets the portlet handle.

* * @param portletHandle portlet handle


setPortletState(byte[]) Method

public void setPortletState(byte[] portletState)

Sets the binary porltet state.

* * @param portletState state


setProducerHandle(String) Method

public void setProducerHandle(String producerHandle)

Sets producer handle.

* * @param producerHandle producer handle


setProducerOfferedPortlet(boolean) Method

public void setProducerOfferedPortlet(boolean producerOfferedPortlet)

Sets whether this portlet is producer offered or consumer created.

* * @param producerOfferedPortlet boolean


setProxyPortletId(int) Method

public void setProxyPortletId(int proxyPortletId)

Sets the unique ID used to store this proxy portlet in the database.

* * @param proxyPortletId id


setRequiresUrlTemplates(boolean) Method

public void setRequiresUrlTemplates(boolean requiresUrlTemplates)

Sets whether the portlet requires URL templates.

* * @param requiresUrlTemplates boolean


setStateChangeFlag(byte) Method

public void setStateChangeFlag(byte stateChangeFlag)

Sets portlet state change flag.

* * @param stateChangeFlag state change flag


setTemplatesStoredInSession(boolean) Method

public void setTemplatesStoredInSession(boolean templatesStoredInSession)

Sets whether the portlet stores URL templates in the session.

* * @param templatesStoredInSession boolean