org.openestate.is24.restapi

Class ImportExport.PublishService

java.lang.Object

org.openestate.is24.restapi.ImportExport.PublishService

Enclosing class:

ImportExport

public static final class ImportExport.PublishService
extends Object

Low level methods for the Publish Webservice.

The Publish Webservice is used in the Import-/Export-API to publish / unpublish a real estate object.

Since:

0.1

Author:

Andreas Rudolph

See Also:

Publish Webservice, Import-/Export-API

Method Summary

Methods

Modifier and Type	Method and Description
static Messages	delete(AbstractClient client, String is24PublishId) Calls the DELETEbyID method of the Publish Webservice.
static PublishObjects	delete(AbstractClient client, String[] is24PublishIds) Calls the DELETEbyList method of the Publish Webservice.
static Messages	deleteById(AbstractClient client, String is24PublishId) Deprecated. use delete(org.openestate.is24.restapi.AbstractClient, java.lang.String) instead
static PublishObjects	get(AbstractClient client, long is24RealEstateIdId, long is24PublishChannelId) Calls the GET method of the Publish Webservice.
static PublishObject	getById(AbstractClient client, String is24PublishId) Calls the GETbyID method of the Publish Webservice.
static String	post(AbstractClient client, PublishObject publishObject) Calls the POSTbyID method of the Publish Webservice.
static PublishObjects	post(AbstractClient client, PublishObjects publishObjects) Calls the POST method of the Publish Webservice.

Methods inherited from class java.lang.Object

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

Method Detail

delete

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

Calls the DELETEbyID method of the Publish Webservice.

This method removes the attribution of a real estate object to a publish channel.

Parameters:

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

is24PublishId - the unique publishing ID, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.common.PublishObject), for which the publishing 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:

DELETEbyID method, Publish Webservice

delete

public static PublishObjects delete(AbstractClient client,
                    String[] is24PublishIds)
                             throws IOException,
                                    oauth.signpost.exception.OAuthException,
                                    JAXBException,
                                    RequestFailedException

Calls the DELETEbyList method of the Publish Webservice.

This method removes the attribution of a real estate object to a publish channel.

Parameters:

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

is24PublishIds - list of unique publishing ID's, that were returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.common.PublishObject), for which the publishing are 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:

DELETEbyList method, Publish Webservice

deleteById

@Deprecated
public static Messages deleteById(AbstractClient client,
                             String is24PublishId)
                           throws IOException,
                                  oauth.signpost.exception.OAuthException,
                                  JAXBException,
                                  RequestFailedException

Deprecated. use delete(org.openestate.is24.restapi.AbstractClient, java.lang.String) instead

Calls the DELETEbyID method of the Publish Webservice.

This method removes the attribution of a real estate object to a publish channel.

Parameters:

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

is24PublishId - the unique publishing ID, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.common.PublishObject), for which the publishing 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

See Also:

DELETEbyID method, Publish Webservice

get

public static PublishObjects get(AbstractClient client,
                 long is24RealEstateIdId,
                 long is24PublishChannelId)
                          throws IOException,
                                 oauth.signpost.exception.OAuthException,
                                 JAXBException,
                                 RequestFailedException

Calls the GET method of the Publish Webservice.

This method returns a list of the publish channels, where a real estate object is published.

Parameters:

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

is24RealEstateIdId - ID of the real estate object, that was returned by ImportExport.RealEstateService.post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.realestates.RealEstate), for which the publishing are retrieved

is24PublishChannelId - the ID of a certain publish channel (optional, default 0)

Returns:

list of publish channels, that the requested real estate object is assigned to

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:

GET method, Publish Webservice

getById

public static PublishObject getById(AbstractClient client,
                    String is24PublishId)
                             throws IOException,
                                    oauth.signpost.exception.OAuthException,
                                    JAXBException,
                                    RequestFailedException

Calls the GETbyID method of the Publish Webservice.

This method returns a specific publish channel, where a real estate object is published.

Parameters:

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

is24PublishId - the unique publishing ID, that was returned by post(org.openestate.is24.restapi.AbstractClient, org.openestate.is24.restapi.xml.common.PublishObject), for which the publishing is removed

Returns:

requested publishing

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

post

public static String post(AbstractClient client,
          PublishObject publishObject)
                   throws IOException,
                          oauth.signpost.exception.OAuthException,
                          JAXBException,
                          RequestFailedException

Calls the POSTbyID method of the Publish Webservice.

This method publishes a real estate object into a publish channel.

Parameters:

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

publishObject - publishing to set

Returns:

internal ID of the publishing, 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:

POSTbyID method, Publish Webservice

post

public static PublishObjects post(AbstractClient client,
                  PublishObjects publishObjects)
                           throws IOException,
                                  oauth.signpost.exception.OAuthException,
                                  JAXBException,
                                  RequestFailedException

Calls the POST method of the Publish Webservice.

This method publishes mulitple real estate objects at once.

Parameters:

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

publishObjects - publishings to set

Returns:

internal ID of the publishing, 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, Publish Webservice