com.konakartadmin.app

Class AdminStoreSearch

java.lang.Object

com.konakartadmin.app.AdminStoreSearch

public class AdminStoreSearch
extends java.lang.Object

StoreSearch object for the Admin App

Field Summary

Fields

Modifier and Type	Field and Description
static int	DELETED_BOTH Deleted Choices - Either Deleted or Not Deleted
static int	DELETED_FALSE Deleted Choices - Not Deleted
static int	DELETED_TRUE Deleted Choices - Deleted
private int	deletedChoice deleted Choice
private java.lang.String	description Description
private int	descriptionRule Description Rule
static int	ENABLED_BOTH MODE Choice - Either Enabled or Disabled
static int	ENABLED_FALSE MODE Choice - Disabled
static int	ENABLED_TRUE MODE Choice - Enabled
private int	enabledChoice enabled Choice
static int	MAINTENANCE_BOTH Maintenance Choices - Either Under Maintenance or Not Under Maintenance
static int	MAINTENANCE_FALSE Maintenance Choices - Not Under Maintenance
static int	MAINTENANCE_TRUE Maintenance Choices - Under Maintenance
private int	maintenanceChoice maintenance Choice
private java.lang.String	name Name
private int	nameRule Name Rule
static java.lang.String	ORDER_BY_STORE_DELETED_ASCENDING ORDER_BY_STORE_DELETED_ASCENDING
static java.lang.String	ORDER_BY_STORE_DELETED_DESCENDING ORDER_BY_STORE_DELETED_DESCENDING
static java.lang.String	ORDER_BY_STORE_ENABLED_ASCENDING ORDER_BY_STORE_ENABLED_ASCENDING
static java.lang.String	ORDER_BY_STORE_ENABLED_DESCENDING ORDER_BY_STORE_ENABLED_DESCENDING
static java.lang.String	ORDER_BY_STORE_UNDER_MAINT_ASCENDING ORDER_BY_STORE_UNDER_MAINT_ASCENDING
static java.lang.String	ORDER_BY_STORE_UNDER_MAINT_DESCENDING ORDER_BY_STORE_UNDER_MAINT_DESCENDING
private java.lang.String	orderBy order By
private java.lang.String	storeId storeId
private int	storeIdRule storeId Rule
private java.lang.String[]	storeIds storeIds
private boolean	useDefaultWildCardsWithStoreId Use default settings for wildcard searching when searching using the storeId.
private int	vendorId Vendor Id

Constructor Summary

Constructors

Constructor and Description
AdminStoreSearch() Instantiates an AdminStoreSearch object
AdminStoreSearch(com.workingdogs.village.Record r, com.konakart.db.KKCriteria c) Instantiates the attributes of the AdminStoreSearch object from a Record object

Method Summary

Modifier and Type	Method and Description
int	getDeletedChoice()
java.lang.String	getDescription()
int	getDescriptionRule() The rule for the search.
int	getEnabledChoice()
int	getMaintenanceChoice()
java.lang.String	getName()
int	getNameRule() The rule for the search.
java.lang.String	getOrderBy()
java.lang.String	getStoreId()
int	getStoreIdRule() The rule for the search.
java.lang.String[]	getStoreIds()
int	getVendorId()
boolean	isUseDefaultWildCardsWithStoreId() Deprecated. Use attribute rules instead
void	setDeletedChoice(int deletedChoice)
void	setDescription(java.lang.String description)
void	setDescriptionRule(int descriptionRule) The rule for the search.
void	setEnabledChoice(int enabledChoice)
void	setMaintenanceChoice(int maintenanceChoice)
void	setName(java.lang.String name)
void	setNameRule(int nameRule) The rule for the search.
void	setOrderBy(java.lang.String orderBy)
void	setStoreId(java.lang.String storeId)
void	setStoreIdRule(int storeIdRule) The rule for the search.
void	setStoreIds(java.lang.String[] storeIds)
void	setUseDefaultWildCardsWithStoreId(boolean useDefaultWildCardsWithStoreId) Deprecated. Use attribute rules instead
void	setVendorId(int vendorId)
java.lang.String	toString()
java.lang.String	toStringBrief()

