001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: StatusDetail.java,v 1.2 2008/06/25 05:47:58 qcheng Exp $
026 *
027 */
028
029
030package com.sun.identity.saml2.protocol;
031
032import com.sun.identity.saml2.common.SAML2Exception;
033
034/**
035 * This class represents the <code>StatusDetailType</code> complex type in
036 * SAML protocol schema.
037 * The <code>StatusDetail</code> element MAY be used to specify additional
038 * information concerning the status of the request.
039 *
040 * <pre>
041 * &lt;complexType name="StatusDetailType">
042 *   &lt;complexContent>
043 *     &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
044 *       &lt;sequence>
045 *         &lt;any/>
046 *       &lt;/sequence>
047 *     &lt;/restriction>
048 *   &lt;/complexContent>
049 * &lt;/complexType>
050 * </pre>
051 *
052 * @supported.all.api
053 */
054
055public interface StatusDetail {
056    
057    /**
058     * Returns the value of the Any property.
059     *
060     * @return A list containing objects of type <code>String</code>
061     * @see #setAny(List)
062     */
063    public java.util.List getAny();
064    
065    /**
066     * Sets the value of the Any property.
067     *
068     * @param anyList
069     *        A list containing objects of type <code>String</code>
070     * @throws SAML2Exception if the object is immutable
071     * @see #getAny
072     */
073    public void setAny(java.util.List anyList) throws SAML2Exception;
074    
075    /**
076     * Returns the <code>StatusDetail</code> in an XML document String format
077     * based on the <code>StatusDetail</code> schema described above.
078     *
079     * @return An XML String representing the <code>StatusDetail</code>.
080     * @throws SAML2Exception if some error occurs during conversion to
081     *         <code>String</code>.
082     */
083    public String toXMLString() throws SAML2Exception;
084    
085    /**
086     * Returns the <code>StatusDetail</code> in an XML document String format
087     * based on the <code>StatusDetail</code> schema described above.
088     *
089     * @param includeNSPrefix Determines whether or not the namespace qualifier 
090     *        is prepended to the Element when converted
091     * @param declareNS Determines whether or not the namespace is declared
092     *        within the Element.
093     * @return A XML String representing the <code>StatusDetail</code>.
094     * @throws SAML2Exception if some error occurs during conversion to
095     *         <code>String</code>.
096     */
097    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
098    throws SAML2Exception;
099    
100    /**
101     * Makes the obejct immutable
102     */
103    public void makeImmutable();
104    
105    /**
106     * Returns true if the object is mutable false otherwise
107     *
108     * @return true if the object is mutable false otherwise
109     */
110    public boolean isMutable();
111}




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.