|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.wsrp.consumer.management.portlet.ProxyPortletInfo
public class ProxyPortletInfo
Proxy portlet metadata.
Constructor Summary | |
---|---|
ProxyPortletInfo(String producerHandle,
String portletHandle,
byte stateChangeFlag,
boolean requiresUrlTemplates,
boolean templatesStoredInSession,
int proxyPortletId,
byte[] portletState,
String deleteErrorCause,
boolean producerOfferedPortlet)
Creates an instance. |
|
ProxyPortletInfo(String producerHandle,
String portletHandle,
byte stateChangeFlag,
boolean requiresUrlTemplates,
boolean templatesStoredInSession,
int proxyPortletId,
byte[] portletState,
String deleteErrorCause,
boolean producerOfferedPortlet,
boolean producerRemovable)
Creates an instance. |
Method Summary | |
---|---|
String |
getDeleteErrorCause()
Returns any error cause set if the consumer tries to destroy the portlet and the attempt failed. |
String |
getPortletHandle()
Returns the portlet handle. |
byte[] |
getPortletState()
Returns the optional binary portlet state. |
String |
getProducerHandle()
Returns producer handle. |
int |
getProxyPortletId()
Returns the unique ID used to store this proxy portlet in the database. |
byte |
getStateChangeFlag()
Returns portlet state change flag. |
boolean |
isProducerOfferedPortlet()
Returns whether this portlet is producer offered or consumer created. |
boolean |
isProducerRemovable()
Is it safe to call removePortlets on portletHandle Will only return true when this is returned from getRemovableProxyPortlets |
boolean |
isRequiresUrlTemplates()
Returns whether the portlet requires URL templates. |
boolean |
isTemplatesStoredInSession()
Returns whether the portlet stores URL templates in the session. |
void |
setDeleteErrorCause(String deleteErrorCause)
Sets error cause set if the consumer tries to destroy the portlet and the attempt failed. |
void |
setPortletHandle(String portletHandle)
Sets the portlet handle. |
void |
setPortletState(byte[] portletState)
Sets the binary porltet state. |
void |
setProducerHandle(String producerHandle)
Sets producer handle. |
void |
setProducerOfferedPortlet(boolean producerOfferedPortlet)
Sets whether this portlet is producer offered or consumer created. |
void |
setProxyPortletId(int proxyPortletId)
Sets the unique ID used to store this proxy portlet in the database. |
void |
setRequiresUrlTemplates(boolean requiresUrlTemplates)
Sets whether the portlet requires URL templates. |
void |
setStateChangeFlag(byte stateChangeFlag)
Sets portlet state change flag. |
void |
setTemplatesStoredInSession(boolean templatesStoredInSession)
Sets whether the portlet stores URL templates in the session. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ProxyPortletInfo(String producerHandle, String portletHandle, byte stateChangeFlag, boolean requiresUrlTemplates, boolean templatesStoredInSession, int proxyPortletId, byte[] portletState, String deleteErrorCause, boolean producerOfferedPortlet)
Creates an instance. With producerRemovable = false
producerHandle
- producer handleportletHandle
- portlet handlestateChangeFlag
- state change flagrequiresUrlTemplates
- requires templatestemplatesStoredInSession
- templates stored in HTTP sessionproxyPortletId
- proxy portlet IDportletState
- optional binary portlet statedeleteErrorCause
- delete error causeproducerOfferedPortlet
- producer offered or consumer configuredpublic ProxyPortletInfo(String producerHandle, String portletHandle, byte stateChangeFlag, boolean requiresUrlTemplates, boolean templatesStoredInSession, int proxyPortletId, byte[] portletState, String deleteErrorCause, boolean producerOfferedPortlet, boolean producerRemovable)
Creates an instance.
producerHandle
- producer handleportletHandle
- portlet handlestateChangeFlag
- state change flagrequiresUrlTemplates
- requires templatestemplatesStoredInSession
- templates stored in HTTP sessionproxyPortletId
- proxy portlet IDportletState
- optional binary portlet statedeleteErrorCause
- delete error causeproducerOfferedPortlet
- producer offered or consumer configuredproducerRemovable
- whether removePortlets may safely be called on this handleMethod Detail |
---|
public String getProducerHandle()
Returns producer handle.
public void setProducerHandle(String producerHandle)
Sets producer handle.
producerHandle
- producer handlepublic String getPortletHandle()
Returns the portlet handle.
public void setPortletHandle(String portletHandle)
Sets the portlet handle.
portletHandle
- portlet handlepublic byte getStateChangeFlag()
Returns portlet state change flag.
public void setStateChangeFlag(byte stateChangeFlag)
Sets portlet state change flag.
stateChangeFlag
- state change flagpublic boolean isRequiresUrlTemplates()
Returns whether the portlet requires URL templates.
public void setRequiresUrlTemplates(boolean requiresUrlTemplates)
Sets whether the portlet requires URL templates.
requiresUrlTemplates
- booleanpublic boolean isTemplatesStoredInSession()
Returns whether the portlet stores URL templates in the session.
public void setTemplatesStoredInSession(boolean templatesStoredInSession)
Sets whether the portlet stores URL templates in the session.
templatesStoredInSession
- booleanpublic int getProxyPortletId()
Returns the unique ID used to store this proxy portlet in the database.
public void setProxyPortletId(int proxyPortletId)
Sets the unique ID used to store this proxy portlet in the database.
proxyPortletId
- idpublic byte[] getPortletState()
Returns the optional binary portlet state. Some producers may return this during state updates
public void setPortletState(byte[] portletState)
Sets the binary porltet state.
portletState
- statepublic String getDeleteErrorCause()
Returns any error cause set if the consumer tries to destroy the portlet and the attempt failed.
public void setDeleteErrorCause(String deleteErrorCause)
Sets error cause set if the consumer tries to destroy the portlet and the attempt failed.
deleteErrorCause
- error causepublic boolean isProducerOfferedPortlet()
Returns whether this portlet is producer offered or consumer created.
public void setProducerOfferedPortlet(boolean producerOfferedPortlet)
Sets whether this portlet is producer offered or consumer created.
producerOfferedPortlet
- booleanpublic boolean isProducerRemovable()
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |