com.konakartadmin.app
Class AdminSearch

java.lang.Object
  com.konakartadmin.app.AdminSearch

public class AdminSearch
extends java.lang.Object

Generic Search object for the Admin App. If this object is specified as null for a search, a default AdminSearch object is instantiated which has the following values:

• Id = -1 (Will not be used as a search constraint)
• Id2 = -1 (Will not be used as a search constraint)
• Id3 = -1 (Will not be used as a search constraint)
• Id4 = -1 (Will not be used as a search constraint)
• name = null (Will not be used as a search constraint)
• languageId = -1 (Default Language)
• orderBy = null (Will not be used as an orderBy clause)

Field Summary

private int	id Id - use depends on the API call
private int	id2 Id2 - use depends on the API call
private int	id3 Id3 - use depends on the API call
private int	id4 Id24 - use depends on the API call
private int[]	ids Ids - use depends on the API call
private boolean	includeChildren includeChildren
private int	languageId languageId
private java.lang.String	name Name
private int	nameRule Name Rule
static java.lang.String	ORDER_BY_DATE_ASCENDING ORDER_BY_DATE_ASCENDING
static java.lang.String	ORDER_BY_DATE_DESCENDING ORDER_BY_DATE_DESCENDING
static java.lang.String	ORDER_BY_DESCRIPTION_ASCENDING ORDER_BY_DECRIPTION_ASCENDING
static java.lang.String	ORDER_BY_DESCRIPTION_DESCENDING ORDER_BY_DECRIPTION_DESCENDING
static java.lang.String	ORDER_BY_ID_ASCENDING ORDER_BY_ID_ASCENDING
static java.lang.String	ORDER_BY_ID_DESCENDING ORDER_BY_ID_DESCENDING
static java.lang.String	ORDER_BY_ID2_ASCENDING ORDER_BY_ID2_ASCENDING
static java.lang.String	ORDER_BY_ID2_DESCENDING ORDER_BY_ID2_DESCENDING
static java.lang.String	ORDER_BY_ID3_ASCENDING ORDER_BY_ID3_ASCENDING
static java.lang.String	ORDER_BY_ID3_DESCENDING ORDER_BY_ID3_DESCENDING
static java.lang.String	ORDER_BY_ID4_ASCENDING ORDER_BY_ID4_ASCENDING
static java.lang.String	ORDER_BY_ID4_DESCENDING ORDER_BY_ID4_DESCENDING
static java.lang.String	ORDER_BY_LASTNAME_ASCENDING ORDER_BY_LASTNAME_ASCENDING
static java.lang.String	ORDER_BY_LASTNAME_DESCENDING ORDER_BY_LASTNAME_DESCENDING
static java.lang.String	ORDER_BY_NAME_ASCENDING ORDER_BY_NAME_ASCENDING
static java.lang.String	ORDER_BY_NAME_DESCENDING ORDER_BY_NAME_DESCENDING
static java.lang.String	ORDER_BY_SORT_ORDER_ASCENDING ORDER_BY_DECRIPTION_ASCENDING
static java.lang.String	ORDER_BY_SORT_ORDER_DESCENDING ORDER_BY_DECRIPTION_DESCENDING
private java.lang.String	orderBy orderBy
private boolean	useDefaultWildCardsWithName Use default settings for wildcard searching when searching using the name.

Constructor Summary

AdminSearch()
Instantiates an AdminSearch object - a requirement for a bean class

AdminSearch(com.workingdogs.village.Record r, org.apache.torque.util.Criteria c)
Instantiates the attributes of the AdminLanguageSearch object from a Record object

Method Summary

