propertybrokerservice.html

门户开发

                   <A HREF="../../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;settings,
                   <A HREF="../../../../../com/ibm/wps/pb/property/Property.html" title="interface in com.ibm.wps.pb.property">Property</A>[]&nbsp;properties)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Registers the properties which are produced or consumed by the
 portlet.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html#unregisterActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)">unregisterActions</A></B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                  <A HREF="../../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;portletSettings)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unregisters all previously registered actions for the specified
 portlet.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html#unregisterProperties(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)">unregisterProperties</A></B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                     <A HREF="../../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;settings)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Unregisters all properties which are currently registered on
 behalf of the portlet.</TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->


<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="registerProperties(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings, com.ibm.wps.pb.property.Property[])"><!-- --></A><H3>
registerProperties</H3>
<PRE>
public void <B>registerProperties</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                               <A HREF="../../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;settings,
                               <A HREF="../../../../../com/ibm/wps/pb/property/Property.html" title="interface in com.ibm.wps.pb.property">Property</A>[]&nbsp;properties)
                        throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A>,
                               <A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></PRE>
<DL>
<DD>Registers the properties which are produced or consumed by the
 portlet. Each property must have a unique name.
 If the portlet provides a WSDL file, properties will be automatically
 registered, and this method need not be invoked. If actions are registered programmatically
 using <code>registerActions</code>, the associated properties 
 will be automatically registered also.
 This method need only be called to register properties which are not associated with
 actions, i.e. by portlets implementing <code>PropertyListener</code>. 
 This call needs to be made
 once only after the portlet is installed, the property set is then
 stored persistently for the portlet. Subsequent calls will update and/or
 add to the existing property set.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for current portlet request<DD><CODE>settings</CODE> - the <code>PortletSettings</code> object identifying the calling portlet<DD><CODE>properties</CODE> - an array of <code>Property</code> objects
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></CODE> - is thrown for general problems encountered
 in registering the properties.
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></CODE> - is thrown if any property is invalid e.g. is missing
 a required field.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Property.html" title="interface in com.ibm.wps.pb.property"><CODE>Property</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="unregisterProperties(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
unregisterProperties</H3>
<PRE>
public void <B>unregisterProperties</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                                 <A HREF="../../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;settings)
                          throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD>Unregisters all properties which are currently registered on
 behalf of the portlet. Properties are automatically unregistered by the Property Broker
 when the portlet is uninstalled, so this method rarely needs to be invoked explicitly
 by the portlet.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for the current portlet request<DD><CODE>settings</CODE> - the <code>PortletSettings</code> object identifying the calling portlet
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></CODE> - is thrown if any problem is encountered</DL>
</DD>
</DL>
<HR>

<A NAME="registerActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings, com.ibm.wps.pb.property.Action[])"><!-- --></A><H3>
registerActions</H3>
<PRE>
public void <B>registerActions</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                            <A HREF="../../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;portletSettings,
                            <A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property">Action</A>[]&nbsp;actions)
                     throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD>Registers an array of <code>Actions</code> for a given portlet with the
 <code>PropertyBrokerService</code>. Each action must have a unique name.
 The registration happens automatically
 when the portlet is initialized, if a WSDL file describing
 the actions has been provided. The actions are made available for invocation
 using Click-to-Action and as the target of wires from other portlets. 
 Any properties associated with the actions which have not been
 registered earlier are automatically registered. Any actions registered
 earlier will be removed. Actions registered once are stored persistently
 as long as the portlet remains installed in the portal; hence, a check should
 be made if actions have already been registered using the <code>getAllActions</code> method
 before invoking this method.
 Actions registered are applicable for all instances of the calling portlet on all pages.
 So this call should usually be made very early in a portlet's lifecycle.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object identifying the current portlet
 request<DD><CODE>portletSettings</CODE> - the <code>PortletSettings</code> object identifying the
 calling portlet<DD><CODE>actions</CODE> - the array of supported actions.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></CODE> - is thrown if the registration
 failed for any reason.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property"><CODE>Action</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html#getAllActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)"><CODE>getAllActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="unregisterActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
unregisterActions</H3>
<PRE>
public void <B>unregisterActions</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                              <A HREF="../../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;portletSettings)
                       throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD>Unregisters all previously registered actions for the specified
 portlet. The actions are removed for all instances of the portlet on all pages.
 All properties associated with the actions are
 automatically unregistered. This method is automatically invoked when the 
 portlet is uninstalled from the portal. Rarely should a portlet need
 to invoke this method.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object identifying the current portlet
 request<DD><CODE>portletSettings</CODE> - the <code>PortletSettings</code> object identifying the
 calling portlet
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></CODE> - is thrown if any problem is encountered</DL>
</DD>
</DL>
<HR>

<A NAME="changedProperties(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletConfig, com.ibm.wps.pb.property.PropertyValue[])"><!-- --></A><H3>