org.openestate.is24.restapi

Class ImportExport.AttachmentsOrderService

java.lang.Object

org.openestate.is24.restapi.ImportExport.AttachmentsOrderService

Enclosing class:

ImportExport

public static final class ImportExport.AttachmentsOrderService
extends Object

Low level methods for the AttachmentsOrder Webservice.

The AttachmentsOrder Webservice is used in the Import-/Export-API to set a specific ordering for the attachments of a real estate object.

Since:

0.1

Author:

Andreas Rudolph

See Also:

Attachment Webservice, Import-/Export-API

Constructor Summary

Constructors

Constructor and Description
ImportExport.AttachmentsOrderService()

Method Summary

Methods

Modifier and Type	Method and Description
static List	get(AbstractClient client, long is24RealEstateIdId) Calls the GET method of the AttachmentsOrder Webservice.
static List	get(AbstractClient client, String externalRealEstateId) Calls the GET method of the AttachmentsOrder Webservice.
static Messages	put(AbstractClient client, long is24RealEstateIdId, List list) Calls the PUT method of the AttachmentsOrder Webservice.
static Messages	put(AbstractClient client, String externalRealEstateId, List list) Calls the PUT method of the AttachmentsOrder Webservice.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportExport.AttachmentsOrderService

public ImportExport.AttachmentsOrderService()

Method Detail

get

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

Calls the GET method of the AttachmentsOrder Webservice.

This method returns the attachment ordering for 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, for which the attachment ordering is retrieved

Returns:

attachment ordering for the requested 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:

GET method, Attachment Webservice

get

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

Calls the GET method of the AttachmentsOrder Webservice.

This method returns the attachment ordering for a specific real estate object.

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 attachment ordering is retrieved

Returns:

attachment ordering for the requested 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:

GET method, Attachment Webservice

put

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

Calls the PUT method of the AttachmentsOrder Webservice.

This method changes the attachment ordering for 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, for which the attachment ordering is changed

list - attachment ordering to set

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:

PUT method, Attachment Webservice

put

public static Messages put(AbstractClient client,
           long is24RealEstateIdId,
           List list)
                    throws IOException,
                           oauth.signpost.exception.OAuthException,
                           JAXBException,
                           RequestFailedException

Calls the PUT method of the AttachmentsOrder Webservice.

This method changes the attachment ordering for a specific real estate object.

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 attachment ordering is changed

list - attachment ordering to set

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:

PUT method, Attachment Webservice