com.bigllc.retsiq.simpleclient.api
Class SimpleRets

java.lang.Object
  com.bigllc.retsiq.simpleclient.api.SimpleRets

public final class SimpleRets
extends java.lang.Object

A wrapper around RETSUserSession that provides different style of RETS API.

Author:

Michael Watt

Constructor Summary

SimpleRets(RETSUserSession session)
Create a Simple RETS api wrapper around the provided RETs user session.

Method Summary

SimpleAction	action() Create a new action request object which can be used to execute RETS action transactions using the wrapped RETS user session.
SimpleCountRecords	count(java.lang.String resource, java.lang.String cls) Create a new count request object which can be used to execute RETS search transactions, which return a record count only, using the wrapped RETS user session
SimpleGetMetadata	getMetadata() Create a new getmetadata request object which can be used to execute RETS getmetadata transactions using the wrapped RETS user session.
RETSUserSession	getUserSession() Retrieve the wrapped RETS user session, which may be used to execute get and post object transactions (which are currently unwrapped).
SimpleLogout	logout() Create a new logout request object which can be used to execute RETS logout transactions using the wrapped RETS user session.
SimpleSearch	search(java.lang.String resource, java.lang.String cls) Create a new search request object which can be used to execute RETS search transactions using the wrapped RETS user session.
SimpleUpdate	update(java.lang.String resource, java.lang.String cls, java.lang.String type) Create a new update request object which can be used to execute RETS update transactions using the wrapped RETS user session.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRets

public SimpleRets(RETSUserSession session)

Create a Simple RETS api wrapper around the provided RETs user session.

Parameters:

session - The RETS user session to wrap.

Method Detail

getUserSession

public RETSUserSession getUserSession()

Retrieve the wrapped RETS user session, which may be used to execute get and post object transactions (which are currently unwrapped).

logout

public SimpleLogout logout()

Create a new logout request object which can be used to execute RETS logout transactions using the wrapped RETS user session. Note that calling this method does not log the session out, it only create a logout request object. You must still call SimpleLogout.execute().

search

public SimpleSearch search(java.lang.String resource,
                           java.lang.String cls)

Create a new search request object which can be used to execute RETS search transactions using the wrapped RETS user session.

update

public SimpleUpdate update(java.lang.String resource,
                           java.lang.String cls,
                           java.lang.String type)

Create a new update request object which can be used to execute RETS update transactions using the wrapped RETS user session.

count

public SimpleCountRecords count(java.lang.String resource,
                                java.lang.String cls)

Create a new count request object which can be used to execute RETS search transactions, which return a record count only, using the wrapped RETS user session

getMetadata

public SimpleGetMetadata getMetadata()

Create a new getmetadata request object which can be used to execute RETS getmetadata transactions using the wrapped RETS user session.

action

public SimpleAction action()

Create a new action request object which can be used to execute RETS action transactions using the wrapped RETS user session.