/*
 * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
 *
 * Licensed 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 edu.internet2.middleware.shibboleth.wayf.idpdisco;

import javax.xml.namespace.QName;

import org.opensaml.common.SAMLObject;

/**
 * IPHint.
 *
 * See IdP Discovery and Login UI Metadata Extension Profile.
 *
 * @author Rod Widdowson August 2010
 * 
 * The <DomainHint> element specifies a set of DNS domains associated with, 
 * or serviced by, the entity. 
 */
public interface DomainHint extends SAMLObject {

    /** Element local name. */
    public static final String DEFAULT_ELEMENT_LOCAL_NAME = "DomainHint";
    
    /** Default element name. */
    public static final QName DEFAULT_ELEMENT_NAME = new QName(DiscoHints.MDUI_NS, 
            DEFAULT_ELEMENT_LOCAL_NAME, DiscoHints.MDUI_PREFIX);
    
    /**
     * Gets the Hint.
     * 
     * @return the Hint
     */
    public String getHint();
    
    /**
     * Sets the hint.
     * 
     * @param newHint hint
     */
    public void setHint(String newHint);
}
