com.konakartadmin.app

Class AdminProductMgrOptions

java.lang.Object

com.konakartadmin.app.AdminProductMgrOptions

public class AdminProductMgrOptions
extends java.lang.Object

An object used to define options used when calling ProductMgr API calls

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	catalogId The id of the catalog which contains dynamic product information such as the price and quantity
private boolean	getRelationshipData Only used by the API call getRelatedProductsWithOptions.
private boolean	ignoreOrdered When true, the number of times a product has been ordered is not modified when a product is edited using editProductWithOptions()
private boolean	ignoreQuantity When true, the current quantity of the product and its variants is not modified when a product is edited using editProductWithOptions()
private boolean	ignoreViewedCount When true, the viewed count of the product (in all languages) is not modified when a product is edited using editProductWithOptions()
private java.util.Calendar	priceDate The date for which a price is requested.
private java.lang.String	relationCustom1 Custom1 value that's added to a product to product relationship
private java.lang.String	relationCustom2 Custom2 value that's added to a product to product relationship
private boolean	useExternalPrice If true we attempt to use the prices from the external table
private boolean	useExternalQuantity If true we attempt to use the quantities from the external table

Constructor Summary

Constructors

Constructor and Description
AdminProductMgrOptions() Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCatalogId()
java.util.Calendar	getPriceDate()
java.lang.String	getRelationCustom1() Custom1 value that's added to a product to product relationship
java.lang.String	getRelationCustom2() Custom2 value that's added to a product to product relationship
boolean	isGetRelationshipData() Only used by the API call getRelatedProductsWithOptions.
boolean	isIgnoreOrdered() When true, the number of times a product has been ordered is not modified when a product is edited using editProductWithOptions()
boolean	isIgnoreQuantity() When true, the current quantity of the product and its variants is not modified when a product is edited using editProductWithOptions()
boolean	isIgnoreViewedCount() When true, the viewed count of the product (in all languages) is not modified when a product is edited using editProductWithOptions()
boolean	isUseExternalPrice()
boolean	isUseExternalQuantity()
void	setCatalogId(java.lang.String catalogId)
void	setGetRelationshipData(boolean getRelationshipData) Only used by the API call getRelatedProductsWithOptions.
void	setIgnoreOrdered(boolean ignoreOrdered) When true, the number of times a product has been ordered is not modified when a product is edited using editProductWithOptions()
void	setIgnoreQuantity(boolean ignoreQuantity) When true, the current quantity of the product and its variants is not modified when a product is edited using editProductWithOptions()
void	setIgnoreViewedCount(boolean ignoreViewedCount) When true, the viewed count of the product (in all languages) is not modified when a product is edited using editProductWithOptions()
void	setPriceDate(java.util.Calendar priceDate)
void	setRelationCustom1(java.lang.String relationCustom1) Custom1 value that's added to a product to product relationship
void	setRelationCustom2(java.lang.String relationCustom2) Custom2 value that's added to a product to product relationship
void	setUseExternalPrice(boolean useExternalPrice)
void	setUseExternalQuantity(boolean useExternalQuantity)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

catalogId

private java.lang.String catalogId

The id of the catalog which contains dynamic product information such as the price and quantity

priceDate

private java.util.Calendar priceDate

The date for which a price is requested. It could be out in the future.

useExternalPrice

private boolean useExternalPrice

If true we attempt to use the prices from the external table

useExternalQuantity

private boolean useExternalQuantity

If true we attempt to use the quantities from the external table

getRelationshipData

private boolean getRelationshipData

Only used by the API call getRelatedProductsWithOptions. If set to true, the return Products object contains an array of ProductRelationship objects which contain data specific to each relationship.

relationCustom1

private java.lang.String relationCustom1

Custom1 value that's added to a product to product relationship

relationCustom2

private java.lang.String relationCustom2

Custom2 value that's added to a product to product relationship

ignoreQuantity

private boolean ignoreQuantity

When true, the current quantity of the product and its variants is not modified when a product is edited using editProductWithOptions()

