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: StatusCode.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 033 034/** 035 * The <code>StatusCode</code> element is a container of 036 * one or more <code>StatusCode</code>s issuded by authorization authority. 037 * @supported.all.api 038 * <p/> 039 * <pre> 040 * 041 * Schema: 042 * <xs:element name="StatusCode" type="xacml-context:StatusCodeType"/> 043 * <xs:complexType name="StatusCodeType"> 044 * <xs:sequence> 045 * <xs:element ref="xacml-context:StatusCode" minOccurs="0"/> 046 * <xs:sequence> 047 * <xs:attribute name="Value" type="xs:anyURI" use="required"/> 048 * <xs:complexType> 049 * </pre> 050 */ 051public interface StatusCode { 052 053 054 /** 055 * Returns the <code>value</code> of this object 056 * 057 * @return the <code>value</code> of this object 058 */ 059 public String getValue(); 060 061 /** 062 * Sets the <code>value</code> of this object 063 * 064 * @exception XACMLException if the object is immutable 065 */ 066 public void setValue(String value) throws XACMLException; 067 068 /** 069 * Returns the <code>minorCodeValue</code> of this object 070 * 071 * @return the <code>minorCodeValue</code> of this object 072 */ 073 public String getMinorCodeValue(); 074 075 /** 076 * Sets the <code>minorCodeValue</code> of this object 077 * 078 * @exception XACMLException if the object is immutable 079 */ 080 public void setMinorCodeValue(String minorCodeValue) throws XACMLException; 081 082 /** 083 * Returns a string representation 084 * 085 * @return a string representation 086 * @exception XACMLException if conversion fails for any reason 087 */ 088 public String toXMLString() throws XACMLException; 089 090 /** 091 * Returns a string representation 092 * @param includeNSPrefix Determines whether or not the namespace qualifier 093 * is prepended to the Element when converted 094 * @param declareNS Determines whether or not the namespace is declared 095 * within the Element. 096 * @return a string representation 097 * @exception XACMLException if conversion fails for any reason 098 */ 099 public String toXMLString(boolean includeNSPrefix, boolean declareNS) 100 throws XACMLException; 101 102 /** 103 * Checks if the object is mutable 104 * 105 * @return <code>true</code> if the object is mutable, 106 * <code>false</code> otherwise 107 */ 108 public boolean isMutable(); 109 110 /** 111 * Makes the object immutable 112 */ 113 public void makeImmutable(); 114 115}
Copyright © 2010-2017, ForgeRock All Rights Reserved.