Methods inherited from class java.lang.Object

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

Field Detail

ENABLED_TRUE

public static final int ENABLED_TRUE

MODE Choice - Enabled

See Also:

Constant Field Values

ENABLED_FALSE

public static final int ENABLED_FALSE

MODE Choice - Disabled

See Also:

Constant Field Values

ENABLED_BOTH

public static final int ENABLED_BOTH

MODE Choice - Either Enabled or Disabled

See Also:

Constant Field Values

DELETED_TRUE

public static final int DELETED_TRUE

Deleted Choices - Deleted

See Also:

Constant Field Values

DELETED_FALSE

public static final int DELETED_FALSE

Deleted Choices - Not Deleted

See Also:

Constant Field Values

DELETED_BOTH

public static final int DELETED_BOTH

Deleted Choices - Either Deleted or Not Deleted

See Also:

Constant Field Values

MAINTENANCE_TRUE

public static final int MAINTENANCE_TRUE

Maintenance Choices - Under Maintenance

See Also:

Constant Field Values

MAINTENANCE_FALSE

public static final int MAINTENANCE_FALSE

Maintenance Choices - Not Under Maintenance

See Also:

Constant Field Values

MAINTENANCE_BOTH

public static final int MAINTENANCE_BOTH

Maintenance Choices - Either Under Maintenance or Not Under Maintenance

See Also:

Constant Field Values

ORDER_BY_STORE_ENABLED_ASCENDING

public static final java.lang.String ORDER_BY_STORE_ENABLED_ASCENDING

ORDER_BY_STORE_ENABLED_ASCENDING

See Also:

Constant Field Values

ORDER_BY_STORE_ENABLED_DESCENDING

public static final java.lang.String ORDER_BY_STORE_ENABLED_DESCENDING

ORDER_BY_STORE_ENABLED_DESCENDING

See Also:

Constant Field Values

ORDER_BY_STORE_DELETED_ASCENDING

public static final java.lang.String ORDER_BY_STORE_DELETED_ASCENDING

ORDER_BY_STORE_DELETED_ASCENDING

See Also:

Constant Field Values

ORDER_BY_STORE_DELETED_DESCENDING

public static final java.lang.String ORDER_BY_STORE_DELETED_DESCENDING

ORDER_BY_STORE_DELETED_DESCENDING

See Also:

Constant Field Values

ORDER_BY_STORE_UNDER_MAINT_DESCENDING

public static final java.lang.String ORDER_BY_STORE_UNDER_MAINT_DESCENDING

ORDER_BY_STORE_UNDER_MAINT_DESCENDING

See Also:

Constant Field Values

ORDER_BY_STORE_UNDER_MAINT_ASCENDING

public static final java.lang.String ORDER_BY_STORE_UNDER_MAINT_ASCENDING

ORDER_BY_STORE_UNDER_MAINT_ASCENDING

See Also:

Constant Field Values

storeId

private java.lang.String storeId

storeId

storeIds

private java.lang.String[] storeIds

storeIds

storeIdRule

private int storeIdRule

storeId Rule

useDefaultWildCardsWithStoreId

private boolean useDefaultWildCardsWithStoreId

Use default settings for wildcard searching when searching using the storeId. If false no wildcards ("%") are added for the search and an exact match on storeId is required

name

private java.lang.String name

Name

nameRule

private int nameRule

Name Rule

description

private java.lang.String description

Description

descriptionRule

private int descriptionRule

Description Rule

enabledChoice

private int enabledChoice

enabled Choice

deletedChoice

private int deletedChoice

deleted Choice

maintenanceChoice

private int maintenanceChoice

maintenance Choice

vendorId

private int vendorId

Vendor Id

orderBy

private java.lang.String orderBy

order By

Constructor Detail

AdminStoreSearch

public AdminStoreSearch()

Instantiates an AdminStoreSearch object