ignoreOrdered

private boolean ignoreOrdered

When true, the number of times a product has been ordered is not modified when a product is edited using editProductWithOptions()

ignoreViewedCount

private boolean ignoreViewedCount

When true, the viewed count of the product (in all languages) is not modified when a product is edited using editProductWithOptions()

Constructor Detail

AdminProductMgrOptions

public AdminProductMgrOptions()

Constructor

Method Detail

getCatalogId

public java.lang.String getCatalogId()

Returns:

the catalogId

setCatalogId

public void setCatalogId(java.lang.String catalogId)

Parameters:

catalogId - the catalogId to set

getPriceDate

public java.util.Calendar getPriceDate()

Returns:

the priceDate

setPriceDate

public void setPriceDate(java.util.Calendar priceDate)

Parameters:

priceDate - the priceDate to set

isUseExternalPrice

public boolean isUseExternalPrice()

Returns:

the useExternalPrice

setUseExternalPrice

public void setUseExternalPrice(boolean useExternalPrice)

Parameters:

useExternalPrice - the useExternalPrice to set

isUseExternalQuantity

public boolean isUseExternalQuantity()

Returns:

the useExternalQuantity

setUseExternalQuantity

public void setUseExternalQuantity(boolean useExternalQuantity)

Parameters:

useExternalQuantity - the useExternalQuantity to set

isGetRelationshipData

public boolean isGetRelationshipData()

Only used by the API call getRelatedProductsWithOptions. If set to true, the return Products object contains an array of ProductRelationship objects which contain data specific to each relationship.

Returns:

the getRelationshipData

setGetRelationshipData

public void setGetRelationshipData(boolean getRelationshipData)

Only used by the API call getRelatedProductsWithOptions. If set to true, the return Products object contains an array of ProductRelationship objects which contain data specific to each relationship.

Parameters:

getRelationshipData - the getRelationshipData to set

getRelationCustom1

public java.lang.String getRelationCustom1()

Custom1 value that's added to a product to product relationship

Returns:

the relationCustom1

setRelationCustom1

public void setRelationCustom1(java.lang.String relationCustom1)

Custom1 value that's added to a product to product relationship

Parameters:

relationCustom1 - the relationCustom1 to set

getRelationCustom2

public java.lang.String getRelationCustom2()

Custom2 value that's added to a product to product relationship

Returns:

the relationCustom2

setRelationCustom2

public void setRelationCustom2(java.lang.String relationCustom2)

Custom2 value that's added to a product to product relationship

Parameters:

relationCustom2 - the relationCustom2 to set

isIgnoreQuantity

public boolean isIgnoreQuantity()

When true, the current quantity of the product and its variants is not modified when a product is edited using editProductWithOptions()

Returns:

the ignoreQuantity

setIgnoreQuantity

public void setIgnoreQuantity(boolean ignoreQuantity)

When true, the current quantity of the product and its variants is not modified when a product is edited using editProductWithOptions()

Parameters:

ignoreQuantity - the ignoreQuantity to set

isIgnoreViewedCount

public boolean isIgnoreViewedCount()

When true, the viewed count of the product (in all languages) is not modified when a product is edited using editProductWithOptions()

Returns:

the ignoreViewedCount

setIgnoreViewedCount

public void setIgnoreViewedCount(boolean ignoreViewedCount)

When true, the viewed count of the product (in all languages) is not modified when a product is edited using editProductWithOptions()

Parameters:

ignoreViewedCount - the ignoreViewedCount to set

isIgnoreOrdered

public boolean isIgnoreOrdered()

When true, the number of times a product has been ordered is not modified when a product is edited using editProductWithOptions()

Returns:

the ignoreOrdered

setIgnoreOrdered

public void setIgnoreOrdered(boolean ignoreOrdered)

When true, the number of times a product has been ordered is not modified when a product is edited using editProductWithOptions()

Parameters:

ignoreOrdered - the ignoreOrdered to set