int	getId()
int	getId2()
int	getId3()
int	getId4()
int[]	getIds()
int	getLanguageId()
java.lang.String	getName()
int	getNameRule() The rule for the search.
java.lang.String	getOrderBy()
boolean	isIncludeChildren()
boolean	isUseDefaultWildCardsWithName() Deprecated. Use attribute rules instead
void	setId(int id)
void	setId2(int id2)
void	setId3(int id3)
void	setId4(int id4)
void	setIds(int[] ids)
void	setIncludeChildren(boolean includeChildren)
void	setLanguageId(int languageId)
void	setName(java.lang.String name)
void	setNameRule(int nameRule) The rule for the search.
void	setOrderBy(java.lang.String orderBy)
void	setUseDefaultWildCardsWithName(boolean useDefaultWildCardsWithName) Deprecated. Use attribute rules instead
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

ORDER_BY_ID_DESCENDING

public static final java.lang.String ORDER_BY_ID_DESCENDING

ORDER_BY_ID_DESCENDING

See Also:

Constant Field Values

ORDER_BY_ID_ASCENDING

public static final java.lang.String ORDER_BY_ID_ASCENDING

ORDER_BY_ID_ASCENDING

See Also:

Constant Field Values

ORDER_BY_ID2_DESCENDING

public static final java.lang.String ORDER_BY_ID2_DESCENDING

ORDER_BY_ID2_DESCENDING

See Also:

Constant Field Values

ORDER_BY_ID2_ASCENDING

public static final java.lang.String ORDER_BY_ID2_ASCENDING

ORDER_BY_ID2_ASCENDING

See Also:

Constant Field Values

ORDER_BY_ID3_DESCENDING

public static final java.lang.String ORDER_BY_ID3_DESCENDING

ORDER_BY_ID3_DESCENDING

See Also:

Constant Field Values

ORDER_BY_ID3_ASCENDING

public static final java.lang.String ORDER_BY_ID3_ASCENDING

ORDER_BY_ID3_ASCENDING

See Also:

Constant Field Values

ORDER_BY_ID4_DESCENDING

public static final java.lang.String ORDER_BY_ID4_DESCENDING

ORDER_BY_ID4_DESCENDING

See Also:

Constant Field Values

ORDER_BY_ID4_ASCENDING

public static final java.lang.String ORDER_BY_ID4_ASCENDING

ORDER_BY_ID4_ASCENDING

See Also:

Constant Field Values

ORDER_BY_NAME_DESCENDING

public static final java.lang.String ORDER_BY_NAME_DESCENDING

ORDER_BY_NAME_DESCENDING

See Also:

Constant Field Values

ORDER_BY_NAME_ASCENDING

public static final java.lang.String ORDER_BY_NAME_ASCENDING

ORDER_BY_NAME_ASCENDING

See Also:

Constant Field Values

ORDER_BY_DATE_DESCENDING

public static final java.lang.String ORDER_BY_DATE_DESCENDING

ORDER_BY_DATE_DESCENDING

See Also:

Constant Field Values

ORDER_BY_DATE_ASCENDING

public static final java.lang.String ORDER_BY_DATE_ASCENDING

ORDER_BY_DATE_ASCENDING

See Also:

Constant Field Values

ORDER_BY_LASTNAME_ASCENDING

public static final java.lang.String ORDER_BY_LASTNAME_ASCENDING

ORDER_BY_LASTNAME_ASCENDING

See Also:

Constant Field Values

ORDER_BY_LASTNAME_DESCENDING

public static final java.lang.String ORDER_BY_LASTNAME_DESCENDING

ORDER_BY_LASTNAME_DESCENDING

See Also:

Constant Field Values

ORDER_BY_DESCRIPTION_DESCENDING

public static final java.lang.String ORDER_BY_DESCRIPTION_DESCENDING

ORDER_BY_DECRIPTION_DESCENDING

See Also:

Constant Field Values

ORDER_BY_DESCRIPTION_ASCENDING

public static final java.lang.String ORDER_BY_DESCRIPTION_ASCENDING

ORDER_BY_DECRIPTION_ASCENDING

See Also:

Constant Field Values

ORDER_BY_SORT_ORDER_DESCENDING

public static final java.lang.String ORDER_BY_SORT_ORDER_DESCENDING

ORDER_BY_DECRIPTION_DESCENDING

See Also:

Constant Field Values

