com.bigllc.retsiq.metadata
Class MetadataUpdateType

java.lang.Object
  com.bigllc.retsiq.metadata.MetadataTableMap
      com.bigllc.retsiq.metadata.MetadataUpdateType

public class MetadataUpdateType
extends MetadataTableMap

Field Summary

static java.lang.String	DATE
static java.lang.String	DESCRIPTION
static java.lang.String	KEY_FIELD
static java.lang.String	METADATA_ENTRY_ID
static java.lang.String	REQUIRES_BEGIN
static java.lang.String	UPDATE_ACTION
static java.lang.String	UPDATE_DATE
static java.lang.String	UPDATE_DATE_172
static java.lang.String	UPDATE_NAME
static java.lang.String	UPDATE_VERSION
static java.lang.String	UPDATE_VERSION_172
static java.lang.String	VERSION

Fields inherited from class com.bigllc.retsiq.metadata.MetadataTableMap

map, nameKey, parent

Constructor Summary

MetadataUpdateType(java.util.Map<java.lang.String,java.lang.String> map)

MetadataUpdateType(java.util.Map<java.lang.String,java.lang.String> map, java.util.List<MetadataUpdateTypeField> fields)

Method Summary

java.lang.String	getAttributeName()
MetadataTableMap	getChild(com.bigllc.retsiq.api.RETSConstants.MetadataType type, java.lang.String name)
java.lang.String	getChildDate(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
java.util.List<? extends MetadataTableMap>	getChildren(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
java.util.Map<java.lang.String,? extends MetadataTableMap>	getChildrenLookup(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
com.bigllc.retsiq.api.RETSConstants.MetadataType[]	getChildTypes()
java.lang.String	getChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
java.lang.String	getDate()
java.lang.String	getDescription()
java.util.List<java.lang.String>	getDisplayKeys()
MetadataUpdateTypeField	getField(java.lang.String systemName)
java.util.Map<java.lang.String,MetadataUpdateTypeField>	getFieldMap()
java.util.List<MetadataUpdateTypeField>	getFields()
java.lang.String	getKeyField()
java.lang.String	getMetadataEntryId() A value that never changes as long as the semantic definition of this field remains unchanged.
com.bigllc.retsiq.api.RETSConstants.MetadataType	getMetadataType()
boolean	getRequiresBegin() If this value is TRUE (1), the BeginUpdate action MUST be called before this update action.
java.lang.String	getUpdateName()
java.lang.String	getVersion()
void	setChildDate(com.bigllc.retsiq.api.RETSConstants.MetadataType type, java.lang.String date)
void	setChildrenList(com.bigllc.retsiq.api.RETSConstants.MetadataType type, java.util.List<? extends MetadataTableMap> children) This method should be implemented to set the underlying list to the one passed.
void	setChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type, java.lang.String version)

Methods inherited from class com.bigllc.retsiq.metadata.MetadataTableMap

addChild, find, get, getDepth, getFullPath, getFullPathName, getKeys, getMap, getName, getNameKey, getParent, getPathStack, getReversePathStack, getRoot, getSystem, hasDuplicateChildren, hasEmptyAttribute, isChildOf, removeChild, removeChild, setChildren, setParent, toString

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_ENTRY_ID

public static final java.lang.String METADATA_ENTRY_ID

See Also:

Constant Field Values

UPDATE_NAME

public static final java.lang.String UPDATE_NAME

See Also:

Constant Field Values

UPDATE_ACTION

public static final java.lang.String UPDATE_ACTION

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

KEY_FIELD

public static final java.lang.String KEY_FIELD

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

DATE

public static final java.lang.String DATE

See Also:

Constant Field Values

UPDATE_VERSION

public static final java.lang.String UPDATE_VERSION

See Also:

Constant Field Values

UPDATE_DATE

public static final java.lang.String UPDATE_DATE

See Also:

Constant Field Values

UPDATE_VERSION_172

public static final java.lang.String UPDATE_VERSION_172

See Also:

Constant Field Values

UPDATE_DATE_172

public static final java.lang.String UPDATE_DATE_172

See Also:

Constant Field Values

REQUIRES_BEGIN

public static final java.lang.String REQUIRES_BEGIN

See Also:

Constant Field Values

Constructor Detail

MetadataUpdateType

public MetadataUpdateType(java.util.Map<java.lang.String,java.lang.String> map)

MetadataUpdateType

public MetadataUpdateType(java.util.Map<java.lang.String,java.lang.String> map,
                          java.util.List<MetadataUpdateTypeField> fields)

Method Detail

getMetadataEntryId

public java.lang.String getMetadataEntryId()

A value that never changes as long as the semantic definition of this field remains unchanged. Since RETS/1.7

getUpdateName

public java.lang.String getUpdateName()

getDescription

public java.lang.String getDescription()

getKeyField

public java.lang.String getKeyField()

getRequiresBegin

public boolean getRequiresBegin()

If this value is TRUE (1), the BeginUpdate action MUST be called before this update action. Since RETS/1.8

getVersion

public java.lang.String getVersion()

getDate

public java.lang.String getDate()

getFields

public java.util.List<MetadataUpdateTypeField> getFields()

getField

public MetadataUpdateTypeField getField(java.lang.String systemName)

getFieldMap

public java.util.Map<java.lang.String,MetadataUpdateTypeField> getFieldMap()

getMetadataType

public com.bigllc.retsiq.api.RETSConstants.MetadataType getMetadataType()

Specified by:

getMetadataType in class MetadataTableMap

getAttributeName

public java.lang.String getAttributeName()

Specified by:

getAttributeName in class MetadataTableMap

getChildDate

public java.lang.String getChildDate(com.bigllc.retsiq.api.RETSConstants.MetadataType type)

Specified by:

getChildDate in class MetadataTableMap

setChildDate

public void setChildDate(com.bigllc.retsiq.api.RETSConstants.MetadataType type,
                         java.lang.String date)

Specified by:

setChildDate in class MetadataTableMap

setChildVersion

public void setChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type,
                            java.lang.String version)

Specified by:

setChildVersion in class MetadataTableMap

getChildVersion

public java.lang.String getChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type)

Specified by:

getChildVersion in class MetadataTableMap

getChildren

public java.util.List<? extends MetadataTableMap> getChildren(com.bigllc.retsiq.api.RETSConstants.MetadataType type)

Specified by:

getChildren in class MetadataTableMap

getChild

public MetadataTableMap getChild(com.bigllc.retsiq.api.RETSConstants.MetadataType type,
                                 java.lang.String name)

Overrides:

getChild in class MetadataTableMap

setChildrenList

public void setChildrenList(com.bigllc.retsiq.api.RETSConstants.MetadataType type,
                            java.util.List<? extends MetadataTableMap> children)

Description copied from class: MetadataTableMap

This method should be implemented to set the underlying list to the one passed. It is called from setChildren. Lookups are and setParent are handled by setChildren.

Specified by:

setChildrenList in class MetadataTableMap

Parameters:

type - the metadata type of the list

children - the list containing the children nodes.

getChildrenLookup

public java.util.Map<java.lang.String,? extends MetadataTableMap> getChildrenLookup(com.bigllc.retsiq.api.RETSConstants.MetadataType type)

Specified by:

getChildrenLookup in class MetadataTableMap

getDisplayKeys

public java.util.List<java.lang.String> getDisplayKeys()

Overrides:

getDisplayKeys in class MetadataTableMap

getChildTypes

public com.bigllc.retsiq.api.RETSConstants.MetadataType[] getChildTypes()

Overrides:

getChildTypes in class MetadataTableMap