1 /*
2 * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package edu.internet2.middleware.shibboleth.wayf.idpdisco;
18
19 import javax.xml.namespace.QName;
20
21 import org.opensaml.common.SAMLObject;
22
23 /**
24 * IPHint.
25 *
26 * See IdP Discovery and Login UI Metadata Extension Profile.
27 *
28 * @author Rod Widdowson August 2010
29 *
30 * The <GeolocationHint> element specifies the geographic coordinates associated
31 * with, or serviced by, the entity. Coordinates are given in decimal form using
32 * the World Geodetic System (2d) coordinate system.
33 */
34 public interface GeolocationHint extends SAMLObject {
35
36 /** Element local name. */
37 public static final String DEFAULT_ELEMENT_LOCAL_NAME = "GeolocationHint";
38
39 /** Default element name. */
40 public static final QName DEFAULT_ELEMENT_NAME = new QName(DiscoHints.MDUI_NS,
41 DEFAULT_ELEMENT_LOCAL_NAME, DiscoHints.MDUI_PREFIX);
42
43 /**
44 * Gets the Hint.
45 *
46 * @return the Hint
47 */
48 public String getHint();
49
50 /**
51 * Sets the hint.
52 *
53 * @param newHint hint
54 */
55 public void setHint(String newHint);
56 }