001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2007 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: StatusMessage.java,v 1.2 2008/06/25 05:48:12 qcheng Exp $
026 *
027 */
028
029package com.sun.identity.xacml.context;
030
031import com.sun.identity.xacml.common.XACMLException;
032
033import java.util.List;
034
035/**
036 * The <code>StatusMessage</code> element is a container of 
037 * one or more <code>StatusMessage</code>s issuded by authorization authority.
038 * @supported.all.api
039 * <p/>
040 * <pre>
041 *
042 * Schema:
043 *  &lt;xs:element name="StatusMessage" type="xs:string"/>
044 * </pre>
045 */
046public interface StatusMessage {
047
048
049    /**
050     * Returns the <code>value</code> of this object
051     *
052     * @return the <code>value</code> of this object
053     */
054    public String getValue();
055
056    /**
057     * Sets the <code>value</code> of this object
058     *
059     * @exception XACMLException if the object is immutable
060     */
061    public void setValue(String value) throws XACMLException;
062
063    /**
064    * Returns a string representation
065    *
066    * @return a string representation
067    * @exception XACMLException if conversion fails for any reason
068    */
069    public String toXMLString() throws XACMLException;
070
071   /**
072    * Returns a string representation
073    * @param includeNSPrefix Determines whether or not the namespace qualifier
074    *        is prepended to the Element when converted
075    * @param declareNS Determines whether or not the namespace is declared
076    *        within the Element.
077    * @return a string representation
078    * @exception XACMLException if conversion fails for any reason
079     */
080    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
081            throws XACMLException;
082
083   /**
084    * Checks if the object is mutable
085    *
086    * @return <code>true</code> if the object is mutable,
087    *         <code>false</code> otherwise
088    */
089    public boolean isMutable();
090    
091   /**
092    * Makes the object immutable
093    */
094    public void makeImmutable();
095
096}




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.