org.openestate.is24.restapi

Class ImportExport.RealEstateService

java.lang.Object

org.openestate.is24.restapi.ImportExport.RealEstateService

Enclosing class:

ImportExport

public static final class ImportExport.RealEstateService
extends Object

Low level methods for the RealEstate Webservice.

The RealEstate Webservice is used in the Import-/Export-API to get / add / edit / remove real estate objects.

Since:

0.1

Author:

Andreas Rudolph

See Also:

RealEstate Webservice, Import-/Export-API

Method Summary

Modifier and Type	Method and Description
static Messages	deleteByExternalId(AbstractClient client, String externalRealEstateId) Call the DELETEbyID method of the RealEstate Webservice.
static Messages	deleteByIs24Id(AbstractClient client, long is24RealEstateId) Call the DELETEbyID method of the RealEstate Webservice.
static RealEstates	getAll(AbstractClient client, String inPublishChannel, String notInPublishChannel, int pageSize, int pageNumber, boolean archivedObjectsIncluded) Call the GETall method of the RealEstate Webservice.
static RealEstate	getByExternalId(AbstractClient client, String externalRealEstateId) Call the GETbyID method of the RealEstate Webservice.
static RealEstate	getByIs24Id(AbstractClient client, long is24RealEstateId) Call the GETbyID method of the RealEstate Webservice.
static long	post(AbstractClient client, RealEstate realEstate) Call the POST method of the RealEstate Webservice.
static long	post(AbstractClient client, RealEstate realEstate, boolean useNewEnergySourceEnev2014Values) Call the POST method of the RealEstate Webservice.
static Messages	putByExternalId(AbstractClient client, RealEstate realEstate, String externalRealEstateId) Call the PUTbyID method of the RealEstate Webservice.
static Messages	putByExternalId(AbstractClient client, RealEstate realEstate, String externalRealEstateId, boolean useNewEnergySourceEnev2014Values) Call the PUTbyID method of the RealEstate Webservice.
static Messages	putByIs24Id(AbstractClient client, RealEstate realEstate, long is24RealEstateId) Call the PUTbyID method of the RealEstate Webservice.
static Messages	putByIs24Id(AbstractClient client, RealEstate realEstate, long is24RealEstateId, boolean useNewEnergySourceEnev2014Values) Call the PUTbyID method of the RealEstate Webservice.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

deleteByExternalId

public static Messages deleteByExternalId(AbstractClient client,
                                          String externalRealEstateId)
                                   throws IOException,
                                          oauth.signpost.exception.OAuthException,
                                          JAXBException,
                                          RequestFailedException

Call the DELETEbyID method of the RealEstate Webservice.

This method removes a real estate object.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

externalRealEstateId - user defined ID of the real estate object to remove

Returns:

response of the Webservice after a successful request

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

DELETEbyID method, RealEstate Webservice

deleteByIs24Id

public static Messages deleteByIs24Id(AbstractClient client,
                                      long is24RealEstateId)
                               throws IOException,
                                      oauth.signpost.exception.OAuthException,
                                      JAXBException,
                                      RequestFailedException

Call the DELETEbyID method of the RealEstate Webservice.

This method removes a real estate object.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

is24RealEstateId - ID of the real estate object to remove, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.realestates.RealEstate)

Returns:

response of the Webservice after a successful request

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

DELETEbyID method, RealEstate Webservice

getAll

public static RealEstates getAll(AbstractClient client,
                                 String inPublishChannel,
                                 String notInPublishChannel,
                                 int pageSize,
                                 int pageNumber,
                                 boolean archivedObjectsIncluded)
                          throws IOException,
                                 oauth.signpost.exception.OAuthException,
                                 JAXBException,
                                 RequestFailedException

Call the GETall method of the RealEstate Webservice.

This method returns the list of real estate objects for the agency.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

inPublishChannel - the name of the publish channel to look for properties

notInPublishChannel - the name of the publish channel not to look for properties

pageSize - the number of properties per page (from min 1 until max 100, default 20)

pageNumber - the page number to return (starts with 1, default 1)

archivedObjectsIncluded - include archived objects into the result

Returns:

list of real estate objects

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

GETall method, RealEstate Webservice

getByExternalId

public static RealEstate getByExternalId(AbstractClient client,
                                         String externalRealEstateId)
                                  throws IOException,
                                         oauth.signpost.exception.OAuthException,
                                         JAXBException,
                                         RequestFailedException

Call the GETbyID method of the RealEstate Webservice.

This method returns a specific real estate object.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

externalRealEstateId - user defined ID of the real estate object to retrieve

