|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.webdocwf.util.genericstore.data.EnumValueDefinitionQuery
EnumValueDefinitionQuery is used to query the GENERICENUMVALUEDEFINITION table in the database. It returns objects of type EnumValueDefinitionDO.
General usage:
In DODS: Create a Data Object named "Dog", and create an Attribute named "Name", and set that Attribute to "Can be queried." DODS will then generate the method DogQuery.setQueryName().
In your Business Layer, prepare the query:
DogQuery dq = new DogQuery(); dq.setQueryName("Rex") if ( Rex is a reserved name ) dq.requireUniqueInstance();Then, get the query results one of two ways:
#1:
String names = ""; DogDO[] dogs = dq.getDOArray(); for ( int i = 0; i < dogs.length; i++ ) { names += dogs[i].getName() + " "; }or #2:
String names = ""; DogDO dog; while ( null != ( dog = dq.getNextDO() ) ) { names += dog.getName() + " "; }
Note: If requireUniqueInstance()
was called,
then getDOArray()
or getNextDO()
will throw an exception if more than one "Rex" was found.
Note: Results of the query will come from the Data Object cache if:
- The cache is available.
- Matches were found in the cache.
- No other tables (Data Objects of other types) were involved
in the query.
This can happen if you extend the DogQuery
class
and you make calls to the QueryBuilder
object
to add SQL involving other tables.
If any of these conditions is not true,
then any results from the query will come from the database.
To reuse the query object, call:
dq.reset();
Constructor Summary | |
EnumValueDefinitionQuery()
Public constructor. |
|
EnumValueDefinitionQuery(User usr)
Constructor for Query with security |
Method Summary | |
void |
addOrderByBEGINSTATE()
Add BEGINSTATE to the ORDER BY clause. |
void |
addOrderByBEGINSTATE(boolean direction_flag)
Add BEGINSTATE to the ORDER BY clause. |
void |
addOrderByENDSTATE()
Add ENDSTATE to the ORDER BY clause. |
void |
addOrderByENDSTATE(boolean direction_flag)
Add ENDSTATE to the ORDER BY clause. |
void |
addOrderByENUMTYPEDEFINITIONOID()
Add ENUMTYPEDEFINITIONOID to the ORDER BY clause. |
void |
addOrderByENUMTYPEDEFINITIONOID(boolean direction_flag)
Add ENUMTYPEDEFINITIONOID to the ORDER BY clause. |
void |
addOrderByKEYVALUE()
Add KEYVALUE to the ORDER BY clause. |
void |
addOrderByKEYVALUE(boolean direction_flag)
Add KEYVALUE to the ORDER BY clause. |
void |
addOrderByLONGNAME()
Add LONGNAME to the ORDER BY clause. |
void |
addOrderByLONGNAME(boolean direction_flag)
Add LONGNAME to the ORDER BY clause. |
void |
addOrderBySHORTNAME()
Add SHORTNAME to the ORDER BY clause. |
void |
addOrderBySHORTNAME(boolean direction_flag)
Add SHORTNAME to the ORDER BY clause. |
void |
addOrderByXMLNAME()
Add XMLNAME to the ORDER BY clause. |
void |
addOrderByXMLNAME(boolean direction_flag)
Add XMLNAME to the ORDER BY clause. |
static void |
assertQueryAccess(User usr)
Ensure that the given user is allowed to create a query |
void |
assertQueryAttrBEGINSTATEAccess(boolean x,
boolean exact,
User usr)
Deprecated. Instead use assertQueryAttrBEGINSTATEAccess(boolean x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
void |
assertQueryAttrBEGINSTATEAccess(boolean x,
java.lang.String cmp_op,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrBEGINSTATEAccess(boolean x,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrENDSTATEAccess(boolean x,
boolean exact,
User usr)
Deprecated. Instead use assertQueryAttrENDSTATEAccess(boolean x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
void |
assertQueryAttrENDSTATEAccess(boolean x,
java.lang.String cmp_op,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrENDSTATEAccess(boolean x,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
boolean exact,
User usr)
Deprecated. Instead use assertQueryAttrENUMTYPEDEFINITIONOIDAccess(org.webdocwf.util.genericstore.data.EnumTypeDefinitionDO x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
void |
assertQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
java.lang.String cmp_op,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrKEYVALUEAccess(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use assertQueryAttrKEYVALUEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
void |
assertQueryAttrKEYVALUEAccess(java.lang.String x,
java.lang.String cmp_op,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrKEYVALUEAccess(java.lang.String x,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrLONGNAMEAccess(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use assertQueryAttrLONGNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
void |
assertQueryAttrLONGNAMEAccess(java.lang.String x,
java.lang.String cmp_op,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrLONGNAMEAccess(java.lang.String x,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrSHORTNAMEAccess(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use assertQueryAttrSHORTNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
void |
assertQueryAttrSHORTNAMEAccess(java.lang.String x,
java.lang.String cmp_op,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrSHORTNAMEAccess(java.lang.String x,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrXMLNAMEAccess(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use assertQueryAttrXMLNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
void |
assertQueryAttrXMLNAMEAccess(java.lang.String x,
java.lang.String cmp_op,
User usr)
Ensure the given user is allowed to query the attribute |
void |
assertQueryAttrXMLNAMEAccess(java.lang.String x,
User usr)
Ensure the given user is allowed to query the attribute |
void |
closeParen()
Place a closing parenthesis in the WHERE clause. |
boolean |
containsWildcards(java.lang.String dbSearchValue)
Check whether a string contains DB wildcards |
java.lang.String |
convertUserSearchValue(java.lang.String userSearchValue)
Convert a String with user wildcards into a string with DB wildcards |
java.sql.ResultSet |
executeQuery(DBConnection conn)
Method to query objects from the database. |
int |
getCount()
Get the rowcount of the query If possible, do it without reading all rows |
int |
getDatabaseLimit()
Get the database limit of the query |
boolean |
getDatabaseLimitExceeded()
Get the database limit exceeded flag of the query |
EnumValueDefinitionDO[] |
getDOArray()
Return array of DOs constructed from ResultSet returned by query. |
EnumValueDefinitionDO |
getNextDO()
Return successive DOs from array built from ResultSet returned by query. |
QueryBuilder |
getQueryBuilder()
Returns the QueryBuilder that this EnumValueDefinitionQuery
uses to construct and execute database queries. |
int |
getReadSkip()
Get the readSkip number of the query |
boolean |
getUnique()
Get the unique flag of the query |
User |
getUser()
Get the user of the query |
boolean |
getUserStringAppendWildcard()
|
java.lang.String |
getUserStringSingleWildcard()
|
java.lang.String |
getUserStringSingleWildcardEscape()
|
boolean |
getUserStringTrim()
|
java.lang.String |
getUserStringWildcard()
|
java.lang.String |
getUserStringWildcardEscape()
|
static boolean |
hasQueryAccess(User usr)
Check whether the given user is allowed to create a query |
boolean |
hasQueryAttrBEGINSTATEAccess(boolean x,
boolean exact,
User usr)
Deprecated. Instead use hasQueryAttrBEGINSTATEAccess(boolean x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
boolean |
hasQueryAttrBEGINSTATEAccess(boolean x,
java.lang.String cmp_op,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrBEGINSTATEAccess(boolean x,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrENDSTATEAccess(boolean x,
boolean exact,
User usr)
Deprecated. Instead use hasQueryAttrENDSTATEAccess(boolean x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
boolean |
hasQueryAttrENDSTATEAccess(boolean x,
java.lang.String cmp_op,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrENDSTATEAccess(boolean x,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
boolean exact,
User usr)
Deprecated. Instead use hasQueryAttrENUMTYPEDEFINITIONOIDAccess(org.webdocwf.util.genericstore.data.EnumTypeDefinitionDO x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
boolean |
hasQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
java.lang.String cmp_op,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrKEYVALUEAccess(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use hasQueryAttrKEYVALUEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
boolean |
hasQueryAttrKEYVALUEAccess(java.lang.String x,
java.lang.String cmp_op,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrKEYVALUEAccess(java.lang.String x,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrLONGNAMEAccess(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use hasQueryAttrLONGNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
boolean |
hasQueryAttrLONGNAMEAccess(java.lang.String x,
java.lang.String cmp_op,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrLONGNAMEAccess(java.lang.String x,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrSHORTNAMEAccess(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use hasQueryAttrSHORTNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
boolean |
hasQueryAttrSHORTNAMEAccess(java.lang.String x,
java.lang.String cmp_op,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrSHORTNAMEAccess(java.lang.String x,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrXMLNAMEAccess(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use hasQueryAttrXMLNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension |
boolean |
hasQueryAttrXMLNAMEAccess(java.lang.String x,
java.lang.String cmp_op,
User usr)
Check whether the given user is allowed to query the attribute |
boolean |
hasQueryAttrXMLNAMEAccess(java.lang.String x,
User usr)
Check whether the given user is allowed to query the attribute |
void |
hitDatabase()
|
java.lang.Object |
next(java.sql.ResultSet rs)
WARNING! This method is disabled. |
void |
openParen()
Place an open parenthesis in the WHERE clause. |
void |
or()
Insert an OR between WHERE clauses. |
void |
requireUniqueInstance()
Set "unique instance" assertion bit. |
void |
reset()
Reset the query parameters. |
int |
selectCount()
Get the rowcount of the query by using count(*) in the DB |
void |
setDatabaseLimit(int newLimit)
Set the database limit of the query |
void |
setDBMatchKEYVALUE(java.lang.String x)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setDBMatchKEYVALUE(java.lang.String x,
User usr)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setDBMatchLONGNAME(java.lang.String x)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setDBMatchLONGNAME(java.lang.String x,
User usr)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setDBMatchSHORTNAME(java.lang.String x)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setDBMatchSHORTNAME(java.lang.String x,
User usr)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setDBMatchXMLNAME(java.lang.String x)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setDBMatchXMLNAME(java.lang.String x,
User usr)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setMaxRows(int maxRows)
Limit the number of rows (DOs) returned. |
void |
setQueryBEGINSTATE(boolean x)
Set the BEGINSTATE to query |
void |
setQueryBEGINSTATE(boolean x,
boolean exact)
Deprecated. Instead use setQueryBEGINSTATE(boolean x,String cmp_op) |
void |
setQueryBEGINSTATE(boolean x,
boolean exact,
User usr)
Deprecated. Instead use setQueryBEGINSTATE(boolean x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension |
void |
setQueryBEGINSTATE(boolean x,
java.lang.String cmp_op)
Set the BEGINSTATE to query, with a QueryBuilder comparison operator. |
void |
setQueryBEGINSTATE(boolean x,
java.lang.String cmp_op,
User usr)
Set the BEGINSTATE to query, with a QueryBuilder comparison operator. |
void |
setQueryBEGINSTATE(boolean x,
User usr)
Set the BEGINSTATE to query. |
void |
setQueryENDSTATE(boolean x)
Set the ENDSTATE to query |
void |
setQueryENDSTATE(boolean x,
boolean exact)
Deprecated. Instead use setQueryENDSTATE(boolean x,String cmp_op) |
void |
setQueryENDSTATE(boolean x,
boolean exact,
User usr)
Deprecated. Instead use setQueryENDSTATE(boolean x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension |
void |
setQueryENDSTATE(boolean x,
java.lang.String cmp_op)
Set the ENDSTATE to query, with a QueryBuilder comparison operator. |
void |
setQueryENDSTATE(boolean x,
java.lang.String cmp_op,
User usr)
Set the ENDSTATE to query, with a QueryBuilder comparison operator. |
void |
setQueryENDSTATE(boolean x,
User usr)
Set the ENDSTATE to query. |
void |
setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x)
Set the ENUMTYPEDEFINITIONOID to query |
void |
setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x,
boolean exact)
Deprecated. Instead use setQueryENUMTYPEDEFINITIONOID(org.webdocwf.util.genericstore.data.EnumTypeDefinitionDO x,String cmp_op) |
void |
setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x,
boolean exact,
User usr)
Deprecated. Instead use setQueryENUMTYPEDEFINITIONOID(org.webdocwf.util.genericstore.data.EnumTypeDefinitionDO x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension |
void |
setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x,
java.lang.String cmp_op)
Set the ENUMTYPEDEFINITIONOID to query, with a QueryBuilder comparison operator. |
void |
setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x,
java.lang.String cmp_op,
User usr)
Set the ENUMTYPEDEFINITIONOID to query, with a QueryBuilder comparison operator. |
void |
setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x,
User usr)
Set the ENUMTYPEDEFINITIONOID to query. |
void |
setQueryHandle(java.lang.String handle)
Set the object handle to query. |
void |
setQueryKEYVALUE(java.lang.String x)
Set the KEYVALUE to query |
void |
setQueryKEYVALUE(java.lang.String x,
boolean exact)
Deprecated. Instead use setQueryKEYVALUE(String x,String cmp_op) |
void |
setQueryKEYVALUE(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use setQueryKEYVALUE(String x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension |
void |
setQueryKEYVALUE(java.lang.String x,
java.lang.String cmp_op)
Set the KEYVALUE to query, with a QueryBuilder comparison operator. |
void |
setQueryKEYVALUE(java.lang.String x,
java.lang.String cmp_op,
User usr)
Set the KEYVALUE to query, with a QueryBuilder comparison operator. |
void |
setQueryKEYVALUE(java.lang.String x,
User usr)
Set the KEYVALUE to query. |
void |
setQueryLONGNAME(java.lang.String x)
Set the LONGNAME to query |
void |
setQueryLONGNAME(java.lang.String x,
boolean exact)
Deprecated. Instead use setQueryLONGNAME(String x,String cmp_op) |
void |
setQueryLONGNAME(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use setQueryLONGNAME(String x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension |
void |
setQueryLONGNAME(java.lang.String x,
java.lang.String cmp_op)
Set the LONGNAME to query, with a QueryBuilder comparison operator. |
void |
setQueryLONGNAME(java.lang.String x,
java.lang.String cmp_op,
User usr)
Set the LONGNAME to query, with a QueryBuilder comparison operator. |
void |
setQueryLONGNAME(java.lang.String x,
User usr)
Set the LONGNAME to query. |
void |
setQueryOId(ObjectId oid)
Set the OID to query. |
void |
setQuerySHORTNAME(java.lang.String x)
Set the SHORTNAME to query |
void |
setQuerySHORTNAME(java.lang.String x,
boolean exact)
Deprecated. Instead use setQuerySHORTNAME(String x,String cmp_op) |
void |
setQuerySHORTNAME(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use setQuerySHORTNAME(String x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension |
void |
setQuerySHORTNAME(java.lang.String x,
java.lang.String cmp_op)
Set the SHORTNAME to query, with a QueryBuilder comparison operator. |
void |
setQuerySHORTNAME(java.lang.String x,
java.lang.String cmp_op,
User usr)
Set the SHORTNAME to query, with a QueryBuilder comparison operator. |
void |
setQuerySHORTNAME(java.lang.String x,
User usr)
Set the SHORTNAME to query. |
void |
setQueryXMLNAME(java.lang.String x)
Set the XMLNAME to query |
void |
setQueryXMLNAME(java.lang.String x,
boolean exact)
Deprecated. Instead use setQueryXMLNAME(String x,String cmp_op) |
void |
setQueryXMLNAME(java.lang.String x,
boolean exact,
User usr)
Deprecated. Instead use setQueryXMLNAME(String x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension |
void |
setQueryXMLNAME(java.lang.String x,
java.lang.String cmp_op)
Set the XMLNAME to query, with a QueryBuilder comparison operator. |
void |
setQueryXMLNAME(java.lang.String x,
java.lang.String cmp_op,
User usr)
Set the XMLNAME to query, with a QueryBuilder comparison operator. |
void |
setQueryXMLNAME(java.lang.String x,
User usr)
Set the XMLNAME to query. |
void |
setReadSkip(int newReadSkip)
Set the readSkip number of the query |
void |
setUnique(boolean newUnique)
Set the unique flag of the query |
void |
setUserMatchKEYVALUE(java.lang.String x)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setUserMatchKEYVALUE(java.lang.String x,
User usr)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setUserMatchLONGNAME(java.lang.String x)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setUserMatchLONGNAME(java.lang.String x,
User usr)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setUserMatchSHORTNAME(java.lang.String x)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setUserMatchSHORTNAME(java.lang.String x,
User usr)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setUserMatchXMLNAME(java.lang.String x)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setUserMatchXMLNAME(java.lang.String x,
User usr)
Deprecated. Use comparison operators instead WebDocWf extension |
void |
setUserStringAppendWildcard(boolean userStringAppendWildcard)
|
void |
setUserStringSingleWildcard(java.lang.String newUserStringSingleWildcard)
|
void |
setUserStringSingleWildcardEscape(java.lang.String newUserStringSingleWildcardEscape)
|
void |
setUserStringTrim(boolean userStringTrim)
|
void |
setUserStringWildcard(java.lang.String newUserStringWildcard)
|
void |
setUserStringWildcardEscape(java.lang.String newUserStringWildcardEscape)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public EnumValueDefinitionQuery()
public EnumValueDefinitionQuery(User usr) throws AccessException
usr
- The user for security check
AccessException
- The user is not allowed to create a query
WebDocWf extensionMethod Detail |
public static void assertQueryAccess(User usr) throws AccessException
usr
- The user for security check
AccessException
- The user is not allowed to create a query
WebDocWf extensionpublic static boolean hasQueryAccess(User usr) throws AccessEvalException
usr
- The user for security check
AccessEvalException
public User getUser()
public void setUnique(boolean newUnique)
newUnique
- The unique flag for the query
WebDocWf extensionpublic boolean getUnique()
public void setReadSkip(int newReadSkip)
public int getReadSkip()
public void setDatabaseLimit(int newLimit)
newLimit
- The limit for the query
WebDocWf extensionpublic int getDatabaseLimit()
public boolean getDatabaseLimitExceeded()
public void hitDatabase()
public void setUserStringWildcard(java.lang.String newUserStringWildcard)
public void setUserStringSingleWildcard(java.lang.String newUserStringSingleWildcard)
public void setUserStringSingleWildcardEscape(java.lang.String newUserStringSingleWildcardEscape)
public void setUserStringWildcardEscape(java.lang.String newUserStringWildcardEscape)
public void setUserStringAppendWildcard(boolean userStringAppendWildcard)
public void setUserStringTrim(boolean userStringTrim)
public java.lang.String getUserStringWildcard()
public java.lang.String getUserStringSingleWildcard()
public java.lang.String getUserStringSingleWildcardEscape()
public java.lang.String getUserStringWildcardEscape()
public boolean getUserStringAppendWildcard()
public boolean getUserStringTrim()
public void setMaxRows(int maxRows) throws DataObjectException, NonUniqueQueryException
DataObjectException
- If a database access error occurs.
NonUniqueQueryException
- If too many rows were found.public EnumValueDefinitionDO[] getDOArray() throws DataObjectException, NonUniqueQueryException
DataObjectException
- If a database access error occurs.
NonUniqueQueryException
- If too many rows were found.public EnumValueDefinitionDO getNextDO() throws DataObjectException, NonUniqueQueryException
DataObjectException
- If a database access error occurs.
NonUniqueQueryException
- If too many rows were found.public void setQueryOId(ObjectId oid)
GENERICENUMVALUEDEFINITION
has a column named "oid"
.
This method is called from the DO classes to retrieve an object by id.
oid
- The object id to query.public void setQueryHandle(java.lang.String handle) throws ObjectIdException
handle
- The string version of the id to query.
ObjectIdException
public void requireUniqueInstance()
public void reset()
public java.sql.ResultSet executeQuery(DBConnection conn) throws java.sql.SQLException
executeQuery
in interface Query
conn
- Handle to database connection.
java.sql.SQLException
- If a database access error occurs.public java.lang.Object next(java.sql.ResultSet rs) throws java.sql.SQLException, ObjectIdException
next
in interface Query
rs
- JDBC result set from which the next object
will be instantiated.
java.sql.SQLException
- If a database access error occurs.
ObjectIdException
- If an invalid object id was queried from the database.public java.lang.String convertUserSearchValue(java.lang.String userSearchValue)
userSearchValue
- The string with user wildcards
public boolean containsWildcards(java.lang.String dbSearchValue)
dbSearchValue
- The string with possible DB wildcards
public int getCount() throws NonUniqueQueryException, DataObjectException, java.sql.SQLException, DatabaseManagerException
NonUniqueQueryException
DataObjectException
java.sql.SQLException
DatabaseManagerException
public int selectCount() throws java.sql.SQLException, DatabaseManagerException
java.sql.SQLException
DatabaseManagerException
public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x, java.lang.String cmp_op) throws DataObjectException, QueryException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x, boolean exact) throws DataObjectException, QueryException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or not
DataObjectException
- If a database access error occurs.
QueryException
public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x) throws DataObjectException, QueryException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
DataObjectException
- If a database access error occurs.
QueryException
public void addOrderByENUMTYPEDEFINITIONOID(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByENUMTYPEDEFINITIONOID()
public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x, boolean exact, User usr) throws DataObjectException, QueryException, AccessException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x, User usr) throws DataObjectException, QueryException, AccessException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
WebDocWf extension
QueryException
public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x, java.lang.String cmp_op, User usr) throws DataObjectException, QueryException, AccessException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).
WebDocWf extension
AccessException
public void assertQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x, boolean exact, User usr) throws AccessException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessException
- The user is not allowed to query this attributepublic void assertQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x, java.lang.String cmp_op, User usr) throws AccessException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic void assertQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x, User usr) throws AccessException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic boolean hasQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x, boolean exact, User usr) throws AccessEvalException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessEvalException
public boolean hasQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x, java.lang.String cmp_op, User usr) throws AccessEvalException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessEvalException
public boolean hasQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x, User usr) throws AccessEvalException
x
- The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessEvalException
public void setQueryBEGINSTATE(boolean x, java.lang.String cmp_op) throws DataObjectException, QueryException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).public void setQueryBEGINSTATE(boolean x, boolean exact) throws DataObjectException, QueryException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or not
DataObjectException
- If a database access error occurs.
QueryException
public void setQueryBEGINSTATE(boolean x) throws DataObjectException, QueryException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
DataObjectException
- If a database access error occurs.
QueryException
public void addOrderByBEGINSTATE(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByBEGINSTATE()
public void setQueryBEGINSTATE(boolean x, boolean exact, User usr) throws DataObjectException, QueryException, AccessException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setQueryBEGINSTATE(boolean x, User usr) throws DataObjectException, QueryException, AccessException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
WebDocWf extension
QueryException
public void setQueryBEGINSTATE(boolean x, java.lang.String cmp_op, User usr) throws DataObjectException, QueryException, AccessException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).
WebDocWf extension
AccessException
public void assertQueryAttrBEGINSTATEAccess(boolean x, boolean exact, User usr) throws AccessException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessException
- The user is not allowed to query this attributepublic void assertQueryAttrBEGINSTATEAccess(boolean x, java.lang.String cmp_op, User usr) throws AccessException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic void assertQueryAttrBEGINSTATEAccess(boolean x, User usr) throws AccessException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic boolean hasQueryAttrBEGINSTATEAccess(boolean x, boolean exact, User usr) throws AccessEvalException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessEvalException
public boolean hasQueryAttrBEGINSTATEAccess(boolean x, java.lang.String cmp_op, User usr) throws AccessEvalException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessEvalException
public boolean hasQueryAttrBEGINSTATEAccess(boolean x, User usr) throws AccessEvalException
x
- The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessEvalException
public void setQueryENDSTATE(boolean x, java.lang.String cmp_op) throws DataObjectException, QueryException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).public void setQueryENDSTATE(boolean x, boolean exact) throws DataObjectException, QueryException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or not
DataObjectException
- If a database access error occurs.
QueryException
public void setQueryENDSTATE(boolean x) throws DataObjectException, QueryException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
DataObjectException
- If a database access error occurs.
QueryException
public void addOrderByENDSTATE(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByENDSTATE()
public void setQueryENDSTATE(boolean x, boolean exact, User usr) throws DataObjectException, QueryException, AccessException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setQueryENDSTATE(boolean x, User usr) throws DataObjectException, QueryException, AccessException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
WebDocWf extension
QueryException
public void setQueryENDSTATE(boolean x, java.lang.String cmp_op, User usr) throws DataObjectException, QueryException, AccessException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).
WebDocWf extension
AccessException
public void assertQueryAttrENDSTATEAccess(boolean x, boolean exact, User usr) throws AccessException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessException
- The user is not allowed to query this attributepublic void assertQueryAttrENDSTATEAccess(boolean x, java.lang.String cmp_op, User usr) throws AccessException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic void assertQueryAttrENDSTATEAccess(boolean x, User usr) throws AccessException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic boolean hasQueryAttrENDSTATEAccess(boolean x, boolean exact, User usr) throws AccessEvalException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessEvalException
public boolean hasQueryAttrENDSTATEAccess(boolean x, java.lang.String cmp_op, User usr) throws AccessEvalException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessEvalException
public boolean hasQueryAttrENDSTATEAccess(boolean x, User usr) throws AccessEvalException
x
- The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessEvalException
public void setQueryLONGNAME(java.lang.String x, java.lang.String cmp_op) throws DataObjectException, QueryException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).public void setQueryLONGNAME(java.lang.String x, boolean exact) throws DataObjectException, QueryException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or not
DataObjectException
- If a database access error occurs.
QueryException
public void setQueryLONGNAME(java.lang.String x) throws DataObjectException, QueryException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
DataObjectException
- If a database access error occurs.
QueryException
public void addOrderByLONGNAME(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByLONGNAME()
public void setQueryLONGNAME(java.lang.String x, boolean exact, User usr) throws DataObjectException, QueryException, AccessException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setQueryLONGNAME(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
WebDocWf extension
QueryException
public void setQueryLONGNAME(java.lang.String x, java.lang.String cmp_op, User usr) throws DataObjectException, QueryException, AccessException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).
WebDocWf extension
AccessException
public void assertQueryAttrLONGNAMEAccess(java.lang.String x, boolean exact, User usr) throws AccessException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessException
- The user is not allowed to query this attributepublic void assertQueryAttrLONGNAMEAccess(java.lang.String x, java.lang.String cmp_op, User usr) throws AccessException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic void assertQueryAttrLONGNAMEAccess(java.lang.String x, User usr) throws AccessException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic boolean hasQueryAttrLONGNAMEAccess(java.lang.String x, boolean exact, User usr) throws AccessEvalException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessEvalException
public boolean hasQueryAttrLONGNAMEAccess(java.lang.String x, java.lang.String cmp_op, User usr) throws AccessEvalException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessEvalException
public boolean hasQueryAttrLONGNAMEAccess(java.lang.String x, User usr) throws AccessEvalException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessEvalException
public void setUserMatchLONGNAME(java.lang.String x) throws DataObjectException, QueryException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query with user wildcards
DataObjectException
- If a database access error occurs.
QueryException
public void setUserMatchLONGNAME(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query with user wildcardsusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setDBMatchLONGNAME(java.lang.String x) throws DataObjectException, QueryException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcards
DataObjectException
- If a database access error occurs.
QueryException
public void setDBMatchLONGNAME(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The LONGNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcardsusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setQuerySHORTNAME(java.lang.String x, java.lang.String cmp_op) throws DataObjectException, QueryException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).public void setQuerySHORTNAME(java.lang.String x, boolean exact) throws DataObjectException, QueryException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or not
DataObjectException
- If a database access error occurs.
QueryException
public void setQuerySHORTNAME(java.lang.String x) throws DataObjectException, QueryException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
DataObjectException
- If a database access error occurs.
QueryException
public void addOrderBySHORTNAME(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderBySHORTNAME()
public void setQuerySHORTNAME(java.lang.String x, boolean exact, User usr) throws DataObjectException, QueryException, AccessException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setQuerySHORTNAME(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
WebDocWf extension
QueryException
public void setQuerySHORTNAME(java.lang.String x, java.lang.String cmp_op, User usr) throws DataObjectException, QueryException, AccessException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).
WebDocWf extension
AccessException
public void assertQueryAttrSHORTNAMEAccess(java.lang.String x, boolean exact, User usr) throws AccessException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessException
- The user is not allowed to query this attributepublic void assertQueryAttrSHORTNAMEAccess(java.lang.String x, java.lang.String cmp_op, User usr) throws AccessException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic void assertQueryAttrSHORTNAMEAccess(java.lang.String x, User usr) throws AccessException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic boolean hasQueryAttrSHORTNAMEAccess(java.lang.String x, boolean exact, User usr) throws AccessEvalException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessEvalException
public boolean hasQueryAttrSHORTNAMEAccess(java.lang.String x, java.lang.String cmp_op, User usr) throws AccessEvalException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessEvalException
public boolean hasQueryAttrSHORTNAMEAccess(java.lang.String x, User usr) throws AccessEvalException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessEvalException
public void setUserMatchSHORTNAME(java.lang.String x) throws DataObjectException, QueryException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query with user wildcards
DataObjectException
- If a database access error occurs.
QueryException
public void setUserMatchSHORTNAME(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query with user wildcardsusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setDBMatchSHORTNAME(java.lang.String x) throws DataObjectException, QueryException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcards
DataObjectException
- If a database access error occurs.
QueryException
public void setDBMatchSHORTNAME(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The SHORTNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcardsusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setQueryKEYVALUE(java.lang.String x, java.lang.String cmp_op) throws DataObjectException, QueryException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).public void setQueryKEYVALUE(java.lang.String x, boolean exact) throws DataObjectException, QueryException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or not
DataObjectException
- If a database access error occurs.
QueryException
public void setQueryKEYVALUE(java.lang.String x) throws DataObjectException, QueryException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
DataObjectException
- If a database access error occurs.
QueryException
public void addOrderByKEYVALUE(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByKEYVALUE()
public void setQueryKEYVALUE(java.lang.String x, boolean exact, User usr) throws DataObjectException, QueryException, AccessException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setQueryKEYVALUE(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
WebDocWf extension
QueryException
public void setQueryKEYVALUE(java.lang.String x, java.lang.String cmp_op, User usr) throws DataObjectException, QueryException, AccessException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).
WebDocWf extension
AccessException
public void assertQueryAttrKEYVALUEAccess(java.lang.String x, boolean exact, User usr) throws AccessException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessException
- The user is not allowed to query this attributepublic void assertQueryAttrKEYVALUEAccess(java.lang.String x, java.lang.String cmp_op, User usr) throws AccessException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic void assertQueryAttrKEYVALUEAccess(java.lang.String x, User usr) throws AccessException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic boolean hasQueryAttrKEYVALUEAccess(java.lang.String x, boolean exact, User usr) throws AccessEvalException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessEvalException
public boolean hasQueryAttrKEYVALUEAccess(java.lang.String x, java.lang.String cmp_op, User usr) throws AccessEvalException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessEvalException
public boolean hasQueryAttrKEYVALUEAccess(java.lang.String x, User usr) throws AccessEvalException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessEvalException
public void setUserMatchKEYVALUE(java.lang.String x) throws DataObjectException, QueryException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query with user wildcards
DataObjectException
- If a database access error occurs.
QueryException
public void setUserMatchKEYVALUE(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query with user wildcardsusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setDBMatchKEYVALUE(java.lang.String x) throws DataObjectException, QueryException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query with DB wildcards
DataObjectException
- If a database access error occurs.
QueryException
public void setDBMatchKEYVALUE(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The KEYVALUE of the GENERICENUMVALUEDEFINITION to query with DB wildcardsusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setQueryXMLNAME(java.lang.String x, java.lang.String cmp_op) throws DataObjectException, QueryException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).public void setQueryXMLNAME(java.lang.String x, boolean exact) throws DataObjectException, QueryException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or not
DataObjectException
- If a database access error occurs.
QueryException
public void setQueryXMLNAME(java.lang.String x) throws DataObjectException, QueryException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
DataObjectException
- If a database access error occurs.
QueryException
public void addOrderByXMLNAME(boolean direction_flag)
direction_flag
- True for ascending order, false for descendingpublic void addOrderByXMLNAME()
public void setQueryXMLNAME(java.lang.String x, boolean exact, User usr) throws DataObjectException, QueryException, AccessException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setQueryXMLNAME(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
WebDocWf extension
QueryException
public void setQueryXMLNAME(java.lang.String x, java.lang.String cmp_op, User usr) throws DataObjectException, QueryException, AccessException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
DataObjectException
- If a database access error occurs.
QueryException
- If comparison operator is inappropriate
(e.g. CASE_SENSITIVE_CONTAINS on an integer field).
WebDocWf extension
AccessException
public void assertQueryAttrXMLNAMEAccess(java.lang.String x, boolean exact, User usr) throws AccessException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessException
- The user is not allowed to query this attributepublic void assertQueryAttrXMLNAMEAccess(java.lang.String x, java.lang.String cmp_op, User usr) throws AccessException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic void assertQueryAttrXMLNAMEAccess(java.lang.String x, User usr) throws AccessException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessException
- The user is not allowed to query this attribute
WebDocWf extensionpublic boolean hasQueryAttrXMLNAMEAccess(java.lang.String x, boolean exact, User usr) throws AccessEvalException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.exact
- to use matches or notusr
- The user for security check
AccessEvalException
public boolean hasQueryAttrXMLNAMEAccess(java.lang.String x, java.lang.String cmp_op, User usr) throws AccessEvalException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.cmp_op
- QueryBuilder comparison operator to use.usr
- The user for security check
AccessEvalException
public boolean hasQueryAttrXMLNAMEAccess(java.lang.String x, User usr) throws AccessEvalException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query.usr
- The user for security check
AccessEvalException
public void setUserMatchXMLNAME(java.lang.String x) throws DataObjectException, QueryException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query with user wildcards
DataObjectException
- If a database access error occurs.
QueryException
public void setUserMatchXMLNAME(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query with user wildcardsusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public void setDBMatchXMLNAME(java.lang.String x) throws DataObjectException, QueryException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcards
DataObjectException
- If a database access error occurs.
QueryException
public void setDBMatchXMLNAME(java.lang.String x, User usr) throws DataObjectException, QueryException, AccessException
x
- The XMLNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcardsusr
- The user for security check
DataObjectException
- If a database access error occurs.
AccessException
- The user is not allowed to query this attribute
QueryException
public QueryBuilder getQueryBuilder()
QueryBuilder
that this EnumValueDefinitionQuery
uses to construct and execute database queries.
EnumValueDefinitionQuery.setQueryXXX
methods use
the QueryBuilder
to
append SQL expressions to the "WHERE"
clause to be executed.
The QueryBuilder.addEndClause method.
can be used to
append freeform SQL expressions to the WHERE
clause,
e.g. "ORDER BY name".
Notes regarding cache-enabled DO classes:
DO classes can be cache-enabled.
If when using a EnumValueDefinitionQuery
, the application developer
does not call getQueryBuilder
,
then EnumValueDefinitionQuery.setQueryXXX
methods
simply prune the DO cache and return the remaining results.
However, a QueryBuilder
builds
SELECT
statements for execution by the actual database,
and never searches the built-in cache for the DO.
So, if the DO class is cache-enabled, and getQueryBuilder
is called, this EnumValueDefinitionQuery
object ignores the cache
and hits the actual database.
public void or()
OR
between WHERE
clauses.
Example: find all the persons named Bob or Robert:
PersonQuery pq = new PersonQuery();
pq.setQueryFirstName( "Bob" );
pq.or();
pq.setQueryFirstName( "Robert" );
Note: Calls to setQueryXxx
methods
are implicitly AND
ed together,
so the following example will always return nothing:
PersonQuery pq = new PersonQuery();
pq.setQueryFirstName( "Bob" );
// AND automatically inserted here.
pq.setQueryFirstName( "Robert" );
NOTE: The DO cache does not yet support the OR operator.
Using the or() method forces the query to hit the database.
to construct more elaborate queries.
public void openParen()
WHERE
clause.
Example usage: find all the Bobs and Roberts who are 5 or 50 years old:
PersonQuery pq = new PersonQuery();
pq.openParen();
pq.setQueryFirstName( "Bob" );
pq.or();
pq.setQueryFirstName( "Robert" );
pq.closeParen();
// AND automatically inserted here.
pq.openParen();
pq.setQueryAge( 5 );
pq.or();
pq.setQueryAge( 50 );
pq.closeParen();
NOTE: The DO cache does not yet support the Open Paren operator.
Using the openParen() method forces the query to hit the database.
to construct more elaborate queries.
public void closeParen()
WHERE
clause.
NOTE: The DO cache does not yet support the Close Paren operator.
Using the closeParen() method forces the query to hit the database.
|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |