org.openestate.is24.restapi

Class ImportExport.ContactAddressService

java.lang.Object

org.openestate.is24.restapi.ImportExport.ContactAddressService

Enclosing class:

ImportExport

public static final class ImportExport.ContactAddressService
extends Object

Low level methods for the Contact Webservice.

The Contact Webservice is used in the Import-/Export-API to get / add / edit / remove contact informations of a real estate object.

Since:

0.1

Author:

Andreas Rudolph

See Also:

Contact Webservice, Import-/Export-API

Method Summary

Methods

Modifier and Type	Method and Description
static Messages	deleteByExternalId(AbstractClient client, String externalContactId) Calls the DELETEbyID method of the Contact Webservice.
static Messages	deleteByExternalId(AbstractClient client, String externalContactId, String assignToExternalContactId) Calls the DELETEbyID method of the Contact Webservice.
static Messages	deleteByIs24Id(AbstractClient client, long is24ContactId) Calls the DELETEbyID method of the Contact Webservice.
static Messages	deleteByIs24Id(AbstractClient client, long is24ContactId, long assignToIs24ContactId) Calls the DELETEbyID method of the Contact Webservice.
static RealtorContactDetailsList	getAll(AbstractClient client) Calls the GETall method of the Contact Webservice.
static RealtorContactDetails	getByExternalId(AbstractClient client, String externalContactId) Calls the GETbyID method of the Contact Webservice.
static RealtorContactDetails	getByIs24Id(AbstractClient client, long is24ContactId) Calls the GETbyID method of the Contact Webservice.
static long	post(AbstractClient client, RealtorContactDetails contact) Calls the POST method of the Contact Webservice.
static Messages	putByExternalId(AbstractClient client, RealtorContactDetails contact, String externalContactId) Calls the PUTbyID method of the Contact Webservice.
static Messages	putByIs24Id(AbstractClient client, RealtorContactDetails contact, long is24ContactId) Calls the PUTbyID method of the Contact 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 externalContactId)
                                   throws IOException,
                                          oauth.signpost.exception.OAuthException,
                                          JAXBException,
                                          RequestFailedException

Calls the DELETEbyID method of the Contact Webservice.

This method removes a contact person.

Parameters:

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

externalContactId - user defined ID of the contact, for which the contact is removed

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:

DELETE method, Contact Webservice

deleteByExternalId

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

Calls the DELETEbyID method of the Contact Webservice.

This method removes a contact person.

Parameters:

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

externalContactId - user defined ID of the contact, for which the contact is removed

assignToExternalContactId - user defined ID of another contact, where real estates of the removed contact are assigned to

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:

DELETE method, Contact Webservice

deleteByIs24Id

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

Calls the DELETEbyID method of the Contact Webservice.

This method removes a contact person.

Parameters:

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

is24ContactId - ID of the contact object, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.common.RealtorContactDetails), for which the contact is removed

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:

DELETE method, Contact Webservice

deleteByIs24Id

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

Calls the DELETEbyID method of the Contact Webservice.

This method removes a contact person.

Parameters:

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

is24ContactId - ID of the contact object, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.common.RealtorContactDetails), for which the contact is removed

assignToIs24ContactId - ID of the contact object, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.common.RealtorContactDetails), where real estates of the removed contact are assigned to

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:

DELETE method, Contact Webservice

getAll

public static RealtorContactDetailsList getAll(AbstractClient client)
                                        throws IOException,
                                               oauth.signpost.exception.OAuthException,
                                               JAXBException,
                                               RequestFailedException

Calls the GETall method of the Contact Webservice.

This method returns the list of contacts for the agency.

Parameters:

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

Returns:

list of contacts

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, Contact Webservice

getByExternalId

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

Calls the GETbyID method of the Contact Webservice.

This method returns a specific contact for the agency.

Parameters:

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

externalContactId - user defined ID of the contact, for which the contact is retrieved

Returns:

requested contact

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, Contact Webservice

getByIs24Id

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

Calls the GETbyID method of the Contact Webservice.

This method returns a specific contact for the agency.

Parameters:

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

is24ContactId - ID of the contact object, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.common.RealtorContactDetails), for which the contact is retrieved

Returns:

requested contact

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, Contact Webservice

post

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

Calls the POST method of the Contact Webservice.

This method stores a new contact for the agency.

Parameters:

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

contact - contact to set

Returns:

internal ID of the contact person, 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, Contact Webservice

putByExternalId

public static Messages putByExternalId(AbstractClient client,
                       RealtorContactDetails contact,
                       String externalContactId)
                                throws IOException,
                                       oauth.signpost.exception.OAuthException,
                                       JAXBException,
                                       RequestFailedException

Calls the PUTbyID method of the Contact Webservice.

This method updates a specific contact for the agency.

Parameters:

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

contact - contact to set

externalContactId - user defined ID of the contact, for which contact is updated

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, Contact Webservice

putByIs24Id

public static Messages putByIs24Id(AbstractClient client,
                   RealtorContactDetails contact,
                   long is24ContactId)
                            throws IOException,
                                   oauth.signpost.exception.OAuthException,
                                   JAXBException,
                                   RequestFailedException

Calls the PUTbyID method of the Contact Webservice.

This method updates a specific contact for the agency.

Parameters:

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

contact - contact to set

is24ContactId - ID of the contact object, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.common.RealtorContactDetails), for which the contact is updated

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, Contact Webservice