Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.konakart.appif
Interface DataDescriptorIf

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

toStringBrief

java.lang.String toStringBrief()
Returns:
Returns a string containing selected attributes of the Option object.

getLimit

int getLimit()
It defines the maximum number of objects returned.

Returns:
Returns the limit.

setLimit

void setLimit(int limit)
It defines the maximum number of objects returned.

Parameters:
limit - The limit to set.

getOffset

int getOffset()
It sets the offset so that an array of objects can be paged.

Returns:
Returns the offset.

setOffset

void setOffset(int offset)
It sets the offset so that an array of objects can be paged.

Parameters:
offset - The offset to set.

getOrderBy

java.lang.String getOrderBy()
The valid orderBy values are:

Returns:
Returns the orderBy.

setOrderBy

void setOrderBy(java.lang.String orderBy)
The valid orderBy values are:

Parameters:
orderBy - The orderBy to set.

getOrderBy_1

java.lang.String getOrderBy_1()
If set it is used as a secondary order by. The valid orderBy_1 values are:

Returns:
Returns the orderBy_1.

setOrderBy_1

void setOrderBy_1(java.lang.String orderBy_1)
If set it is used as a secondary order by. The valid orderBy_1 values are:

Parameters:
orderBy_1 - The orderBy_1 to set.

getCustom1

java.lang.String getCustom1()
If not null, it is used as a constraint.

Returns:
Returns the custom1.

setCustom1

void setCustom1(java.lang.String custom1)
If not null, it is used as a constraint.

Parameters:
custom1 - The custom1 to set.

getCustom2

java.lang.String getCustom2()
If not null, it is used as a constraint.

Returns:
Returns the custom2.

setCustom2

void setCustom2(java.lang.String custom2)
If not null, it is used as a constraint.

Parameters:
custom2 - The custom2 to set.

getCustom3

java.lang.String getCustom3()
If not null, it is used as a constraint.

Returns:
Returns the custom3.

setCustom3

void setCustom3(java.lang.String custom3)
If not null, it is used as a constraint.

Parameters:
custom3 - The custom3 to set.

getCustom4

java.lang.String getCustom4()
If not null, it is used as a constraint.

Returns:
Returns the custom4.

setCustom4

void setCustom4(java.lang.String custom4)
If not null, it is used as a constraint.

Parameters:
custom4 - The custom4 to set.

getCustom5

java.lang.String getCustom5()
If not null, it is used as a constraint.

Returns:
Returns the custom5.

setCustom5

void setCustom5(java.lang.String custom5)
If not null, it is used as a constraint.

Parameters:
custom5 - The custom5 to set.

isShowInvisible

boolean isShowInvisible()
If set to true, we return even the invisible products.

Returns:
Returns the showInvisible.

setShowInvisible

void setShowInvisible(boolean showInvisible)
If set to true, we return even the invisible products.

Parameters:
showInvisible - The showInvisible to set.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2006 DS Data Systems UK Ltd.