View Javadoc

1   /*
2    * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.opensaml.ws.soap.soap11;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.ws.soap.common.SOAPObject;
22  import org.opensaml.ws.soap.util.SOAPConstants;
23  
24  /**
25   * SOAP 1.1 Fault.
26   */
27  public interface Fault extends SOAPObject {
28      
29      /** Element local name. */
30      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "Fault";
31      
32      /** Default element name. */
33      public static final QName DEFAULT_ELEMENT_NAME = 
34          new QName(SOAPConstants.SOAP11_NS, DEFAULT_ELEMENT_LOCAL_NAME, SOAPConstants.SOAP11_PREFIX);
35      
36      /** Local name of the XSI type. */
37      public static final String TYPE_LOCAL_NAME = "Fault"; 
38          
39      /** QName of the XSI type. */
40      public static final QName TYPE_NAME = 
41          new QName(SOAPConstants.SOAP11_NS, TYPE_LOCAL_NAME, SOAPConstants.SOAP11_PREFIX);
42  
43      /**
44       * Gets the fault code for this fault.
45       * 
46       * @return the fault code for this fault
47       */
48      public FaultCode getCode();
49      
50      /**
51       * Sets the fault code for this fault.
52       * 
53       * @param newFaultCode the fault code for this fault
54       */
55      public void setCode(FaultCode newFaultCode);
56      
57      /**
58       * Gets the fault string for this fault.
59       * 
60       * @return the fault string for this fault
61       */
62      public FaultString getMessage();
63      
64      /**
65       * Sets the fault string for this fault.
66       * 
67       * @param newMessage the fault string for this fault
68       */
69      public void setMessage(FaultString newMessage);
70      
71      /**
72       * Gets the URI of the fault actor for this fault.
73       * 
74       * @return the URI of the fault actor for this fault
75       */
76      public FaultActor getActor();
77      
78      /**
79       * Sets the URI of the fault actor for this fault.
80       * 
81       * @param newActor the URI of the fault actor for this fault
82       */
83      public void setActor(FaultActor newActor);
84      
85      /**
86       * Gets details of this fault.
87       * 
88       * @return details of this fault
89       */
90      public Detail getDetail();
91      
92      /**
93       * Sets details of this fault.
94       * 
95       * @param newDetail details of this fault
96       */
97      public void setDetail(Detail newDetail);
98  }