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: Decision.java,v 1.2 2008/06/25 05:48:11 qcheng Exp $
026 *
027 */
028
029package com.sun.identity.xacml.context;
030
031import com.sun.identity.xacml.common.XACMLException;
032
033/**
034 * The <code>Decision</code> element is a container of 
035 * one or more <code>Decision</code>s issued by policy decision point
036 * @supported.all.api
037 * <p/>
038 * Schema:
039 * <pre>
040 * <xs:simpleType name="DecisionType">
041 *     <xs:restriction base="xs:string">
042 *         <xs:enumeration value="Permit"/>
043 *         <xs:enumeration value="Deny"/>
044 *         <xs:enumeration value="Indeterminate"/>
045 *         <xs:enumeration value="NotApplicable"/>
046 *     </xs:restriction>
047 * </xs:simpleType>
048 * </pre>
049 * 
050 */
051public interface Decision {
052
053    /**
054     * Returns the <code>value</code>s of this object
055     *
056     * @return the <code>value</code>s of this object
057     */
058    public String getValue();
059
060    /**
061     * Sets the <code>value</code>s of this object
062     *
063     * @exception XACMLException if the object is immutable
064     */
065    public void setValue(String value) throws XACMLException;
066
067
068   /**
069    * Returns a string representation
070    *
071    * @return a string representation
072    * @exception XACMLException if conversion fails for any reason
073    */
074    public String toXMLString() throws XACMLException;
075
076   /**
077    * Returns a string representation
078    * @param includeNSPrefix Determines whether or not the namespace qualifier
079    *        is prepended to the Element when converted
080    * @param declareNS Determines whether or not the namespace is declared
081    *        within the Element.
082    * @return a string representation
083    * @exception XACMLException if conversion fails for any reason
084     */
085    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
086            throws XACMLException;
087
088   /**
089    * Checks if the object is mutable
090    *
091    * @return <code>true</code> if the object is mutable,
092    *         <code>false</code> otherwise
093    */
094    public boolean isMutable();
095
096   /**
097    * Makes the object immutable
098    */
099    public void makeImmutable();
100
101    
102}