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)
• 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
private boolean	includeChildren includeChildren
private int	languageId languageId
private java.lang.String	name Name
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_CUSTOMERS_ID_ASCENDING
static java.lang.String	ORDER_BY_ID_DESCENDING ORDER_BY_CUSTOMERS_ID_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

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	getLanguageId()
java.lang.String	getName()
java.lang.String	getOrderBy()
boolean	isIncludeChildren()
void	setId(int id)
void	setIncludeChildren(boolean includeChildren)
void	setLanguageId(int languageId)
void	setName(java.lang.String name)
void	setOrderBy(java.lang.String orderBy)
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_CUSTOMERS_ID_DESCENDING

See Also:

Constant Field Values

ORDER_BY_ID_ASCENDING

public static final java.lang.String ORDER_BY_ID_ASCENDING

ORDER_BY_CUSTOMERS_ID_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_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

id

private int id

Id

name

private java.lang.String name

Name

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 LanguageSearch object.

toStringBrief

public java.lang.String toStringBrief()

Returns:

Returns a string containing the attributes of the Language 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.