src/share/jaxws_classes/javax/xml/soap/SOAPFault.java
Print this page
rev 507 : 8047724: @since tag cleanup in jaxws
Reviewed-by:
*** 40,49 ****
--- 40,51 ----
* server.
* <P>
* Depending on the <code>protocol</code> specified while creating the
* <code>MessageFactory</code> instance, a <code>SOAPFault</code> has
* sub-elements as defined in the SOAP 1.1/SOAP 1.2 specification.
+ *
+ * @since 1.6
*/
public interface SOAPFault extends SOAPBodyElement {
/**
* Sets this <code>SOAPFault</code> object with the given fault code.
*** 70,80 ****
* @see #getFaultCodeAsName
*
* @exception SOAPException if there was an error in adding the
* <i>faultcode</i> element to the underlying XML tree.
*
! * @since SAAJ 1.2
*/
public void setFaultCode(Name faultCodeQName) throws SOAPException;
/**
* Sets this <code>SOAPFault</code> object with the given fault code.
--- 72,82 ----
* @see #getFaultCodeAsName
*
* @exception SOAPException if there was an error in adding the
* <i>faultcode</i> element to the underlying XML tree.
*
! * @since 1.6, SAAJ 1.2
*/
public void setFaultCode(Name faultCodeQName) throws SOAPException;
/**
* Sets this <code>SOAPFault</code> object with the given fault code.
*** 89,99 ****
* <code>faultcode</code> element to the underlying XML tree.
*
* @see #setFaultCode(Name)
* @see #getFaultCodeAsQName()
*
! * @since SAAJ 1.3
*/
public void setFaultCode(QName faultCodeQName) throws SOAPException;
/**
* Sets this <code>SOAPFault</code> object with the give fault code.
--- 91,101 ----
* <code>faultcode</code> element to the underlying XML tree.
*
* @see #setFaultCode(Name)
* @see #getFaultCodeAsQName()
*
! * @since 1.6, SAAJ 1.3
*/
public void setFaultCode(QName faultCodeQName) throws SOAPException;
/**
* Sets this <code>SOAPFault</code> object with the give fault code.
*** 126,136 ****
* additional parsing.
*
* @return a <code>Name</code> representing the faultcode
* @see #setFaultCode(Name)
*
! * @since SAAJ 1.2
*/
public Name getFaultCodeAsName();
/**
--- 128,138 ----
* additional parsing.
*
* @return a <code>Name</code> representing the faultcode
* @see #setFaultCode(Name)
*
! * @since 1.6, SAAJ 1.2
*/
public Name getFaultCodeAsName();
/**
*** 139,149 ****
*
* @return a <code>QName</code> representing the faultcode
*
* @see #setFaultCode(QName)
*
! * @since SAAJ 1.3
*/
public QName getFaultCodeAsQName();
/**
* Gets the Subcodes for this <code>SOAPFault</code> as an iterator over
--- 141,151 ----
*
* @return a <code>QName</code> representing the faultcode
*
* @see #setFaultCode(QName)
*
! * @since 1.6, SAAJ 1.3
*/
public QName getFaultCodeAsQName();
/**
* Gets the Subcodes for this <code>SOAPFault</code> as an iterator over
*** 156,166 ****
* in the fault from top to bottom.
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Subcode.
*
! * @since SAAJ 1.3
*/
public Iterator getFaultSubcodes();
/**
* Removes any Subcodes that may be contained by this
--- 158,168 ----
* in the fault from top to bottom.
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Subcode.
*
! * @since 1.6, SAAJ 1.3
*/
public Iterator getFaultSubcodes();
/**
* Removes any Subcodes that may be contained by this
*** 169,179 ****
* to <code>appendFaultSubcode</code> is made.
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Subcode.
*
! * @since SAAJ 1.3
*/
public void removeAllFaultSubcodes();
/**
* Adds a Subcode to the end of the sequence of Subcodes contained by this
--- 171,181 ----
* to <code>appendFaultSubcode</code> is made.
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Subcode.
*
! * @since 1.6, SAAJ 1.3
*/
public void removeAllFaultSubcodes();
/**
* Adds a Subcode to the end of the sequence of Subcodes contained by this
*** 185,195 ****
*
* @exception SOAPException if there was an error in setting the Subcode
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Subcode.
*
! * @since SAAJ 1.3
*/
public void appendFaultSubcode(QName subcode) throws SOAPException;
/**
* Gets the fault code for this <code>SOAPFault</code> object.
--- 187,197 ----
*
* @exception SOAPException if there was an error in setting the Subcode
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Subcode.
*
! * @since 1.6, SAAJ 1.3
*/
public void appendFaultSubcode(QName subcode) throws SOAPException;
/**
* Gets the fault code for this <code>SOAPFault</code> object.
*** 268,278 ****
* @see #getFaultString
*
* @exception SOAPException if there was an error in adding the
* <code>faultString</code> to the underlying XML tree.
*
! * @since SAAJ 1.2
*/
public void setFaultString(String faultString, Locale locale)
throws SOAPException;
/**
--- 270,280 ----
* @see #getFaultString
*
* @exception SOAPException if there was an error in adding the
* <code>faultString</code> to the underlying XML tree.
*
! * @since 1.6, SAAJ 1.2
*/
public void setFaultString(String faultString, Locale locale)
throws SOAPException;
/**
*** 313,323 ****
*
* @return a <code>Locale</code> object indicating the native language of
* the fault string or <code>null</code> if no locale was specified
* @see #setFaultString(String, Locale)
*
! * @since SAAJ 1.2
*/
public Locale getFaultStringLocale();
/**
* Returns true if this <code>SOAPFault</code> has a <code>Detail</code>
--- 315,325 ----
*
* @return a <code>Locale</code> object indicating the native language of
* the fault string or <code>null</code> if no locale was specified
* @see #setFaultString(String, Locale)
*
! * @since 1.6, SAAJ 1.2
*/
public Locale getFaultStringLocale();
/**
* Returns true if this <code>SOAPFault</code> has a <code>Detail</code>
*** 325,335 ****
* <code>(getDetail()!=null)</code>.
*
* @return true if this <code>SOAPFault</code> has a <code>Detail</code>
* subelement and false otherwise.
*
! * @since SAAJ 1.3
*/
public boolean hasDetail();
/**
* Returns the optional detail element for this <code>SOAPFault</code>
--- 327,337 ----
* <code>(getDetail()!=null)</code>.
*
* @return true if this <code>SOAPFault</code> has a <code>Detail</code>
* subelement and false otherwise.
*
! * @since 1.6, SAAJ 1.3
*/
public boolean hasDetail();
/**
* Returns the optional detail element for this <code>SOAPFault</code>
*** 375,385 ****
* @exception SOAPException if there was an error in retrieving
* the fault Reason locales.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Reason.
*
! * @since SAAJ 1.3
*/
public Iterator getFaultReasonLocales() throws SOAPException;
/**
* Returns an <code>Iterator</code> over a sequence of
--- 377,387 ----
* @exception SOAPException if there was an error in retrieving
* the fault Reason locales.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Reason.
*
! * @since 1.6, SAAJ 1.3
*/
public Iterator getFaultReasonLocales() throws SOAPException;
/**
* Returns an <code>Iterator</code> over a sequence of
*** 391,401 ****
* @exception SOAPException if there was an error in retrieving
* the fault Reason texts.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Reason.
*
! * @since SAAJ 1.3
*/
public Iterator getFaultReasonTexts() throws SOAPException;
/**
* Returns the Reason Text associated with the given <code>Locale</code>.
--- 393,403 ----
* @exception SOAPException if there was an error in retrieving
* the fault Reason texts.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Reason.
*
! * @since 1.6, SAAJ 1.3
*/
public Iterator getFaultReasonTexts() throws SOAPException;
/**
* Returns the Reason Text associated with the given <code>Locale</code>.
*** 412,422 ****
* @exception SOAPException if there was an error in retrieving
* the fault Reason text for the specified locale .
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Reason.
*
! * @since SAAJ 1.3
*/
public String getFaultReasonText(Locale locale) throws SOAPException;
/**
* Appends or replaces a Reason Text item containing the specified
--- 414,424 ----
* @exception SOAPException if there was an error in retrieving
* the fault Reason text for the specified locale .
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Reason.
*
! * @since 1.6, SAAJ 1.3
*/
public String getFaultReasonText(Locale locale) throws SOAPException;
/**
* Appends or replaces a Reason Text item containing the specified
*** 439,449 ****
* @exception SOAPException if there was an error in adding the Reason text
* or the <code>locale</code> passed was <code>null</code>.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Reason.
*
! * @since SAAJ 1.3
*/
public void addFaultReasonText(String text, java.util.Locale locale)
throws SOAPException;
/**
--- 441,451 ----
* @exception SOAPException if there was an error in adding the Reason text
* or the <code>locale</code> passed was <code>null</code>.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Reason.
*
! * @since 1.6, SAAJ 1.3
*/
public void addFaultReasonText(String text, java.util.Locale locale)
throws SOAPException;
/**
*** 455,465 ****
* or <code>null</code> if none
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Node.
*
! * @since SAAJ 1.3
*/
public String getFaultNode();
/**
* Creates or replaces any existing Node element value for
--- 457,467 ----
* or <code>null</code> if none
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Node.
*
! * @since 1.6, SAAJ 1.3
*/
public String getFaultNode();
/**
* Creates or replaces any existing Node element value for
*** 470,480 ****
* Node for this <code>SOAPFault</code> object.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Node.
*
*
! * @since SAAJ 1.3
*/
public void setFaultNode(String uri) throws SOAPException;
/**
* Returns the optional Role element value for this
--- 472,482 ----
* Node for this <code>SOAPFault</code> object.
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Node.
*
*
! * @since 1.6, SAAJ 1.3
*/
public void setFaultNode(String uri) throws SOAPException;
/**
* Returns the optional Role element value for this
*** 485,495 ****
* or <code>null</code> if none
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role.
*
! * @since SAAJ 1.3
*/
public String getFaultRole();
/**
* Creates or replaces any existing Role element value for
--- 487,497 ----
* or <code>null</code> if none
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role.
*
! * @since 1.6, SAAJ 1.3
*/
public String getFaultRole();
/**
* Creates or replaces any existing Role element value for
*** 502,511 ****
* Role for this <code>SOAPFault</code> object.
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role.
*
! * @since SAAJ 1.3
*/
public void setFaultRole(String uri) throws SOAPException;
}
--- 504,513 ----
* Role for this <code>SOAPFault</code> object.
*
* @exception UnsupportedOperationException if this message does not
* support the SOAP 1.2 concept of Fault Role.
*
! * @since 1.6, SAAJ 1.3
*/
public void setFaultRole(String uri) throws SOAPException;
}