com.bigllc.retsiq.metadata
Class MetadataUpdateTypeField

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

public class MetadataUpdateTypeField
extends MetadataTableMap

Field Summary

static java.lang.String	ATTRIBUTES
static java.lang.String	DEFAULT
static java.lang.String	MAX_UPDATE
static java.lang.String	METADATA_ENTRY_ID
static java.lang.String	SEARCH_QUERY_ORDER
static java.lang.String	SEARCH_RESULT_ORDER
static java.lang.String	SEQUENCE
static java.lang.String	SYSTEM_NAME
static java.lang.String	UPDATE_HELP_ID
static java.lang.String	VALIDATION_EXPRESSION_ID
static java.lang.String	VALIDATION_EXTERNAL_NAME
static java.lang.String	VALIDATION_LOOKUP_NAME This is deprecated since 1.8 but we'll leave it in for now as it will have a huge effect on live systems.

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

map, nameKey, parent

Constructor Summary

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

Method Summary

java.lang.String	getAttributeName()
java.lang.String[]	getAttributes()
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)
java.lang.String	getChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
java.lang.String	getDefault()
java.util.List<java.lang.String>	getDisplayKeys()
int	getMaxUpdate() For LookupMulti fields, the maximum number of values that may be specified for the field.
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()
java.lang.Integer	getSearchQueryOrder() The order that fields should appear in a default search screen that is executed in order to give the user a list of existing records to select from for updating.
java.lang.Integer	getSearchResultOrder() The order that fields should appear in a default one-liner search result that is executed in order to give the user a list of existing records to select from for updating.
java.lang.String	getSequence()
java.lang.String	getSystemName()
MetadataTable	getTableField()
java.lang.String	getUpdateHelp()
java.lang.String	getUpdateHelpID()
java.lang.String	getValidatationExpressionID()
MetadataValidationExpression[]	getValidationExpressions()
java.lang.String	getValidationExternalName()
MetadataValidationLookup	getValidationLookup()
java.lang.String	getValidationLookupName()
boolean	isAutopop()
boolean	isClearOnClone()
boolean	isDisplayOnly()
boolean	isHidden()
boolean	isInteractiveValidate()
boolean	isRequired()
boolean	isStaffEditable() Deprecated.
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, getChild, getChildTypes, 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

SYSTEM_NAME

public static final java.lang.String SYSTEM_NAME

See Also:

Constant Field Values

SEQUENCE

public static final java.lang.String SEQUENCE

See Also:

Constant Field Values

ATTRIBUTES

public static final java.lang.String ATTRIBUTES

See Also:

Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT

See Also:

Constant Field Values

VALIDATION_EXPRESSION_ID

public static final java.lang.String VALIDATION_EXPRESSION_ID

See Also:

Constant Field Values

UPDATE_HELP_ID

public static final java.lang.String UPDATE_HELP_ID

See Also:

Constant Field Values

VALIDATION_LOOKUP_NAME

public static final java.lang.String VALIDATION_LOOKUP_NAME

This is deprecated since 1.8 but we'll leave it in for now as it will have a huge effect on live systems.

See Also:

Constant Field Values

VALIDATION_EXTERNAL_NAME

public static final java.lang.String VALIDATION_EXTERNAL_NAME

See Also:

Constant Field Values

MAX_UPDATE

public static final java.lang.String MAX_UPDATE

See Also:

Constant Field Values

SEARCH_RESULT_ORDER

public static final java.lang.String SEARCH_RESULT_ORDER

See Also:

Constant Field Values

SEARCH_QUERY_ORDER

public static final java.lang.String SEARCH_QUERY_ORDER

See Also:

Constant Field Values

Constructor Detail

MetadataUpdateTypeField

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

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

getSystemName

public java.lang.String getSystemName()

getSequence

public java.lang.String getSequence()

getMaxUpdate

public int getMaxUpdate()

For LookupMulti fields, the maximum number of values that may be specified for the field. This value has no meaning for fields with any other interpretation. Since RETS/1.7

Returns:

the max update or -1 if empty or parsing error occurs.

getAttributes

public java.lang.String[] getAttributes()

isRequired

public boolean isRequired()

isDisplayOnly

public boolean isDisplayOnly()

isAutopop

public boolean isAutopop()

isHidden

public boolean isHidden()

isStaffEditable

@Deprecated
public boolean isStaffEditable()

Deprecated.

isClearOnClone

public boolean isClearOnClone()

isInteractiveValidate

public boolean isInteractiveValidate()

getDefault

public java.lang.String getDefault()

getValidatationExpressionID

public java.lang.String getValidatationExpressionID()

getUpdateHelpID

public java.lang.String getUpdateHelpID()

getUpdateHelp

public java.lang.String getUpdateHelp()

getValidationLookupName

public java.lang.String getValidationLookupName()

getValidationLookup

public MetadataValidationLookup getValidationLookup()

getValidationExternalName

public java.lang.String getValidationExternalName()

getTableField

public MetadataTable getTableField()

getValidationExpressions

public MetadataValidationExpression[] getValidationExpressions()

getSearchResultOrder

public java.lang.Integer getSearchResultOrder()

The order that fields should appear in a default one-liner search result that is executed in order to give the user a list of existing records to select from for updating. Fields that should not appear in the default one-line format should have a value of "0". Fields that should never be visible to the user should have a value of "-1". Since RETS/1.8

getSearchQueryOrder

public java.lang.Integer getSearchQueryOrder()

The order that fields should appear in a default search screen that is executed in order to give the user a list of existing records to select from for updating. Fields that should not appear in the default search screen should have a value of "0". Fields that should never be visible to the user should have a value of "-1". Since RETS/1.8

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

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