propertybrokerservice.html

门户开发

<!-- ============ 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="activateAction(javax.portlet.PortletConfig, javax.portlet.ActionRequest, java.lang.String)"><!-- --></A><H3>
activateAction</H3>
<PRE>
public void <B>activateAction</B>(javax.portlet.PortletConfig&nbsp;config,
                           javax.portlet.ActionRequest&nbsp;request,
                           java.lang.String&nbsp;actionName)
                    throws <A HREF="../../../../../com/ibm/portal/propertybroker/service/ActivationFailedException.html" title="class in com.ibm.portal.propertybroker.service">ActivationFailedException</A></PRE>
<DL>
<DD>An Action which has been deactivated 
 is activated explicitly using this call. This activates the action
 for the current session. If the action is already active, this call is a no-op.
 Actions are initially active by default; however, actions may be specified to be 
 initially inactive by specifying a value of <code>false</code> for the 
 <code>activeOnStartup</code> attribute for the action element in the WSDL file.
 Inactive actions may be activated for specific sessions by invoking this method.
 Inactive actions which are targets of wires are not invoked even if the wire is triggered
 by the source portlet.
 <p>
 This call may only be invoked during the action phase of the portlet.
 <p>
 Refer to the WebSphere Portal InfoCenter for documentation on WSDL syntax and the 
 <code>activeOnStartup</code> flag .
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - the <code>PortletConfig</code> object<DD><CODE>request</CODE> - the <code>ActionRequest</code> object<DD><CODE>actionName</CODE> - the name of the action to be activated
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/portal/propertybroker/service/ActivationFailedException.html" title="class in com.ibm.portal.propertybroker.service">ActivationFailedException</A></CODE> - is thrown if any problem is encountered<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/portal/propertybroker/service/PropertyBrokerService.html#deactivateAction(javax.portlet.PortletConfig, javax.portlet.ActionRequest, java.lang.String)"><CODE>deactivateAction(PortletConfig, ActionRequest, String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="deactivateAction(javax.portlet.PortletConfig, javax.portlet.ActionRequest, java.lang.String)"><!-- --></A><H3>
deactivateAction</H3>
<PRE>
public void <B>deactivateAction</B>(javax.portlet.PortletConfig&nbsp;config,
                             javax.portlet.ActionRequest&nbsp;request,
                             java.lang.String&nbsp;actionName)
                      throws <A HREF="../../../../../com/ibm/portal/propertybroker/service/DeactivationFailedException.html" title="class in com.ibm.portal.propertybroker.service">DeactivationFailedException</A></PRE>
<DL>
<DD>An Action which is active for the session
 is deactivated using this call. If the action is already inactive, the invocation
 is a no-op. This deactivates the action
 for the current session. If actions are inactive, they will not
 be invoked as a result of wires being activated in
 the current session. Actions are initially active by default, or may explicitly
 be specified to be initially inactive through a setting in the WSDL file, and be activated
 in the current session by invoking the <code>activateAction</code> method.
 <p>
 This call may only be invoked during the action phase of the portlet.
 <p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - the <code>PortletConfig</code> object<DD><CODE>request</CODE> - the <code>ActionRequest</code> object<DD><CODE>actionName</CODE> - the name of the action to be deactivated
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/portal/propertybroker/service/DeactivationFailedException.html" title="class in com.ibm.portal.propertybroker.service">DeactivationFailedException</A></CODE> - is thrown if any problem is encountered<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/portal/propertybroker/service/PropertyBrokerService.html#activateAction(javax.portlet.PortletConfig, javax.portlet.ActionRequest, java.lang.String)"><CODE>activateAction(PortletConfig, ActionRequest, String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="isWired(javax.portlet.PortletRequest, java.lang.String)"><!-- --></A><H3>
isWired</H3>
<PRE>
public boolean <B>isWired</B>(javax.portlet.PortletRequest&nbsp;request,
                       java.lang.String&nbsp;propertyName)
                throws <A HREF="../../../../../com/ibm/portal/propertybroker/service/AccessFailedException.html" title="class in com.ibm.portal.propertybroker.service">AccessFailedException</A></PRE>
<DL>
<DD>Test to see if a property is currently wired.
 The knowledge of whether a property is wired may be used by the owning portlet to surface
 additional visual elements (such as links) in its markup which can be used by end users to
 trigger wired actions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for the current portlet request<DD><CODE>propertyName</CODE> - the name of the property to check
<DT><B>Returns:</B><DD>true if the calling portlet entity's specified property is wired to other target actions.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/portal/propertybroker/service/AccessFailedException.html" title="class in com.ibm.portal.propertybroker.service">AccessFailedException</A></CODE> - is thrown if any problem is encountered</DL>
</DD>
</DL>
<HR>

<A NAME="areWiresActive(javax.portlet.PortletRequest, java.lang.String)"><!-- --></A><H3>
areWiresActive</H3>
<PRE>
public boolean <B>areWiresActive</B>(javax.portlet.PortletRequest&nbsp;request,
                              java.lang.String&nbsp;propertyName)
                       throws <A HREF="../../../../../com/ibm/portal/propertybroker/service/AccessFailedException.html" title="class in com.ibm.portal.propertybroker.service">AccessFailedException</A></PRE>
<DL>
<DD>Test to see if a property is currently wired to active actions.
 The knowledge of whether a property is wired to active actions
 may be used by the owning portlet to surface
 additional visual elements (such as links) in its markup which can be used by end users to
 trigger wired actions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for the current portlet request<DD><CODE>propertyName</CODE> - the name of the property to check
<DT><B>Returns:</B><DD>true is the calling portlet entity's specified property is wired to other target actions
 which are currently active.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/portal/propertybroker/service/AccessFailedException.html" title="class in com.ibm.portal.propertybroker.service">AccessFailedException</A></CODE> - is thrown if any problem is encountered</DL>
</DD>
</DL>
<HR>

<A NAME="isWiredAcrossPages(javax.portlet.PortletRequest, java.lang.String)"><!-- --></A><H3>
isWiredAcrossPages</H3>
<PRE>
public boolean <B>isWiredAcrossPages</B>(javax.portlet.PortletRequest&nbsp;request,
                                  java.lang.String&nbsp;propertyName)
                           throws <A HREF="../../../../../com/ibm/portal/propertybroker/service/AccessFailedException.html" title="class in com.ibm.portal.propertybroker.service">AccessFailedException</A></PRE>
<DL>
<DD>Test to see if a property is currently wired across pages.
 The knowledge of whether a property is wired may be used by the owning portlet to surface
 additional visual elements (such as links) in its markup which can be used by end users to
 trigger wired actions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for the current portlet request<DD><CODE>propertyName</CODE> - the name of the property to check
<DT><B>Returns:</B><DD>true if the calling portlet entity's specified property is wired to other target actions on a different page.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/portal/propertybroker/service/AccessFailedException.html" title="class in com.ibm.portal.propertybroker.service">AccessFailedException</A></CODE> - is thrown if any problem is encountered</DL>
</DD>
</DL>
<HR>

<A NAME="areCrossPageWiresActive(javax.portlet.PortletRequest, java.lang.String)"><!-- --></A><H3>
areCrossPageWiresActive</H3>
<PRE>
public boolean <B>areCrossPageWiresActive</B>(javax.portlet.PortletRequest&nbsp;request,
                                       java.lang.String&nbsp;propertyName)
                                throws <A HREF="../../../../../com/ibm/portal/propertybroker/service/AccessFailedException.html" title="class in com.ibm.portal.propertybroker.service">AccessFailedException</A></PRE>
<DL>
<DD>Test to see if a property is currently wired to active actions on other pages.
 The knowledge of whether a property is wired to active actions
 may be used by the owning portlet to surface
 additional visual elements (such as links) in its markup which can be used by end users to
 trigger wired actions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for the current portlet request<DD><CODE>propertyName</CODE> - the name of the property to check
<DT><B>Returns:</B><DD>true is the calling portlet entity's specified property is wired to cross page target actions
 which are currently active.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/portal/propertybroker/service/AccessFailedException.html" title="class in com.ibm.portal.propertybroker.service">AccessFailedException</A></CODE> - is thrown if any problem is encountered</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/ibm/portal/propertybroker/service/PropertyBrokerContextPassingService.html" title="interface in com.ibm.portal.propertybroker.service"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/portal/propertybroker/service/PropertyFactory.html" title="interface in com.ibm.portal.propertybroker.service"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PropertyBrokerService.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>