AdminStoreSearch

public AdminStoreSearch(com.workingdogs.village.Record r,
                        com.konakart.db.KKCriteria c)
                 throws com.workingdogs.village.DataSetException

Instantiates the attributes of the AdminStoreSearch object from a Record object

Parameters:

r - Record containing data

c - Criteria containing column names

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the CountrySearch object.

toStringBrief

public java.lang.String toStringBrief()

Returns:

Returns a string containing the attributes of the Country object.

getName

public java.lang.String getName()

Returns:

Returns the name.

setName

public void setName(java.lang.String name)

Parameters:

name - The name to set.

getStoreId

public java.lang.String getStoreId()

Returns:

the storeId

setStoreId

public void setStoreId(java.lang.String storeId)

Parameters:

storeId - the storeId to set

getDeletedChoice

public int getDeletedChoice()

Returns:

the deletedChoice

setDeletedChoice

public void setDeletedChoice(int deletedChoice)

Parameters:

deletedChoice - the deletedChoice to set

getMaintenanceChoice

public int getMaintenanceChoice()

Returns:

the maintenanceChoice

setMaintenanceChoice

public void setMaintenanceChoice(int maintenanceChoice)

Parameters:

maintenanceChoice - the maintenanceChoice to set

getOrderBy

public java.lang.String getOrderBy()

Returns:

the orderBy

setOrderBy

public void setOrderBy(java.lang.String orderBy)

Parameters:

orderBy - the orderBy to set

getDescription

public java.lang.String getDescription()

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description to set

getEnabledChoice

public int getEnabledChoice()

Returns:

the enabledChoice

setEnabledChoice

public void setEnabledChoice(int enabledChoice)

Parameters:

enabledChoice - the enabledChoice to set

isUseDefaultWildCardsWithStoreId

@Deprecated
public boolean isUseDefaultWildCardsWithStoreId()

Deprecated. Use attribute rules instead

Returns:

the useDefaultWildCardsWithStoreId

setUseDefaultWildCardsWithStoreId

@Deprecated
public void setUseDefaultWildCardsWithStoreId(boolean useDefaultWildCardsWithStoreId)

Deprecated. Use attribute rules instead

Parameters:

useDefaultWildCardsWithStoreId - the useDefaultWildCardsWithStoreId to set

getStoreIdRule

public int getStoreIdRule()

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
• KKConstants.SEARCH_USE_GLOBAL_CONFIG

Returns:

the storeIdRule

setStoreIdRule

public void setStoreIdRule(int storeIdRule)

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
• KKConstants.SEARCH_USE_GLOBAL_CONFIG

Parameters:

storeIdRule - the storeIdRule to set

getNameRule

public int getNameRule()

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
• KKConstants.SEARCH_USE_GLOBAL_CONFIG

Returns:

the nameRule

setNameRule

public void setNameRule(int nameRule)

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
• KKConstants.SEARCH_USE_GLOBAL_CONFIG

Parameters:

nameRule - the nameRule to set

getDescriptionRule

public int getDescriptionRule()

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
• KKConstants.SEARCH_USE_GLOBAL_CONFIG

Returns:

the descriptionRule

setDescriptionRule

public void setDescriptionRule(int descriptionRule)

The rule for the search. Valid values are:

• KKConstants.SEARCH_EXACT
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE
• KKConstants.SEARCH_ADD_WILDCARD_AFTER
• KKConstants.SEARCH_ADD_WILDCARD_BEFORE_AND_AFTER
• KKConstants.SEARCH_USE_GLOBAL_CONFIG

Parameters:

descriptionRule - the descriptionRule to set

getVendorId

public int getVendorId()

Returns:

the vendorId

setVendorId

public void setVendorId(int vendorId)

Parameters:

vendorId - the vendorId to set

getStoreIds

public java.lang.String[] getStoreIds()

Returns:

the storeIds

setStoreIds

public void setStoreIds(java.lang.String[] storeIds)

Parameters:

storeIds - the storeIds to set