com.bigllc.retsiq.simpleclient
Class PayloadDescriptor

java.lang.Object
  extended by com.bigllc.retsiq.simpleclient.PayloadDescriptor

public class PayloadDescriptor
extends java.lang.Object

Payload list data item bean. This contains the results from a data row from the GetPayload list transaction.

Author:
Marc G. Smith

Constructor Summary
PayloadDescriptor(com.bigllc.retsiq.api.RetsPayload payload)
           
 
Method Summary
 java.lang.String getClassName()
          The class name that the payload can be used on.
 java.lang.String getDescription()
          The description of the payload.
 java.lang.String getMetadataEntryId()
          The metadata entry id for the payload.
 java.lang.String getPayloadName()
          The pay load name to be used in a payload search.
 java.lang.String getResourceId()
          The resource id that the payload can be used on.
 java.lang.String getUri()
          The uri for the payload definition (we think).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PayloadDescriptor

public PayloadDescriptor(com.bigllc.retsiq.api.RetsPayload payload)
Method Detail

getPayloadName

public java.lang.String getPayloadName()
The pay load name to be used in a payload search.

Returns:
the name

getResourceId

public java.lang.String getResourceId()
The resource id that the payload can be used on.

Returns:
the resource id

getClassName

public java.lang.String getClassName()
The class name that the payload can be used on.

Returns:
the class name

getDescription

public java.lang.String getDescription()
The description of the payload.

Returns:
the payload description.

getUri

public java.lang.String getUri()
The uri for the payload definition (we think).

Returns:
the uri

getMetadataEntryId

public java.lang.String getMetadataEntryId()
The metadata entry id for the payload.

Returns:
the metadata entry id