/*
 * reserved comment block
 * DO NOT REMOVE OR ALTER!
 */
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.sun.org.apache.xml.internal.security.encryption;

import java.util.Iterator;
import org.w3c.dom.Element;

A wrapper for a pointer from a key value of an EncryptedKey to items encrypted by that key value (EncryptedData or EncryptedKey elements). 

It is defined as follows:

<complexType name='ReferenceType'>
    <sequence>
        <any namespace='##other' minOccurs='0' maxOccurs='unbounded'/>
    </sequence>
    <attribute name='URI' type='anyURI' use='required'/>
</complexType>

Author:
Axl Mattheus
See Also:
ReferenceList/**
 * A wrapper for a pointer from a key value of an {@code EncryptedKey} to
 * items encrypted by that key value ({@code EncryptedData} or
 * {@code EncryptedKey} elements).
 * <p>
 * It is defined as follows:
 * <pre>{@code
 * <complexType name='ReferenceType'>
 *     <sequence>
 *         <any namespace='##other' minOccurs='0' maxOccurs='unbounded'/>
 *     </sequence>
 *     <attribute name='URI' type='anyURI' use='required'/>
 * </complexType>
 * }</pre>
 *
 * @author Axl Mattheus
 * @see ReferenceList
 */
public interface Reference {
    
Returns the Element tag name for this Reference. 
Returns:
the tag name of this Reference./**
     * Returns the {@code Element} tag name for this {@code Reference}.
     *
     * @return the tag name of this {@code Reference}.
     */
    String getType();

    
Returns a URI that points to an Element that were encrypted using the key defined in the enclosing EncryptedKey element. 
Returns:
an Uniform Resource Identifier that qualifies an EncryptedType./**
     * Returns a {@code URI} that points to an {@code Element} that
     * were encrypted using the key defined in the enclosing
     * {@code EncryptedKey} element.
     *
     * @return an Uniform Resource Identifier that qualifies an
     *   {@code EncryptedType}.
     */
    String getURI();

    
Sets a URI that points to an Element that were encrypted using the key defined in the enclosing EncryptedKey element. 
Params:
uri – the Uniform Resource Identifier that qualifies an EncryptedType./**
     * Sets a {@code URI} that points to an {@code Element} that
     * were encrypted using the key defined in the enclosing
     * {@code EncryptedKey} element.
     *
     * @param uri the Uniform Resource Identifier that qualifies an
     *   {@code EncryptedType}.
     */
    void setURI(String uri);

    
Returns an Iterator over all the child elements contained in this Reference that will aid the recipient in retrieving the EncryptedKey and/or EncryptedData elements. These could include information such as XPath transforms, decompression transforms, or information on how to retrieve the elements from a document storage facility. 
Returns:
child elements./**
     * Returns an {@code Iterator} over all the child elements contained in
     * this {@code Reference} that will aid the recipient in retrieving the
     * {@code EncryptedKey} and/or {@code EncryptedData} elements.
     * These could include information such as XPath transforms, decompression
     * transforms, or information on how to retrieve the elements from a
     * document storage facility.
     *
     * @return child elements.
     */
    Iterator<Element> getElementRetrievalInformation();

    
Adds retrieval information.
Params:
info – /**
     * Adds retrieval information.
     *
     * @param info
     */
    void addElementRetrievalInformation(Element info);

    
Removes the specified retrieval information.
Params:
info – /**
     * Removes the specified retrieval information.
     *
     * @param info
     */
    void removeElementRetrievalInformation(Element info);
}