|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface DataDescriptorIf
Contains information required to manage engine calls that return an array of data. Offsets,
limits for the number of objects returned and sort orders, may be controlled using the
DataDescriptor.
When used to return an array of product objects, the default behaviour 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.
| Method Summary | |
|---|---|
java.lang.String |
getCustom1()
If not null, it is used as a constraint. |
java.lang.String |
getCustom2()
If not null, it is used as a constraint. |
java.lang.String |
getCustom3()
If not null, it is used as a constraint. |
java.lang.String |
getCustom4()
If not null, it is used as a constraint. |
java.lang.String |
getCustom5()
If not null, it is used as a 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_ID com.konakart.app.DataDescConstants.ORDER_BY_NAME_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_NAME_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_MANUFACTURER com.konakart.app.DataDescConstants.ORDER_BY_PRICE_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_PRICE_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED com.konakart.app.DataDescConstants.ORDER_BY_TIMES_READ com.konakart.app.DataDescConstants.ORDER_BY_RATING com.konakart.app.DataDescConstants.ORDER_BY_TIMES_VIEWED com.konakart.app.DataDescConstants.ORDER_BY_TIMES_ORDERED com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM4_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM4_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM5_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM5_ASCENDING |
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 |
setCustom2(java.lang.String custom2)
If not null, it is used as a constraint. |
void |
setCustom3(java.lang.String custom3)
If not null, it is used as a constraint. |
void |
setCustom4(java.lang.String custom4)
If not null, it is used as a constraint. |
void |
setCustom5(java.lang.String custom5)
If not null, it is used as a constraint. |
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_ID com.konakart.app.DataDescConstants.ORDER_BY_NAME_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_NAME_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_MANUFACTURER com.konakart.app.DataDescConstants.ORDER_BY_PRICE_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_PRICE_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_DATE_ADDED com.konakart.app.DataDescConstants.ORDER_BY_TIMES_READ com.konakart.app.DataDescConstants.ORDER_BY_RATING com.konakart.app.DataDescConstants.ORDER_BY_TIMES_VIEWED com.konakart.app.DataDescConstants.ORDER_BY_TIMES_ORDERED com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM1_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM2_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM3_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM4_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM4_ASCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM5_DESCENDING com.konakart.app.DataDescConstants.ORDER_BY_CUSTOM5_ASCENDING |
void |
setShowInvisible(boolean showInvisible)
If set to true, we return even the invisible products. |
java.lang.String |
toStringBrief()
|
| Method Detail |
|---|
java.lang.String toStringBrief()
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.java.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.boolean isShowInvisible()
void setShowInvisible(boolean showInvisible)
showInvisible - The showInvisible to set.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||