org.openestate.is24.restapi

Class ImportExport.AttachmentService

java.lang.Object

org.openestate.is24.restapi.ImportExport.AttachmentService

Enclosing class:

ImportExport

public static final class ImportExport.AttachmentService
extends Object

Low level methods for the Attachment Webservice.

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

Since:

0.1

Author:

Andreas Rudolph

See Also:

Attachment Webservice, Import-/Export-API

Method Summary

Modifier and Type	Method and Description
static Messages	deleteById(AbstractClient client, long is24RealEstateIdId, long is24AttachmentId) Call the DELETEbyID method of the Attachment Webservice.
static Messages	deleteById(AbstractClient client, String externalRealEstateId, long is24AttachmentId) Call the DELETEbyID method of the Attachment Webservice.
static Attachments	getAll(AbstractClient client, long is24RealEstateIdId) Call the GETall method of the Attachment Webservice.
static Attachments	getAll(AbstractClient client, String externalRealEstateId) Call the GETall method of the Attachment Webservice.
static Attachment	getById(AbstractClient client, long is24RealEstateIdId, long is24AttachmentId) Call the GETbyID method of the Attachment Webservice.
static Attachment	getById(AbstractClient client, long is24RealEstateIdId, String externalAttachmentId) Call the GETbyID method of the Attachment Webservice.
static Attachment	getById(AbstractClient client, String externalRealEstateId, long is24AttachmentId) Call the GETbyID method of the Attachment Webservice.
static Attachment	getById(AbstractClient client, String externalRealEstateId, String externalAttachmentId) Call the GETbyID method of the Attachment Webservice.
static long	post(AbstractClient client, long is24RealEstateIdId, Attachment attachment, InputStream input, String fileName, String mimeType) Call the POST method of the Attachment Webservice.
static long	post(AbstractClient client, String externalRealEstateId, Attachment attachment, InputStream input, String fileName, String mimeType) Call the POST method of the Attachment Webservice.
static Messages	putById(AbstractClient client, long is24RealEstateIdId, long is24AttachmentId, Attachment attachment) Call the PUTbyID method of the Attachment Webservice.
static Messages	putById(AbstractClient client, String externalRealEstateId, long is24AttachmentId, Attachment attachment) Call the PUTbyID method of the Attachment Webservice.

Methods inherited from class java.lang.Object

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

Method Detail

deleteById

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

Call the DELETEbyID method of the Attachment Webservice.

This method removes the attachment of a 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 is removed

is24AttachmentId - ID of the attachment to remove, that was returned by post(org.openestate.is24.restapi.AbstractClient, java.lang.String, org.openestate.is24.restapi.xml.common.Attachment, java.io.InputStream, java.lang.String, java.lang.String)

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

deleteById

public static Messages deleteById(AbstractClient client,
                                  long is24RealEstateIdId,
                                  long is24AttachmentId)
                           throws IOException,
                                  oauth.signpost.exception.OAuthException,
                                  JAXBException,
                                  RequestFailedException

Call the DELETEbyID method of the Attachment Webservice.

This method removes the attachment of a 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 is removed

is24AttachmentId - ID of the attachment to remove, that was returned by post(org.openestate.is24.restapi.AbstractClient, long, org.openestate.is24.restapi.xml.common.Attachment, java.io.InputStream, java.lang.String, java.lang.String)

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

getAll

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

Call the GETall method of the Attachment Webservice.

This method returns the list of attachments for a 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 list of attachments is retrieved

Returns:

list of attachments 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:

GETall method, Attachment Webservice

getAll

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

Call the GETall method of the Attachment Webservice.

This method returns the list of attachments for a 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 list of attachments is retrieved

Returns:

list of attachments 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:

GETall method, Attachment Webservice

getById

public static Attachment getById(AbstractClient client,
                                 String externalRealEstateId,
                                 long is24AttachmentId)
                          throws IOException,
                                 oauth.signpost.exception.OAuthException,
                                 JAXBException,
                                 RequestFailedException

Call the GETbyID method of the Attachment Webservice.

This method returns a specific attachment for a 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 is retrieved

is24AttachmentId - ID of the requested attachment, that was returned by post(org.openestate.is24.restapi.AbstractClient, java.lang.String, org.openestate.is24.restapi.xml.common.Attachment, java.io.InputStream, java.lang.String, java.lang.String)

Returns:

requested attachment

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

getById

