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

Calls the RealEstate Webservice, that is part of the Import-/Export-API.

Author:

Andreas Rudolph

Method Summary

Methods

Modifier and Type	Method and Description
static Messages	deleteByExternalId(AbstractClient client, String externalId) Calls the DELETEbyID method.
static Messages	deleteByIs24Id(AbstractClient client, long is24Id) Calls the DELETEbyID method.
static RealEstates	getAll(AbstractClient client, String inPublishChannel, String notInPublishChannel, int pageSize, int pageNumber, boolean archivedObjectsIncluded) Calls the GETALL method.
static RealEstate	getByExternalId(AbstractClient client, String externalId) Calls the GETBYID method.
static RealEstate	getByIs24Id(AbstractClient client, long is24Id) Calls the GETBYID method.
static Messages	post(AbstractClient client, RealEstate realEstate) Calls the POST method.
static Messages	putByExternalId(AbstractClient client, RealEstate realEstate, String externalId) Calls the PUTBYID method.
static Messages	putByIs24Id(AbstractClient client, RealEstate realEstate, long is24Id) Calls the PUTBYID method.

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 externalId)
                                   throws IOException,
                                          oauth.signpost.exception.OAuthException,
                                          JAXBException,
                                          RequestFailedException

Calls the DELETEbyID method.

Parameters:

client -

externalId -

Returns:

Throws:

IOException

oauth.signpost.exception.OAuthException

JAXBException

RequestFailedException

deleteByIs24Id

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

Calls the DELETEbyID method.

Parameters:

client -

is24Id -

Returns:

Throws:

IOException

oauth.signpost.exception.OAuthException

JAXBException

RequestFailedException

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

Calls the GETALL method.

Parameters:

client -

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:

Throws:

IOException

oauth.signpost.exception.OAuthException

JAXBException

RequestFailedException

getByExternalId

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

Calls the GETBYID method.

Parameters:

client -

externalId -

Returns:

Throws:

IOException

oauth.signpost.exception.OAuthException

JAXBException

RequestFailedException

getByIs24Id

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

Calls the GETBYID method.

Parameters:

client -

is24Id -

Returns:

Throws:

IOException

oauth.signpost.exception.OAuthException

JAXBException

RequestFailedException

post

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

Calls the POST method.

Parameters:

client -

realEstate -

Returns:

Throws:

IOException

oauth.signpost.exception.OAuthException

JAXBException

RequestFailedException

putByExternalId

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

Calls the PUTBYID method.

Parameters:

client -

realEstate -

externalId -

Returns:

Throws:

IOException

oauth.signpost.exception.OAuthException

JAXBException

RequestFailedException

putByIs24Id

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

Calls the PUTBYID method.

Parameters:

client -

realEstate -

is24Id -

Returns:

Throws:

IOException

oauth.signpost.exception.OAuthException

JAXBException

RequestFailedException