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  package org.opensaml.saml1.core;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.common.SAMLObject;
22  import org.opensaml.common.xml.SAMLConstants;
23  
24  /**
25   * This interface defines how the object representing a SAML 1 <code> Status</code> element behaves.
26   */
27  public interface Status extends SAMLObject {
28  
29      /** Element name, no namespace. */
30      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "Status";
31      
32      /** Default element name */
33      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML10P_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML1P_PREFIX);
34      
35      /** Local name of the XSI type */
36      public final static String TYPE_LOCAL_NAME = "StatusType"; 
37          
38      /** QName of the XSI type */
39      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML10P_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML1P_PREFIX);
40  
41      /** Return the object representing the <code>StatusMessage<code> (element). */
42      public StatusMessage getStatusMessage();
43  
44      /** Set the object representing the <code>StatusMessage<code> (element). */
45      public void setStatusMessage(StatusMessage statusMessage) throws IllegalArgumentException;
46  
47      /** Return the object representing the <code>StatusCode<code> (element). */
48      public StatusCode getStatusCode();
49  
50      /** Set the object representing the <code>StatusCode<code> (element). */
51      public void setStatusCode(StatusCode statusCode) throws IllegalArgumentException;
52  
53      /** Return the object representing the <code>StatusDetail<code> (element). */
54  
55      public StatusDetail getStatusDetail();
56  
57      /** Set the object representing the <code>StatusDetail<code> (element). */
58      public void setStatusDetail(StatusDetail statusDetail) throws IllegalArgumentException;
59  }