public static Attachment getById(AbstractClient client,
                                 String externalRealEstateId,
                                 String externalAttachmentId)
                          throws IOException,
                                 oauth.signpost.exception.OAuthException,
                                 JAXBException,
                                 RequestFailedException

Call the GETbyID method of the Attachment Webservice.

This method returns a specific attachment for a 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 is retrieved

externalAttachmentId - user defined ID of the attachment to retrieve

Returns:

requested attachment

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:

GETbyID method, Attachment Webservice

getById

public static Attachment getById(AbstractClient client,
                                 long is24RealEstateIdId,
                                 long is24AttachmentId)
                          throws IOException,
                                 oauth.signpost.exception.OAuthException,
                                 JAXBException,
                                 RequestFailedException

Call the GETbyID method of the Attachment Webservice.

This method returns a specific attachment for a 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 is retrieved

is24AttachmentId - ID of the requested attachment, that was returned by post(org.openestate.is24.restapi.AbstractClient, long, org.openestate.is24.restapi.xml.common.Attachment, java.io.InputStream, java.lang.String, java.lang.String)

Returns:

requested attachment

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

getById

public static Attachment getById(AbstractClient client,
                                 long is24RealEstateIdId,
                                 String externalAttachmentId)
                          throws IOException,
                                 oauth.signpost.exception.OAuthException,
                                 JAXBException,
                                 RequestFailedException

Call the GETbyID method of the Attachment Webservice.

This method returns a specific attachment for a 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 is retrieved

externalAttachmentId - user defined ID of the attachment to retrieve

Returns:

requested attachment

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:

GETbyID method, Attachment Webservice

post

public static long post(AbstractClient client,
                        String externalRealEstateId,
                        Attachment attachment,
                        InputStream input,
                        String fileName,
                        String mimeType)
                 throws IOException,
                        oauth.signpost.exception.OAuthException,
                        JAXBException,
                        RequestFailedException

Call the POST method of the Attachment Webservice.

This method stores a new attachment 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 is stored

attachment - details about the attachment

input - InputStream with the file content of the attachment

fileName - file name of the attachment

mimeType - MIME type of the attachment

Returns:

internal ID of the attachment, 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, Attachment Webservice

post

public static long post(AbstractClient client,
                        long is24RealEstateIdId,
                        Attachment attachment,
                        InputStream input,
                        String fileName,
                        String mimeType)
                 throws IOException,
                        oauth.signpost.exception.OAuthException,
                        JAXBException,
                        RequestFailedException

Call the POST method of the Attachment Webservice.

This method stores a new attachment 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 is stored

attachment - details about the attachment

input - InputStream with the file content of the attachment

fileName - file name of the attachment

mimeType - MIME type of the attachment

Returns:

internal ID of the attachment, 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, Attachment Webservice

putById

public static Messages putById(AbstractClient client,
                               String externalRealEstateId,
                               long is24AttachmentId,
                               Attachment attachment)
                        throws IOException,
                               oauth.signpost.exception.OAuthException,
                               JAXBException,
                               RequestFailedException

Call the PUTbyID method of the Attachment Webservice.

This method updates the informations about an attachment for a specific real estate object.

This method only updates the metadata of an attachment. If the file content itself has changed, a new POST request must be executed.

Parameters:

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

externalRealEstateId - user defined ID of the real estate object, for which the attachment is updated

is24AttachmentId - ID of the attachment to update, that was returned by post(org.openestate.is24.restapi.AbstractClient, java.lang.String, org.openestate.is24.restapi.xml.common.Attachment, java.io.InputStream, java.lang.String, java.lang.String)

attachment - details about the attachment

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

putById

public static Messages putById(AbstractClient client,
                               long is24RealEstateIdId,
                               long is24AttachmentId,
                               Attachment attachment)
                        throws IOException,
                               oauth.signpost.exception.OAuthException,
                               JAXBException,
                               RequestFailedException

Call the PUTbyID method of the Attachment Webservice.

This method updates the informations about an attachment for a specific real estate object.

This method only updates the metadata of an attachment. If the file content itself has changed, a new POST request must be executed.

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 is updated

is24AttachmentId - ID of the attachment to update, that was returned by post(org.openestate.is24.restapi.AbstractClient, long, org.openestate.is24.restapi.xml.common.Attachment, java.io.InputStream, java.lang.String, java.lang.String)

attachment - details about the attachment

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