net.sf.mmm.orient.data.bean.api.contact

Interface Address

All Superinterfaces:

Bean, Entity, EntityBean, OrientBean, Vertex

public interface Address
extends Vertex

TODO: this class ...

Since:

1.0.0

Author:

hohwille

Field Summary

Fields inherited from interface net.sf.mmm.orient.api.bean.Vertex

NAME

Fields inherited from interface net.sf.mmm.orient.api.bean.OrientBean

PROPERTY_ALIAS_ID, PROPERTY_ALIAS_VERSION

Fields inherited from interface net.sf.mmm.util.bean.api.entity.Entity

PROPERTY_NAME_ID

Method Summary

Modifier and Type	Method and Description
LinkProperty<City>	City()
StringProperty	CityName()
LinkProperty<Country>	Country()
StringProperty	PoBox()
LinkProperty<PostalCode>	PostalCode()
LinkProperty<Region>	Region()
StringProperty	Street()
StringProperty	StreetNumber()
StringProperty	Zip()

Methods inherited from interface net.sf.mmm.orient.api.bean.OrientBean

Id

Methods inherited from interface net.sf.mmm.util.bean.api.Bean

access

Methods inherited from interface net.sf.mmm.util.bean.api.entity.Entity

getId, setId

Method Detail

CityName

StringProperty CityName()

Returns:

the name of the City this address is located in.

City

LinkProperty<City> City()

Returns:

the City this address is located in. Optional but if set then CityName() should be AbstractName.Name().

Country

LinkProperty<Country> Country()

Returns:

the Country this Address is located in.

Region

LinkProperty<Region> Region()

Returns:

the Region this Address is located in.

Zip

StringProperty Zip()

Returns:

the PostalCode as String. Validation depends on the Country.PostalCodeMode().

PostalCode

LinkProperty<PostalCode> PostalCode()

Returns:

the PostalCode. Optional but if set then Zip() has to be AbstractCode.Code().

PoBox

StringProperty PoBox()

Returns:

the Post Office (PO) box. It is a unique identifier for a locked box typically located on the premises of the post office. In most countries a PO box has a numberic code. However String is used as this is not ensured for all countries. is Has to be present if Street() is empty.

Street

StringProperty Street()

Returns:

the street name. Has to be present if PoBox() is empty.

StreetNumber

StringProperty StreetNumber()

Returns:

the optional street number or house number. Please note that this is not strictly numeric (e.g. "7b" is a valid value) and is therefore represented as String.