com.bigllc.retsiq.simpleclient
Class ObjectRecord

java.lang.Object
  com.bigllc.retsiq.simpleclient.ObjectRecord

public class ObjectRecord
extends java.lang.Object

Simple bean with information returned from getObjects() and getObjectUrls().

Author:

Marc G. Smith

See Also:

RETSUserSession.getObjectUrl(String), RETSUserSession.getObjectUrls(String), RETSUserSession.getObjects(String, File)

Method Summary

java.lang.String	getContentId() The content id for this object reference.
java.lang.String	getDescription() If a description was supplied with the object then return the description.
java.lang.String	getMimeType() The MIME type for this object reference.
java.lang.String	getObjectId() The object id for this object reference.
java.lang.String	getUri() The location of this object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getDescription

public java.lang.String getDescription()

If a description was supplied with the object then return the description.

Returns:

The description if supplied or null.

getContentId

public java.lang.String getContentId()

The content id for this object reference. Typically the classification key such as the UID or MLS#.

Returns:

The content ID for the object.

getMimeType

public java.lang.String getMimeType()

The MIME type for this object reference. If this object references a URL to the object then this may be null.

Returns:

The MIME type for the object or null if not supplied.

getObjectId

public java.lang.String getObjectId()

The object id for this object reference.

Returns:

The object ID for the object.

getUri

public java.lang.String getUri()

The location of this object. If the object was retrieved it will reference the absolute path. If the object's location was requested it will reference a URL.

Returns:

A file path or URL to the object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object