propertybrokerservice.html

门户开发

<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object<DD><CODE>response</CODE> - the <code>PortletResponse</code> object<DD><CODE>properties</CODE> - an array of <code>PropertyValue</code> containing the
 descriptions and values of the properties to be passed to the actions<DD><CODE>caption</CODE> - the string which will be used to visually identify to the user
 the actions which will be taken.<DD><CODE>description</CODE> - a descriptive string expanding on the caption
<DT><B>Returns:</B><DD>the string containing the markup to for displaying the visual control
<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<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/ActionTriggerMarkup.html" title="interface in com.ibm.wps.pb.property"><CODE>ActionTriggerMarkup</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html#generateActionTriggerControl(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse, com.ibm.wps.pb.property.PropertyValue[], java.lang.String, java.lang.String)"><CODE>generateActionTriggerControl(PortletRequest, PortletResponse,PropertyValue[], String, String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getAllProperties(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
getAllProperties</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/pb/property/Property.html" title="interface in com.ibm.wps.pb.property">Property</A>[] <B>getAllProperties</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>Returns all the properties registered by the calling portlet.
 This method may be invoked to determine if properties were registered earlier.
 Usually, since properties are registered persistently, they need to be registered
 once only, and if this method returns a non-empty array, it means registration is
 not required. Invoking this method to check if properties are registered has less of a performance impact
 than invoking <code>registerProperties</code> multiple
 times.
<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 for the calling portlet
<DT><B>Returns:</B><DD>an array of <code>Property</code> objects which are registered for this 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<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html#registerProperties(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings, com.ibm.wps.pb.property.Property[])"><CODE>registerProperties(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings, com.ibm.wps.pb.property.Property[])</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getProperties(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
getProperties</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/pb/property/Property.html" title="interface in com.ibm.wps.pb.property">Property</A>[] <B>getProperties</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><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use <code>getAllProperties</code> instead.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<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><DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html#getAllProperties(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)"><CODE>getAllProperties(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getActiveActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
getActiveActions</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property">Action</A>[] <B>getActiveActions</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>Returns an array of <code>Action</code> objects which are registered for this portlet and
 are currently active. Active actions are ones that will appear in the Click-to-Action
 menus and will be triggered when wires to the actions are activated.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for the current request<DD><CODE>settings</CODE> - the <code>PortletSettings</code> object for the calling portlet
<DT><B>Returns:</B><DD>an array of <code>Action</code> objects which are registered for this portlet and
 are currently active
<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="getActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
getActions</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property">Action</A>[] <B>getActions</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><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use <code>getActiveActions</code> instead.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<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><DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html#getActiveActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)"><CODE>getActiveActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getAllActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
getAllActions</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/pb/property/Action.html" title="interface in com.ibm.wps.pb.property">Action</A>[] <B>getAllActions</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>Returns all the actions (active or inactive) registered by the calling portlet.
 The method may be invoked to determine if actions were registered earlier.
 Usually, since actions are registered persistently, they need to be registered
 once only, and if this method returns a non-empty array, it means registration is
 not required. Invoking this method to check if actions are registered has a
 lower performance overhead than invoking 
 <code>registerActions</code> multiple
 times.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for the current request<DD><CODE>settings</CODE> - the <code>PortletSettings</code> object for the calling portlet
<DT><B>Returns:</B><DD>an array of <code>Action</code> objects which are registered for this portlet 
 whether they are currently active or not
<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<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html#registerActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings, com.ibm.wps.pb.property.Action[])"><CODE>registerActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings, com.ibm.wps.pb.property.Action[])</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="activateActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings, java.lang.String[])"><!-- --></A><H3>
activateActions</H3>
<PRE>
public void <B>activateActions</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,
                            java.lang.String[]&nbsp;actionNames)
                     throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD>Actions which are not automatically activated upon portlet startup
 are activated explicitly using this call. This activates the actions
 for the current session. If any of the specified actions is already active,
 its state is not affected by this call.
<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<DD><CODE>actionNames</CODE> - the names of the actions to be activated
<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="deactivateActions(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletSettings, java.lang.String[])"><!-- --></A><H3>
deactivateActions</H3>
<PRE>
public void <B>deactivateActions</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,
                              java.lang.String[]&nbsp;actionNames)
                       throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD>Actions which are active for the session
 are deactivated using this call. This deactivates the actions
 for the current session. If any of the specified actions is already inactive