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 import org.opensaml.common.xml.SAMLConstants;
23 import org.opensaml.saml2.metadata.LocalizedString;
24
25 /**
26 * DisplayName.
27 *
28 * See IdP Discovery and Login UI Metadata Extension Profile.
29 *
30 * @author Rod Widdowson August 2010
31 *
32 * Reflects the Description in the IdP Discovery and Login UI Metadata Extension Profile.
33 *
34 */
35 public interface Description extends LocalizedName {
36
37 /** Element local name. */
38 public static final String DEFAULT_ELEMENT_LOCAL_NAME = "Description";
39
40 /** Default element name. */
41 public static final QName DEFAULT_ELEMENT_NAME = new QName(UIInfo.MDUI_NS,
42 DEFAULT_ELEMENT_LOCAL_NAME, UIInfo.MDUI_PREFIX);
43
44 /**
45 * Gets the description of the EndPoint.
46 *
47 * @return the description of the EndPoint
48 */
49 public LocalizedString getDescription();
50
51 /**
52 * Sets the description of the EndPoint.
53 *
54 * @param newDescription description of the EndPoint
55 */
56 public void setDescription(LocalizedString newDescription);
57 }