public interface DataDescriptorIf
When used to return an array of product objects, the default behavior is that invisible products
are not returned unless setShowInvisible()
is set to true.
If any of the custom attributes ( i.e. custom1
, custom2
etc. ) are
given non null values, then they are used as search constraints in the query. For example, if
custom1
is set to "Large" then only objects with the custom1
attribute
set to "Large" are returned. A rule can be set to make he search exact or to use wild cards.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCustom1()
If not null, it is used as a constraint .
|
java.lang.String |
getCustom10()
If not null, it is used as a constraint .
|
int |
getCustom10Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom11()
If not null, it is used as a constraint .
|
int |
getCustom11Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom12()
If not null, it is used as a constraint .
|
int |
getCustom12Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom13()
If not null, it is used as a constraint .
|
int |
getCustom13Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom14()
If not null, it is used as a constraint .
|
int |
getCustom14Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom15()
If not null, it is used as a constraint .
|
int |
getCustom15Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom16()
If not null, it is used as a constraint .
|
int |
getCustom16Rule()
The rule for the search constraint.
|
java.math.BigDecimal |
getCustom1Dec()
If not null, it is used as a constraint .
|
int |
getCustom1DecRule()
The rule for the search constraint.
|
java.lang.Integer |
getCustom1Int()
If not null, it is used as a constraint .
|
int |
getCustom1IntRule()
The rule for the search constraint.
|
int |
getCustom1Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom2()
If not null, it is used as a constraint .
|
java.math.BigDecimal |
getCustom2Dec()
If not null, it is used as a constraint .
|
int |
getCustom2DecRule()
The rule for the search constraint.
|
java.lang.Integer |
getCustom2Int()
If not null, it is used as a constraint .
|
int |
getCustom2IntRule()
The rule for the search constraint.
|
int |
getCustom2Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom3()
If not null, it is used as a constraint .
|
int |
getCustom3Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom4()
If not null, it is used as a constraint .
|
int |
getCustom4Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom5()
If not null, it is used as a constraint .
|
int |
getCustom5Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom6()
If not null, it is used as a constraint .
|
int |
getCustom6Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom7()
If not null, it is used as a constraint .
|
int |
getCustom7Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom8()
If not null, it is used as a constraint .
|
int |
getCustom8Rule()
The rule for the search constraint.
|
java.lang.String |
getCustom9()
If not null, it is used as a constraint .
|
int |
getCustom9Rule()
The rule for the search constraint.
|
int |
getLimit()
It defines the maximum number of objects returned.
|
int |
getOffset()
It sets the offset so that an array of objects can be paged.
|
java.lang.String |
getOrderBy_1()
If set it is used as a secondary order by.
|
java.lang.String |
getOrderBy()
The valid orderBy values are:
com.konakart.app.DataDescConstants.ORDER_BY_NAME_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_NAME_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_PRICE_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_PRICE_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED
com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_VIEWED
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_VIEWED_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_VIEWED_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_ORDERED
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_ORDERED_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_ORDERED_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_RATING_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_RATING_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_ID
com.konakart.app.DataDescConstants.ORDER_BY_MANUFACTURER
com.konakart.app.DataDescConstants.ORDER_BY_MANUFACTURER_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_MANUFACTURER_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM4_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM4_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM5_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM5_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM6_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM6_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM7_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM7_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM8_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM8_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM9_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM9_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM10_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM10_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1INT_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1INT_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2INT_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2INT_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1DEC_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1DEC_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2DEC_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2DEC_DESCENDING
|
boolean |
isFillCustomAttrArray()
When set to true, each product returned has an instantiated array of custom attributes when
applicable.
|
boolean |
isFillDescription()
Fills the product description and comparison attributes with values in the chosen language.
|
boolean |
isFillMiscItems()
Indicates whether the miscItems attribute will be filled with the associated miscellaneous
items.
|
boolean |
isFillProductOptions()
When set, each product returned has an instantiated array of product options if they exist
for the product.
|
boolean |
isFillProductQuantities()
When set, each product returned has an instantiated array of product quantities if they exist
for the product.
|
boolean |
isShowInvisible()
If set to true, we return even the invisible products.
|
void |
setCustom1(java.lang.String custom1)
If not null, it is used as a constraint .
|
void |
setCustom10(java.lang.String custom10)
If not null, it is used as a constraint .
|
void |
setCustom10Rule(int custom10Rule)
The rule for the search constraint.
|
void |
setCustom11(java.lang.String custom11)
If not null, it is used as a constraint .
|
void |
setCustom11Rule(int custom11Rule)
The rule for the search constraint.
|
void |
setCustom12(java.lang.String custom12)
If not null, it is used as a constraint .
|
void |
setCustom12Rule(int custom12Rule)
The rule for the search constraint.
|
void |
setCustom13(java.lang.String custom13)
If not null, it is used as a constraint .
|
void |
setCustom13Rule(int custom13Rule)
The rule for the search constraint.
|
void |
setCustom14(java.lang.String custom14)
If not null, it is used as a constraint .
|
void |
setCustom14Rule(int custom14Rule)
The rule for the search constraint.
|
void |
setCustom15(java.lang.String custom15)
If not null, it is used as a constraint .
|
void |
setCustom15Rule(int custom15Rule)
The rule for the search constraint.
|
void |
setCustom16(java.lang.String custom16)
If not null, it is used as a constraint .
|
void |
setCustom16Rule(int custom16Rule)
The rule for the search constraint.
|
void |
setCustom1Dec(java.math.BigDecimal custom1Dec)
If not null, it is used as a constraint .
|
void |
setCustom1DecRule(int custom1DecRule)
The rule for the search constraint.
|
void |
setCustom1Int(java.lang.Integer custom1Int)
If not null, it is used as a constraint .
|
void |
setCustom1IntRule(int custom1IntRule)
The rule for the search constraint.
|
void |
setCustom1Rule(int custom1Rule)
The rule for the search constraint.
|
void |
setCustom2(java.lang.String custom2)
If not null, it is used as a constraint .
|
void |
setCustom2Dec(java.math.BigDecimal custom2Dec)
If not null, it is used as a constraint .
|
void |
setCustom2DecRule(int custom2DecRule)
The rule for the search constraint.
|
void |
setCustom2Int(java.lang.Integer custom2Int)
If not null, it is used as a constraint .
|
void |
setCustom2IntRule(int custom2IntRule)
The rule for the search constraint.
|
void |
setCustom2Rule(int custom2Rule)
The rule for the search constraint.
|
void |
setCustom3(java.lang.String custom3)
If not null, it is used as a constraint .
|
void |
setCustom3Rule(int custom3Rule)
The rule for the search constraint.
|
void |
setCustom4(java.lang.String custom4)
If not null, it is used as a constraint .
|
void |
setCustom4Rule(int custom4Rule)
The rule for the search constraint.
|
void |
setCustom5(java.lang.String custom5)
If not null, it is used as a constraint .
|
void |
setCustom5Rule(int custom5Rule)
The rule for the search constraint.
|
void |
setCustom6(java.lang.String custom6)
If not null, it is used as a constraint .
|
void |
setCustom6Rule(int custom6Rule)
The rule for the search constraint.
|
void |
setCustom7(java.lang.String custom7)
If not null, it is used as a constraint .
|
void |
setCustom7Rule(int custom7Rule)
The rule for the search constraint.
|
void |
setCustom8(java.lang.String custom8)
If not null, it is used as a constraint .
|
void |
setCustom8Rule(int custom8Rule)
The rule for the search constraint.
|
void |
setCustom9(java.lang.String custom9)
If not null, it is used as a constraint .
|
void |
setCustom9Rule(int custom9Rule)
The rule for the search constraint.
|
void |
setFillCustomAttrArray(boolean fillCustomAttrArray)
When set to true, each product returned has an instantiated array of custom attributes when
applicable.
|
void |
setFillDescription(boolean fillDescription)
Fills the product description and comparison attributes with values in the chosen language.
|
void |
setFillMiscItems(boolean fillMiscItems) |
void |
setFillProductOptions(boolean fillProductOptions)
When set, each product returned has an instantiated array of product options if they exist
for the product.
|
void |
setFillProductQuantities(boolean fillProductQuantities)
When set, each product returned has an instantiated array of product quantities if they exist
for the product.
|
void |
setLimit(int limit)
It defines the maximum number of objects returned.
|
void |
setOffset(int offset)
It sets the offset so that an array of objects can be paged.
|
void |
setOrderBy_1(java.lang.String orderBy_1)
If set it is used as a secondary order by.
|
void |
setOrderBy(java.lang.String orderBy)
The valid orderBy values are:
com.konakart.app.DataDescConstants.ORDER_BY_NAME_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_NAME_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_PRICE_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_PRICE_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED
com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_LAST_MODIFIED
com.konakart.app.DataDescConstants.ORDER_BY_LAST_MODIFIED_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_LAST_MODIFIED_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_VIEWED
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_VIEWED_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_VIEWED_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_ORDERED
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_ORDERED_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_TIMES_ORDERED_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_RATING_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_RATING_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_ID
com.konakart.app.DataDescConstants.ORDER_BY_MANUFACTURER
com.konakart.app.DataDescConstants.ORDER_BY_MANUFACTURER_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_MANUFACTURER_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM4_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM4_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM5_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM5_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM6_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM6_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM7_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM7_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM8_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM8_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM9_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM9_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM10_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM10_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1INT_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1INT_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2INT_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2INT_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1DEC_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1DEC_DESCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2DEC_ASCENDING
com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2DEC_DESCENDING
|
void |
setShowInvisible(boolean showInvisible)
If set to true, we return even the invisible products.
|
int getLimit()
void setLimit(int limit)
limit
- The limit to set.int getOffset()
void setOffset(int offset)
offset
- The offset to set.java.lang.String getOrderBy()
void setOrderBy(java.lang.String orderBy)
orderBy
- The orderBy to set.java.lang.String getOrderBy_1()
void setOrderBy_1(java.lang.String orderBy_1)
orderBy_1
- The orderBy_1 to set.boolean isShowInvisible()
void setShowInvisible(boolean showInvisible)
showInvisible
- The showInvisible to set.boolean isFillMiscItems()
void setFillMiscItems(boolean fillMiscItems)
fillMiscItems
- when set to true the miscellaneous items for the object are returned in the
miscItems attribute. The default value is false, in order to maximize performance.boolean isFillDescription()
void setFillDescription(boolean fillDescription)
fillDescription
- the fillDescription to setboolean isFillCustomAttrArray()
void setFillCustomAttrArray(boolean fillCustomAttrArray)
fillCustomAttrArray
- the fillCustomAttrArray to setboolean isFillProductOptions()
void setFillProductOptions(boolean fillProductOptions)
fillProductOptions
- the fillProductOptions to setboolean isFillProductQuantities()
void setFillProductQuantities(boolean fillProductQuantities)
fillProductQuantities
- the fillProductQuantities to setjava.lang.String getCustom1()
void setCustom1(java.lang.String custom1)
custom1
- The custom1 to set.java.lang.String getCustom2()
void setCustom2(java.lang.String custom2)
custom2
- The custom2 to set.java.lang.String getCustom3()
void setCustom3(java.lang.String custom3)
custom3
- The custom3 to set.java.lang.String getCustom4()
void setCustom4(java.lang.String custom4)
custom4
- The custom4 to set.java.lang.String getCustom5()
void setCustom5(java.lang.String custom5)
custom5
- The custom5 to set.java.lang.String getCustom6()
void setCustom6(java.lang.String custom6)
custom6
- the custom6 to setjava.lang.String getCustom7()
void setCustom7(java.lang.String custom7)
custom7
- the custom7 to setjava.lang.String getCustom8()
void setCustom8(java.lang.String custom8)
custom8
- the custom8 to setjava.lang.String getCustom9()
void setCustom9(java.lang.String custom9)
custom9
- the custom9 to setjava.lang.String getCustom10()
void setCustom10(java.lang.String custom10)
custom10
- the custom10 to setjava.lang.String getCustom11()
void setCustom11(java.lang.String custom11)
custom11
- the custom11 to setjava.lang.String getCustom12()
void setCustom12(java.lang.String custom12)
custom12
- the custom12 to setjava.lang.String getCustom13()
void setCustom13(java.lang.String custom13)
custom13
- the custom13 to setjava.lang.String getCustom14()
void setCustom14(java.lang.String custom14)
custom14
- the custom14 to setjava.lang.String getCustom15()
void setCustom15(java.lang.String custom15)
custom15
- the custom15 to setjava.lang.String getCustom16()
void setCustom16(java.lang.String custom16)
custom16
- the custom16 to setjava.lang.Integer getCustom1Int()
void setCustom1Int(java.lang.Integer custom1Int)
custom1Int
- the custom1Int to setjava.lang.Integer getCustom2Int()
void setCustom2Int(java.lang.Integer custom2Int)
custom2Int
- the custom2Int to setjava.math.BigDecimal getCustom1Dec()
void setCustom1Dec(java.math.BigDecimal custom1Dec)
custom1Dec
- the custom1Dec to setjava.math.BigDecimal getCustom2Dec()
void setCustom2Dec(java.math.BigDecimal custom2Dec)
custom2Dec
- the custom2Dec to setint getCustom1Rule()
void setCustom1Rule(int custom1Rule)
custom1Rule
- the custom1Rule to setint getCustom2Rule()
void setCustom2Rule(int custom2Rule)
custom2Rule
- the custom2Rule to setint getCustom3Rule()
void setCustom3Rule(int custom3Rule)
custom3Rule
- the custom3Rule to setint getCustom4Rule()
void setCustom4Rule(int custom4Rule)
custom4Rule
- the custom4Rule to setint getCustom5Rule()
void setCustom5Rule(int custom5Rule)
custom5Rule
- the custom5Rule to setint getCustom6Rule()
void setCustom6Rule(int custom6Rule)
custom6Rule
- the custom6Rule to setint getCustom7Rule()
void setCustom7Rule(int custom7Rule)
custom7Rule
- the custom7Rule to setint getCustom8Rule()
void setCustom8Rule(int custom8Rule)
custom8Rule
- the custom8Rule to setint getCustom9Rule()
void setCustom9Rule(int custom9Rule)
custom9Rule
- the custom9Rule to setint getCustom10Rule()
void setCustom10Rule(int custom10Rule)
custom10Rule
- the custom10Rule to setint getCustom11Rule()
void setCustom11Rule(int custom11Rule)
custom11Rule
- the custom11Rule to setint getCustom12Rule()
void setCustom12Rule(int custom12Rule)
custom12Rule
- the custom12Rule to setint getCustom13Rule()
void setCustom13Rule(int custom13Rule)
custom13Rule
- the custom13Rule to setint getCustom14Rule()
void setCustom14Rule(int custom14Rule)
custom14Rule
- the custom14Rule to setint getCustom15Rule()
void setCustom15Rule(int custom15Rule)
custom15Rule
- the custom15Rule to setint getCustom16Rule()
void setCustom16Rule(int custom16Rule)
custom16Rule
- the custom16Rule to setint getCustom1IntRule()
void setCustom1IntRule(int custom1IntRule)
custom1IntRule
- the custom1IntRule to setint getCustom2IntRule()
void setCustom2IntRule(int custom2IntRule)
custom2IntRule
- the custom2IntRule to setint getCustom1DecRule()
void setCustom1DecRule(int custom1DecRule)
custom1DecRule
- the custom1DecRule to setint getCustom2DecRule()
void setCustom2DecRule(int custom2DecRule)
custom2DecRule
- the custom2DecRule to setCopyright © 2018 DS Data Systems UK Ltd.