ORDER_BY_SORT_ORDER_ASCENDING

public static final java.lang.String ORDER_BY_SORT_ORDER_ASCENDING

ORDER_BY_DECRIPTION_ASCENDING

See Also:

Constant Field Values

ids

private int[] ids

Ids - use depends on the API call

id

private int id

Id - use depends on the API call

id2

private int id2

Id2 - use depends on the API call

id3

private int id3

Id3 - use depends on the API call

id4

private int id4

Id24 - use depends on the API call

name

private java.lang.String name

Name

nameRule

private int nameRule

Name Rule

useDefaultWildCardsWithName

private boolean useDefaultWildCardsWithName

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

includeChildren

private boolean includeChildren

includeChildren

languageId

private int languageId

languageId

orderBy

private java.lang.String orderBy

orderBy

Constructor Detail

AdminSearch

public AdminSearch()

Instantiates an AdminSearch object - a requirement for a bean class

AdminSearch

public AdminSearch(com.workingdogs.village.Record r,
                   org.apache.torque.util.Criteria c)
            throws com.workingdogs.village.DataSetException

Instantiates the attributes of the AdminLanguageSearch object from a Record object

Parameters:

r - Record containing data

c - Criteria containing column names

Throws:

com.workingdogs.village.DataSetException

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the AdminSearch object.

toStringBrief

public java.lang.String toStringBrief()

Returns:

Returns a string containing the attributes of the AdminSearch object.

getOrderBy

public java.lang.String getOrderBy()

Returns:

Returns the orderBy.

setOrderBy

public void setOrderBy(java.lang.String orderBy)

Parameters:

orderBy - The orderBy to set. Examples are:

• AdminSearch.ORDER_BY_ID_ASCENDING
• AdminSearch.ORDER_BY_ID_DESCENDING
• AdminSearch.ORDER_BY_NAME_ASCENDING
• AdminSearch.ORDER_BY_NAME_DESCENDING
• AdminSearch.ORDER_BY_DESCRIPTION_ASCENDING
• AdminSearch.ORDER_BY_DESCRIPTION_DESCENDING
• AdminSearch.ORDER_BY_SORT_ORDER_DESCENDING
• AdminSearch.ORDER_BY_SORT_ORDER_DESCENDING

getName

public java.lang.String getName()

Returns:

the search Name

setName

public void setName(java.lang.String name)

Parameters:

name - the name to search for

getLanguageId

public int getLanguageId()

Returns:

the languageId

setLanguageId

public void setLanguageId(int languageId)

Parameters:

languageId - languageId to set. Set to -1 for the default language and to 0 for all languages

getId

public int getId()

Returns:

the Id

setId

public void setId(int id)

Parameters:

id - the Id to set

isIncludeChildren

public boolean isIncludeChildren()

Returns:

Returns the includeChildren.

setIncludeChildren

public void setIncludeChildren(boolean includeChildren)

Parameters:

includeChildren - The includeChildren to set. If set the children of the main parent object will be returned attached to the parent object.

getId2

public int getId2()

Returns:

the id2

setId2

public void setId2(int id2)

Parameters:

id2 - the id2 to set

isUseDefaultWildCardsWithName

@Deprecated
public boolean isUseDefaultWildCardsWithName()

Deprecated. Use attribute rules instead

Returns:

the useDefaultWildCardsWithName

setUseDefaultWildCardsWithName

@Deprecated
public void setUseDefaultWildCardsWithName(boolean useDefaultWildCardsWithName)

Deprecated. Use attribute rules instead

Parameters:

useDefaultWildCardsWithName - the useDefaultWildCardsWithName 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

getId3

public int getId3()

Returns:

the id3

setId3

public void setId3(int id3)

Parameters:

id3 - the id3 to set

getId4

public int getId4()

Returns:

the id4

setId4

public void setId4(int id4)

Parameters:

id4 - the id4 to set

getIds

public int[] getIds()

Returns:

the ids

setIds

public void setIds(int[] ids)

Parameters:

ids - the ids to set