Returns:

real estate object

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

GETbyID method, RealEstate Webservice

getByIs24Id

public static RealEstate getByIs24Id(AbstractClient client,
                                     long is24RealEstateId)
                              throws IOException,
                                     oauth.signpost.exception.OAuthException,
                                     JAXBException,
                                     RequestFailedException

Call the GETbyID method of the RealEstate Webservice.

This method returns a specific real estate object.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

is24RealEstateId - ID of the real estate object to retrieve, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.realestates.RealEstate)

Returns:

real estate object

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

GETbyID method, RealEstate Webservice

post

public static long post(AbstractClient client,
                        RealEstate realEstate)
                 throws IOException,
                        oauth.signpost.exception.OAuthException,
                        JAXBException,
                        RequestFailedException

Call the POST method of the RealEstate Webservice.

This method stores a new real estate object.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

realEstate - real estate object to store

Returns:

internal ID of the real estate, that was generated by the Webservice after successful creation

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

POST method, RealEstate Webservice

post

public static long post(AbstractClient client,
                        RealEstate realEstate,
                        boolean useNewEnergySourceEnev2014Values)
                 throws IOException,
                        oauth.signpost.exception.OAuthException,
                        JAXBException,
                        RequestFailedException

Call the POST method of the RealEstate Webservice.

This method stores a new real estate object.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

realEstate - real estate object to store

useNewEnergySourceEnev2014Values - tells the Webservice to make use of all values for "energySourceEnev2014" as described here (true by default)

Returns:

internal ID of the real estate, that was generated by the Webservice after successful creation

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

Since:

0.2

See Also:

POST method, RealEstate Webservice

putByExternalId

public static Messages putByExternalId(AbstractClient client,
                                       RealEstate realEstate,
                                       String externalRealEstateId)
                                throws IOException,
                                       oauth.signpost.exception.OAuthException,
                                       JAXBException,
                                       RequestFailedException

Call the PUTbyID method of the RealEstate Webservice.

This method updates a real estate object.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

realEstate - real estate object to update

externalRealEstateId - user defined ID of the real estate object to update

Returns:

response of the Webservice after a successful request

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

PUTbyID method, RealEstate Webservice

putByExternalId

public static Messages putByExternalId(AbstractClient client,
                                       RealEstate realEstate,
                                       String externalRealEstateId,
                                       boolean useNewEnergySourceEnev2014Values)
                                throws IOException,
                                       oauth.signpost.exception.OAuthException,
                                       JAXBException,
                                       RequestFailedException

Call the PUTbyID method of the RealEstate Webservice.

This method updates a real estate object.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

realEstate - real estate object to update

externalRealEstateId - user defined ID of the real estate object to update

useNewEnergySourceEnev2014Values - tells the Webservice to make use of all values for "energySourceEnev2014" as described here (true by default)

Returns:

response of the Webservice after a successful request

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

Since:

0.2

See Also:

PUTbyID method, RealEstate Webservice

putByIs24Id

public static Messages putByIs24Id(AbstractClient client,
                                   RealEstate realEstate,
                                   long is24RealEstateId)
                            throws IOException,
                                   oauth.signpost.exception.OAuthException,
                                   JAXBException,
                                   RequestFailedException

Call the PUTbyID method of the RealEstate Webservice.

This method updates a real estate object.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

realEstate - real estate object to update

is24RealEstateId - ID of the real estate object to update, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.realestates.RealEstate)

Returns:

response of the Webservice after a successful request

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

See Also:

PUTbyID method, RealEstate Webservice

putByIs24Id

public static Messages putByIs24Id(AbstractClient client,
                                   RealEstate realEstate,
                                   long is24RealEstateId,
                                   boolean useNewEnergySourceEnev2014Values)
                            throws IOException,
                                   oauth.signpost.exception.OAuthException,
                                   JAXBException,
                                   RequestFailedException

Call the PUTbyID method of the RealEstate Webservice.

This method updates a real estate object.

Parameters:

client - AbstractClient, that is used to communicate with the Webservice

realEstate - real estate object to update

is24RealEstateId - ID of the real estate object to update, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.realestates.RealEstate)

useNewEnergySourceEnev2014Values - tells the Webservice to make use of all values for "energySourceEnev2014" as described here (true by default)

Returns:

response of the Webservice after a successful request

Throws:

IOException - if communication with the Webservice failed

oauth.signpost.exception.OAuthException - if authorization failed

JAXBException - if XML reading / writing failed

RequestFailedException - if the Webservice did not respond with a success message

Since:

0.2

See Also:

PUTbyID method, RealEstate Webservice