/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://opensso.dev.java.net/public/CDDLv1.0.html or
* opensso/legal/CDDLv1.0.txt
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: Status.java,v 1.2 2008/06/25 05:48:12 qcheng Exp $
*
*/
package com.sun.identity.xacml.context;
import com.sun.identity.xacml.common.XACMLException;
import java.util.List;
/**
* The Status
element is a container of
* one or more Status
s issuded by authorization authority.
* @supported.all.api
*
* * Schema: * <xs:complexType name="StatusType"> * <xs:sequence> * <xs:element ref="xacml-context:StatusCode"/> * <xs:element ref="xacml-context:StatusMessage" minOccurs="0"/> * <xs:element ref="xacml-context:StatusDetail" minOccurs="0"/> * <xs:sequence> * <xs:complexType> */ public interface Status { /** * Returns theStatusCode
of this object * * @return theStatusCode
of this object */ public StatusCode getStatusCode(); /** * Sets theStatusCode
of this object * * @exception XACMLException if the object is immutable */ public void setStatusCode(StatusCode statusCode) throws XACMLException; /** * Returns theStatusMessage
of this object * * @return theStatusMessage
of this object */ public StatusMessage getStatusMessage(); /** * Sets theStatusMessage
of this object * * @exception XACMLException if the object is immutable */ public void setStatusMessage(StatusMessage statusMessage) throws XACMLException; /** * Returns theStatusDetail
of this object * * @return theStatusDetail
of this object */ public StatusDetail getStatusDetail(); /** * Sets theStatusDetail
of this object * * @exception XACMLException if the object is immutable */ public void setStatusDetail(StatusDetail statusDetail) throws XACMLException; /** * Returns a string representation * * @return a string representation * @exception XACMLException if conversion fails for any reason */ public String toXMLString() throws XACMLException; /** * Returns a string representation * @param includeNSPrefix Determines whether or not the namespace qualifier * is prepended to the Element when converted * @param declareNS Determines whether or not the namespace is declared * within the Element. * @return a string representation * @exception XACMLException if conversion fails for any reason */ public String toXMLString(boolean includeNSPrefix, boolean declareNS) throws XACMLException; /** * Checks if the object is mutable * * @returntrue
if the object is mutable, *false
otherwise */ public boolean isMutable(); /** * Makes the object immutable */ public void makeImmutable(); }