se.litsec.eidas.opensaml2.ext.attributes

Interface CurrentAddressStructuredType

All Superinterfaces:

XMLObject

All Known Subinterfaces:

CurrentAddressType

All Known Implementing Classes:

CurrentAddressStructuredTypeImpl, CurrentAddressTypeImpl

public interface CurrentAddressStructuredType
extends XMLObject

The eIDAS type CurrentAddressStructuredType.

  
 <xsd:complexType name="CurrentAddressStructuredType">
   <xsd:annotation>
     <xsd:documentation>
       Current address of the natural person.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:sequence>
     <xsd:element name="PoBox" type="xsd:string" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="LocatorDesignator" type="xsd:string" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="LocatorName" type="xsd:string" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="CvaddressArea" type="xsd:string" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="Thoroughfare" type="xsd:string" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="PostName" type="xsd:string" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="AdminunitFirstline" type="xsd:string" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="AdminunitSecondline" type="xsd:string" minOccurs="0" maxOccurs="1"/>
     <xsd:element name="PostCode" type="xsd:string" minOccurs="0" maxOccurs="1"/>
   </xsd:sequence>
 </xsd:complexType>
 

Author:

Martin Lindström (martin.lindstrom@litsec.se)

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_LOCAL_NAME Local name of the XSI type.
static QName	TYPE_NAME QName of the XSI type.

Method Summary

Modifier and Type	Method and Description
String	getAdminunitFirstline() Returns the the admin unit first line element.
String	getAdminunitSecondline() Returns the the admin unit second line element.
String	getCvaddressArea() Returns the Cvaddress area element.
String	getLocatorDesignator() Returns the locator designator element.
String	getLocatorName() Returns the locator name element.
String	getPoBox() Returns the Post box element
String	getPostCode() Returns the Post code element.
String	getPostName() Returns the post name element.
String	getThoroughfare() Returns the Thoroughfare element.
void	setAdminunitFirstline(String adminunitFirstline) Assigns the admin unit first line element.
void	setAdminunitSecondline(String adminunitSecondline) Assigns the admin unit second line element.
void	setCvaddressArea(String cvaddressArea) Assigns the Cvaddress area element.
void	setLocatorDesignator(String locatorDesignator) Assigns the locator designator element.
void	setLocatorName(String locatorName) Assigns the locator name element.
void	setPoBox(String poBox) Assigns the Post box element.
void	setPostCode(String postCode) Assigns the Post code element.
void	setPostName(String postName) Assigns the post name element.
void	setThoroughfare(String thoroughfare) Assigns the Thoroughfare element.

Methods inherited from interface org.opensaml.xml.XMLObject

addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

TYPE_LOCAL_NAME

static final String TYPE_LOCAL_NAME

Local name of the XSI type.

See Also:

Constant Field Values

TYPE_NAME

static final QName TYPE_NAME

QName of the XSI type.

Method Detail

setPoBox

void setPoBox(String poBox)

Assigns the Post box element.

Parameters:

poBox - the Post box

getPoBox

String getPoBox()

Returns the Post box element

Returns:

the Post box element or null if no such element is available

setLocatorDesignator

void setLocatorDesignator(String locatorDesignator)

Assigns the locator designator element.

About a locator designator from mapping.semic.eu:

The locator designator is a number or a sequence of characters that uniquely identifies the locator within the relevant scope(s). The full identification of the locator could include one or more locator designators. [INSPIRE] In simpler terms, this is the building number, apartment number, etc. It is characteristic that these designators, according to tradition or to a specific set of rules, are assigned systematically. For example address numbers are most often assigned in ascending order with odd and even numbers on each side of the thoroughfare. Another example is the floor identifier that in a standardized way expresses on which level the address is located. [INSPIRE] The key difference between a locator designator and a locator name is that the latter is a proper name and is unlikely to include digits.

Parameters:

locatorDesignator - the locator designator

getLocatorDesignator

String getLocatorDesignator()

Returns the locator designator element.

Returns:

the locator designator element or null if no such element is available

setLocatorName

void setLocatorName(String locatorName)

Assigns the locator name element.

A locator name is typically a building, site or room name.

Parameters:

locatorName - the locator name

getLocatorName

String getLocatorName()

Returns the locator name element.

Returns:

the locator name element or null if no such element is available.

setCvaddressArea

void setCvaddressArea(String cvaddressArea)

Assigns the Cvaddress area element.

Parameters:

cvaddressArea - the Cvaddress area element

getCvaddressArea

String getCvaddressArea()

Returns the Cvaddress area element.

Returns:

the Cvaddress area element or null if no such element is available

setThoroughfare

void setThoroughfare(String thoroughfare)

Assigns the Thoroughfare element.

The element contains information about the thoroughfare - for example, the street, avenue, or boulevard - on which an address is located.

Parameters:

thoroughfare - the Thoroughfare element

getThoroughfare

String getThoroughfare()

Returns the Thoroughfare element.

Returns:

the Thoroughfare element or null if no such element is available

setPostName

void setPostName(String postName)

Assigns the post name element.

The post name is generally the city-part of the address.

Parameters:

postName - the post name

getPostName

String getPostName()

Returns the post name element.

Returns:

the post name element or null if no such element is available

setAdminunitFirstline

void setAdminunitFirstline(String adminunitFirstline)

Assigns the admin unit first line element.

Parameters:

adminunitFirstline - the admin unit first line element

getAdminunitFirstline

String getAdminunitFirstline()

Returns the the admin unit first line element.

Returns:

the the admin unit first line element or null if no such element is available

setAdminunitSecondline

void setAdminunitSecondline(String adminunitSecondline)

Assigns the admin unit second line element.

Parameters:

adminunitSecondline - the admin unit second line element

getAdminunitSecondline

String getAdminunitSecondline()

Returns the the admin unit second line element.

Returns:

the the admin unit second line element or null if no such element is available

setPostCode

void setPostCode(String postCode)

Assigns the Post code element.

Parameters:

postCode - the Post code element

getPostCode

String getPostCode()

Returns the Post code element.

Returns:

the Post code element or null if no such element is available