View Javadoc

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 org.opensaml.saml2.metadata;
18  
19  import java.util.List;
20  
21  import javax.xml.namespace.QName;
22  
23  import org.opensaml.common.SAMLObject;
24  import org.opensaml.common.xml.SAMLConstants;
25  import org.opensaml.saml2.common.Extensions;
26  import org.opensaml.xml.AttributeExtensibleXMLObject;
27  
28  /**
29   * SAML 2.0 Metadata ContactPerson
30   */
31  public interface ContactPerson extends SAMLObject, AttributeExtensibleXMLObject{
32  
33      /** Element name, no namespace */
34      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "ContactPerson";
35      
36      /** Default element name */
37      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
38      
39      /** Local name of the XSI type */
40      public final static String TYPE_LOCAL_NAME = "ContactPersonType"; 
41          
42      /** QName of the XSI type */
43      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
44      
45      /** "contactType" attribute's local name */
46      public final static String CONTACT_TYPE_ATTRIB_NAME = "contactType";
47  
48      /**
49       * Gets the type of contact this person.
50       * 
51       * @return the type of contact this person
52       */
53  	public ContactPersonTypeEnumeration getType();
54      
55      /**
56       * Sets the type of contact this person.
57       * 
58       * @param type the type of contact this person
59       */
60      public void setType(ContactPersonTypeEnumeration type);
61      
62      /**
63       * Gets the Extensions child of this object.
64       * 
65       * @return the Extensions child of this object
66       */
67      public Extensions getExtensions();
68      
69      /**
70       * Sets the Extensions child of this object.
71       * 
72       * @param extensions the Extensions child of this object
73       * 
74       * @throws IllegalArgumentException thrown if the given extensions Object is already a child of another SAMLObject 
75       */
76      public void setExtensions(Extensions extensions) throws IllegalArgumentException;
77  
78      /**
79       * Gets the company this contact person is associated with.
80       * 
81       * @return the company this contact person is associated with
82       */
83  	public Company getCompany();
84      
85      /**
86       * Sets the company this contact person is associated with.
87       * 
88       * @param company the company this contact person is associated with
89       */
90      public void setCompany(Company company);
91  
92      /**
93       * Gets the given name for this person.
94       * 
95       * @return the given name for this person
96       */
97  	public GivenName getGivenName();
98      
99      /**
100      * Sets the given name for this person.
101      * 
102      * @param name the given name for this person
103      */
104     public void setGivenName(GivenName name);
105 
106 	/**
107      * Gets the surname for this person.
108      *  
109      * @return the surname for this person
110 	 */
111     public SurName getSurName();
112     
113     /**
114      * Sets the surname for this person.
115      * @param name the surname for this person
116      */
117     public void setSurName(SurName name);
118 
119     /**
120      * Gets a list of email addresses for this person.
121      * 
122      * @return list of email addresses for this person
123      */
124 	public List<EmailAddress> getEmailAddresses();
125     
126     /**
127      * Gets an immutable list of telephone numbers for this person.
128      * 
129      * @return list of telephone numbers for this person
130      */
131 	public List<TelephoneNumber> getTelephoneNumbers();
132 }