com.bigllc.retsiq.metadata
Class MetadataLookupFilter

java.lang.Object
  extended by com.bigllc.retsiq.metadata.MetadataTableMap
      extended by com.bigllc.retsiq.metadata.MetadataLookupFilter

public class MetadataLookupFilter
extends MetadataTableMap


Field Summary
static java.lang.String CHILD_LOOKUPNAME
           
static java.lang.String CHILD_RESOURCE
           
static java.lang.String FILTER_ID
           
static java.lang.String NOT_SHOWN_BY_DEFAULT
           
static java.lang.String PARENT_LOOKUPNAME
           
static java.lang.String PARENT_RESOURCE
           
 
Fields inherited from class com.bigllc.retsiq.metadata.MetadataTableMap
map, nameKey, parent
 
Constructor Summary
MetadataLookupFilter(java.util.Map<java.lang.String,java.lang.String> map)
           
MetadataLookupFilter(java.util.Map<java.lang.String,java.lang.String> map, java.util.List<MetadataLookupFilterType> types)
           
 
Method Summary
 java.lang.String getAttributeName()
           
 java.lang.String getChildDate(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
           
 MetadataLookup getChildLookup()
           
 java.lang.String getChildLookupName()
           
 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)
           
 MetadataResource getChildResource()
           
 java.lang.String getChildResourceId()
           
 com.bigllc.retsiq.api.RETSConstants.MetadataType[] getChildTypes()
           
 java.lang.String getChildVersion(com.bigllc.retsiq.api.RETSConstants.MetadataType type)
           
 java.lang.String getFilterId()
          The name which acts as a unique ID for this filter..
 com.bigllc.retsiq.api.RETSConstants.MetadataType getMetadataType()
           
 java.lang.String getName()
           
 boolean getNotShownByDefault()
          If true the server will by default not include the FilterValue data of this filter in any metadata request, unless specifically asked to using the LookupFilter argument in GetMetadata.
 MetadataLookup getParentLookup()
           
 java.lang.String getParentLookupName()
           
 MetadataResource getParentResource()
           
 java.lang.String getParentResourceId()
           
 MetadataLookupFilterType getType(java.lang.String filterTypeId)
           
 java.util.List<MetadataLookupFilterType> getTypes()
           
 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, getDepth, getDisplayKeys, getFullPath, getFullPathName, getKeys, getMap, 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

FILTER_ID

public static final java.lang.String FILTER_ID
See Also:
Constant Field Values

PARENT_RESOURCE

public static final java.lang.String PARENT_RESOURCE
See Also:
Constant Field Values

PARENT_LOOKUPNAME

public static final java.lang.String PARENT_LOOKUPNAME
See Also:
Constant Field Values

CHILD_RESOURCE

public static final java.lang.String CHILD_RESOURCE
See Also:
Constant Field Values

CHILD_LOOKUPNAME

public static final java.lang.String CHILD_LOOKUPNAME
See Also:
Constant Field Values

NOT_SHOWN_BY_DEFAULT

public static final java.lang.String NOT_SHOWN_BY_DEFAULT
See Also:
Constant Field Values
Constructor Detail

MetadataLookupFilter

public MetadataLookupFilter(java.util.Map<java.lang.String,java.lang.String> map,
                            java.util.List<MetadataLookupFilterType> types)

MetadataLookupFilter

public MetadataLookupFilter(java.util.Map<java.lang.String,java.lang.String> map)
Method Detail

getType

public MetadataLookupFilterType getType(java.lang.String filterTypeId)

getTypes

public java.util.List<MetadataLookupFilterType> getTypes()

getFilterId

public java.lang.String getFilterId()
The name which acts as a unique ID for this filter..


getName

public java.lang.String getName()
Overrides:
getName in class MetadataTableMap

getParentResourceId

public java.lang.String getParentResourceId()

getParentResource

public MetadataResource getParentResource()

getParentLookupName

public java.lang.String getParentLookupName()

getParentLookup

public MetadataLookup getParentLookup()

getChildResourceId

public java.lang.String getChildResourceId()

getChildResource

public MetadataResource getChildResource()

getChildLookupName

public java.lang.String getChildLookupName()

getChildLookup

public MetadataLookup getChildLookup()

getNotShownByDefault

public boolean getNotShownByDefault()
If true the server will by default not include the FilterValue data of this filter in any metadata request, unless specifically asked to using the LookupFilter argument in GetMetadata.


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

getChildTypes

public com.bigllc.retsiq.api.RETSConstants.MetadataType[] getChildTypes()
Overrides:
getChildTypes in class MetadataTableMap