001/** 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2008 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: AssertionIDRef.java,v 1.2 2008/06/25 05:47:40 qcheng Exp $ 026 * 027 */ 028 029package com.sun.identity.saml2.assertion; 030 031import com.sun.identity.saml2.common.SAML2Exception; 032 033/** 034 * This class represents the AssertionIDRef element. 035 * <p>The following schema fragment specifies the expected 036 * content contained within this java content object. 037 * <p> 038 * <pre> 039 * <element name="AssertionIDRef" type="NCName"/> 040 * </pre> 041 * 042 * @supported.all.api 043 */ 044public interface AssertionIDRef { 045 046 /** 047 * Returns the value of the <code>AssertionIDRef</code>. 048 * 049 * @return the value of this <code>AssertionIDRef</code>. 050 * @see #setValue(String) 051 */ 052 public String getValue(); 053 054 /** 055 * Sets the value of this <code>AssertionIDRef</code>. 056 * 057 * @param value new <code>AssertionIDRef</code>. 058 * @throws SAML2Exception if the object is immutable. 059 * @see #getValue() 060 */ 061 public void setValue(String value) throws SAML2Exception; 062 063 /** 064 * Makes the object immutable. 065 */ 066 public void makeImmutable(); 067 068 /** 069 * Returns the mutability of the object. 070 * 071 * @return <code>true</code> if the object is mutable; <code>false</code> 072 * otherwise. 073 */ 074 public boolean isMutable(); 075 076 /** 077 * Returns a String representation of the element. 078 * 079 * @return A string containing the valid XML for this element. 080 * By default name space name is prepended to the element name. 081 * @throws SAML2Exception if the object does not conform to the schema. 082 */ 083 public String toXMLString() throws SAML2Exception; 084 085 /** 086 * Returns a String representation of the element. 087 * 088 * @param includeNS Determines whether or not the namespace qualifier is 089 * prepended to the Element when converted 090 * @param declareNS Determines whether or not the namespace is declared 091 * within the Element. 092 * @return A string containing the valid XML for this element 093 * @throws SAML2Exception if the object does not conform to the schema. 094 */ 095 public String toXMLString(boolean includeNS, boolean declareNS) 096 throws SAML2Exception; 097}
Copyright © 2010-2017, ForgeRock All Rights Reserved.