Top Description Methods
javax.xml.registry.infomodel

public Interface PostalAddress

extends ExtensibleObject
Imports
javax.xml.registry.*
PostalAddress is a simple re-usable entity class that defines attributes of a postal Address.
Author
Farrukh S. Najmi

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the city
getCity()

Returns the city.

public String

Returns:

the country
getCountry()

Returns the country.

public String

Returns:

the postal code (e.g. US zip code)
getPostalCode()

Returns the postal or zip code.

public ClassificationScheme

Returns:

the user defined postal scheme.
getPostalScheme()

Returns a user-defined postal scheme for codifying the attributes of PostalAddress.

public String

Returns:

the state or province
getStateOrProvince()

Returns the state or province.

public String

Returns:

the street name
getStreet()

Returns the street name.

public String

Returns:

the street number
getStreetNumber()

Returns the street number.

public String

Returns:

the type for this PostalAddress. This is an arbitrary String (e.g. "Home", "Office")
getType()

Returns the type of address (for example, "headquarters") as a String.

public void
setCity(String
the city
city)

Sets the city.

public void
setCountry(String
the country
country)

Sets the country.

public void
setPostalCode(String
the postal code (e.g. US zip code)
postalCode)

Sets the postal or zip code.

public void
setPostalScheme(ClassificationScheme
the user defined postal scheme.
scheme)

Sets a user-defined postal scheme for codifying the attributes of PostalAddress.

public void
setStateOrProvince(String
the state or province
stateOrProvince)

Sets the state or province.

public void
setStreet(String
the street name
street)

Sets the street name.

public void
setStreetNumber(String
the street number
streetNumber)

Sets the street number.

public void
setType(String
the type for this PostalAddress. This is an arbitrary String (e.g. "Home", "Office")
type)

Sets the type of address (for example, "headquarters") as a String.

Inherited from javax.xml.registry.infomodel.ExtensibleObject:
addSlotaddSlotsgetSlotgetSlotsremoveSlotremoveSlots

Method Detail

getCityback to summary
public String getCity() throws JAXRException

Returns the city. Default is an empty String.

Capability Level: 0
Returns:String

the city

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getCountryback to summary
public String getCountry() throws JAXRException

Returns the country. Default is an empty String.

Capability Level: 0
Returns:String

the country

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getPostalCodeback to summary
public String getPostalCode() throws JAXRException

Returns the postal or zip code. Default is an empty String.

Capability Level: 0
Returns:String

the postal code (e.g. US zip code)

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getPostalSchemeback to summary
public ClassificationScheme getPostalScheme() throws JAXRException

Returns a user-defined postal scheme for codifying the attributes of PostalAddress. If none is defined for this object, then must return the default value returned by RegistryService#getDefaultPostalScheme()

Capability Level: 0
Returns:ClassificationScheme

the user defined postal scheme.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.RegistryService#getDefaultPostalScheme()
getStateOrProvinceback to summary
public String getStateOrProvince() throws JAXRException

Returns the state or province. Default is an empty String.

Capability Level: 0
Returns:String

the state or province

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getStreetback to summary
public String getStreet() throws JAXRException

Returns the street name. Default is an empty String.

Capability Level: 0
Returns:String

the street name

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getStreetNumberback to summary
public String getStreetNumber() throws JAXRException

Returns the street number. Default is an empty String.

Capability Level: 0
Returns:String

the street number

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getTypeback to summary
public String getType() throws JAXRException

Returns the type of address (for example, "headquarters") as a String.

Capability Level: 0
Returns:String

the type for this PostalAddress. This is an arbitrary String (e.g. "Home", "Office")

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setCityback to summary
public void setCity(String city) throws JAXRException

Sets the city.

Capability Level: 0
Parameters
city:String

the city

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setCountryback to summary
public void setCountry(String country) throws JAXRException

Sets the country.

Capability Level: 0
Parameters
country:String

the country

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setPostalCodeback to summary
public void setPostalCode(String postalCode) throws JAXRException

Sets the postal or zip code.

Capability Level: 0
Parameters
postalCode:String

the postal code (e.g. US zip code)

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setPostalSchemeback to summary
public void setPostalScheme(ClassificationScheme scheme) throws JAXRException

Sets a user-defined postal scheme for codifying the attributes of PostalAddress.

Capability Level: 0
Parameters
scheme:ClassificationScheme

the user defined postal scheme.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setStateOrProvinceback to summary
public void setStateOrProvince(String stateOrProvince) throws JAXRException

Sets the state or province.

Capability Level: 0
Parameters
stateOrProvince:String

the state or province

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setStreetback to summary
public void setStreet(String street) throws JAXRException

Sets the street name.

Capability Level: 0
Parameters
street:String

the street name

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setStreetNumberback to summary
public void setStreetNumber(String streetNumber) throws JAXRException

Sets the street number.

Capability Level: 0
Parameters
streetNumber:String

the street number

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setTypeback to summary
public void setType(String type) throws JAXRException

Sets the type of address (for example, "headquarters") as a String.

Capability Level: 0
Parameters
type:String

the type for this PostalAddress. This is an arbitrary String (e.g. "Home", "Office")

Exceptions
JAXRException:
If the JAXR provider encounters an internal error