View Javadoc

1   /*
2    * Copyright [2005] [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  /**
18   * 
19   */
20  
21  package org.opensaml.saml2.core;
22  
23  import javax.xml.namespace.QName;
24  
25  import org.opensaml.common.SAMLObject;
26  import org.opensaml.common.xml.SAMLConstants;
27  
28  /**
29   * SAML 2.0 Core Status.
30   */
31  public interface Status extends SAMLObject {
32  
33      /** Local Name of Status. */
34      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "Status";
35  
36      /** Default element name. */
37      public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20P_NS, DEFAULT_ELEMENT_LOCAL_NAME,
38              SAMLConstants.SAML20P_PREFIX);
39  
40      /** Local name of the XSI type. */
41      public static final String TYPE_LOCAL_NAME = "StatusType";
42  
43      /** QName of the XSI type. */
44      public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20P_NS, TYPE_LOCAL_NAME,
45              SAMLConstants.SAML20P_PREFIX);
46  
47      /**
48       * Gets the Code of this Status.
49       * 
50       * @return Status StatusCode
51       */
52      public StatusCode getStatusCode();
53  
54      /**
55       * Sets the Code of this Status.
56       * 
57       * @param newStatusCode the Code of this Status
58       */
59      public void setStatusCode(StatusCode newStatusCode);
60  
61      /**
62       * Gets the Message of this Status.
63       * 
64       * @return Status StatusMessage
65       */
66      public StatusMessage getStatusMessage();
67  
68      /**
69       * Sets the Message of this Status.
70       * 
71       * @param newStatusMessage the Message of this Status
72       */
73      public void setStatusMessage(StatusMessage newStatusMessage);
74  
75      /**
76       * Gets the Detail of this Status.
77       * 
78       * @return Status StatusDetail
79       */
80      public StatusDetail getStatusDetail();
81  
82      /**
83       * Sets the Detail of this Status.
84       * 
85       * @param newStatusDetail the Detail of this Status
86       */
87      public void setStatusDetail(StatusDetail newStatusDetail);
88  }