DODS 5.1 API

org.webdocwf.util.genericstore.data
Class EnumValueDefinitionQuery

java.lang.Object
  |
  +--org.webdocwf.util.genericstore.data.EnumValueDefinitionQuery
All Implemented Interfaces:
Query

public class EnumValueDefinitionQuery
extends java.lang.Object
implements Query

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();
 

Version:
$Revision: 1.2 $
Author:
administrator

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

EnumValueDefinitionQuery

public EnumValueDefinitionQuery()
Public constructor.


EnumValueDefinitionQuery

public EnumValueDefinitionQuery(User usr)
                         throws AccessException
Constructor for Query with security

Parameters:
usr - The user for security check
Throws:
AccessException - The user is not allowed to create a query WebDocWf extension
Method Detail

assertQueryAccess

public static void assertQueryAccess(User usr)
                              throws AccessException
Ensure that the given user is allowed to create a query

Parameters:
usr - The user for security check
Throws:
AccessException - The user is not allowed to create a query WebDocWf extension

hasQueryAccess

public static boolean hasQueryAccess(User usr)
                              throws AccessEvalException
Check whether the given user is allowed to create a query

Parameters:
usr - The user for security check
Returns:
Whether the given user is allowed to create a query WebDocWf extension
AccessEvalException

getUser

public User getUser()
Get the user of the query

Returns:
The user of the query WebDocWf extension

setUnique

public void setUnique(boolean newUnique)
Set the unique flag of the query

Parameters:
newUnique - The unique flag for the query WebDocWf extension

getUnique

public boolean getUnique()
Get the unique flag of the query

Returns:
The unique flag of the query WebDocWf extension

setReadSkip

public void setReadSkip(int newReadSkip)
Set the readSkip number of the query


getReadSkip

public int getReadSkip()
Get the readSkip number of the query

Returns:
The number of rows which are skipped WebDocWf extension

setDatabaseLimit

public void setDatabaseLimit(int newLimit)
Set the database limit of the query

Parameters:
newLimit - The limit for the query WebDocWf extension

getDatabaseLimit

public int getDatabaseLimit()
Get the database limit of the query

Returns:
The database limit of the query WebDocWf extension

getDatabaseLimitExceeded

public boolean getDatabaseLimitExceeded()
Get the database limit exceeded flag of the query

Returns:
The database limit exceeded flag of the query True if there would have been more rows than the limit WebDocWf extension

hitDatabase

public void hitDatabase()

setUserStringWildcard

public void setUserStringWildcard(java.lang.String newUserStringWildcard)

setUserStringSingleWildcard

public void setUserStringSingleWildcard(java.lang.String newUserStringSingleWildcard)

setUserStringSingleWildcardEscape

public void setUserStringSingleWildcardEscape(java.lang.String newUserStringSingleWildcardEscape)

setUserStringWildcardEscape

public void setUserStringWildcardEscape(java.lang.String newUserStringWildcardEscape)

setUserStringAppendWildcard

public void setUserStringAppendWildcard(boolean userStringAppendWildcard)

setUserStringTrim

public void setUserStringTrim(boolean userStringTrim)

getUserStringWildcard

public java.lang.String getUserStringWildcard()

getUserStringSingleWildcard

public java.lang.String getUserStringSingleWildcard()

getUserStringSingleWildcardEscape

public java.lang.String getUserStringSingleWildcardEscape()

getUserStringWildcardEscape

public java.lang.String getUserStringWildcardEscape()

getUserStringAppendWildcard

public boolean getUserStringAppendWildcard()

getUserStringTrim

public boolean getUserStringTrim()

setMaxRows

public void setMaxRows(int maxRows)
                throws DataObjectException,
                       NonUniqueQueryException
Limit the number of rows (DOs) returned. NOTE: When setting a limit on rows returned by a query, you usually want to use a call to an addOrderBy method to cause the most interesting rows to be returned first. However, the DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database. So, setMaxRows also forces the query to hit the database.

Throws:
DataObjectException - If a database access error occurs.
NonUniqueQueryException - If too many rows were found.

getDOArray

public EnumValueDefinitionDO[] getDOArray()
                                   throws DataObjectException,
                                          NonUniqueQueryException
Return array of DOs constructed from ResultSet returned by query.

Throws:
DataObjectException - If a database access error occurs.
NonUniqueQueryException - If too many rows were found.

getNextDO

public EnumValueDefinitionDO getNextDO()
                                throws DataObjectException,
                                       NonUniqueQueryException
Return successive DOs from array built from ResultSet returned by query.

Throws:
DataObjectException - If a database access error occurs.
NonUniqueQueryException - If too many rows were found.

setQueryOId

public void setQueryOId(ObjectId oid)
Set the OID to query. WARNING! This method assumes that table GENERICENUMVALUEDEFINITION has a column named "oid". This method is called from the DO classes to retrieve an object by id.

Parameters:
oid - The object id to query.

setQueryHandle

public void setQueryHandle(java.lang.String handle)
                    throws ObjectIdException
Set the object handle to query. This is a variant of setQueryOId().

Parameters:
handle - The string version of the id to query.
ObjectIdException

requireUniqueInstance

public void requireUniqueInstance()
Set "unique instance" assertion bit. The first call to the next() method will throw an exception if more than one object was found.


reset

public void reset()
Reset the query parameters.


executeQuery

public java.sql.ResultSet executeQuery(DBConnection conn)
                                throws java.sql.SQLException
Method to query objects from the database. The following call in runQuery() dbQuery.query( this ); causes the dbQuery object to invoke executeQuery()

Specified by:
executeQuery in interface Query
Parameters:
conn - Handle to database connection.
Throws:
java.sql.SQLException - If a database access error occurs.

next

public java.lang.Object next(java.sql.ResultSet rs)
                      throws java.sql.SQLException,
                             ObjectIdException
WARNING! This method is disabled. It's implementation is forced by the Query interface. This method is disabled for 2 reasons: 1) the getDOArray() and getNextDO() methods are better because they return DOs instead of JDBC objects. 2) the createExisting() method throws an exception that we cannot reasonably handle here, and that we cannot throw from here.

Specified by:
next in interface Query
Parameters:
rs - JDBC result set from which the next object will be instantiated.
Throws:
java.sql.SQLException - If a database access error occurs.
ObjectIdException - If an invalid object id was queried from the database.

convertUserSearchValue

public java.lang.String convertUserSearchValue(java.lang.String userSearchValue)
Convert a String with user wildcards into a string with DB wildcards

Parameters:
userSearchValue - The string with user wildcards
Returns:
The string with DB wildcards WebDocWf extension

containsWildcards

public boolean containsWildcards(java.lang.String dbSearchValue)
Check whether a string contains DB wildcards

Parameters:
dbSearchValue - The string with possible DB wildcards
Returns:
Whether a string contains DB wildcards WebDocWf extension

getCount

public int getCount()
             throws NonUniqueQueryException,
                    DataObjectException,
                    java.sql.SQLException,
                    DatabaseManagerException
Get the rowcount of the query If possible, do it without reading all rows

Returns:
The row count WebDocWf extension
NonUniqueQueryException
DataObjectException
java.sql.SQLException
DatabaseManagerException

selectCount

public int selectCount()
                throws java.sql.SQLException,
                       DatabaseManagerException
Get the rowcount of the query by using count(*) in the DB

Returns:
The row count WebDocWf extension
java.sql.SQLException
DatabaseManagerException

setQueryENUMTYPEDEFINITIONOID

public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x,
                                          java.lang.String cmp_op)
                                   throws DataObjectException,
                                          QueryException
Set the ENUMTYPEDEFINITIONOID to query, with a QueryBuilder comparison operator.

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQueryENUMTYPEDEFINITIONOID

public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x,
                                          boolean exact)
                                   throws DataObjectException,
                                          QueryException
Deprecated. Instead use setQueryENUMTYPEDEFINITIONOID(org.webdocwf.util.genericstore.data.EnumTypeDefinitionDO x,String cmp_op)

Set the ENUMTYPEDEFINITIONOID to query.

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
Throws:
DataObjectException - If a database access error occurs.
QueryException

setQueryENUMTYPEDEFINITIONOID

public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x)
                                   throws DataObjectException,
                                          QueryException
Set the ENUMTYPEDEFINITIONOID to query

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
Throws:
DataObjectException - If a database access error occurs.
QueryException

addOrderByENUMTYPEDEFINITIONOID

public void addOrderByENUMTYPEDEFINITIONOID(boolean direction_flag)
Add ENUMTYPEDEFINITIONOID to the ORDER BY clause. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.

Parameters:
direction_flag - True for ascending order, false for descending

addOrderByENUMTYPEDEFINITIONOID

public void addOrderByENUMTYPEDEFINITIONOID()
Add ENUMTYPEDEFINITIONOID to the ORDER BY clause. This convenience method assumes ascending order. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.


setQueryENUMTYPEDEFINITIONOID

public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x,
                                          boolean exact,
                                          User usr)
                                   throws DataObjectException,
                                          QueryException,
                                          AccessException
Deprecated. Instead use setQueryENUMTYPEDEFINITIONOID(org.webdocwf.util.genericstore.data.EnumTypeDefinitionDO x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension

Set the ENUMTYPEDEFINITIONOID to query.

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQueryENUMTYPEDEFINITIONOID

public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x,
                                          User usr)
                                   throws DataObjectException,
                                          QueryException,
                                          AccessException
Set the ENUMTYPEDEFINITIONOID to query.

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute WebDocWf extension
QueryException

setQueryENUMTYPEDEFINITIONOID

public void setQueryENUMTYPEDEFINITIONOID(EnumTypeDefinitionDO x,
                                          java.lang.String cmp_op,
                                          User usr)
                                   throws DataObjectException,
                                          QueryException,
                                          AccessException
Set the ENUMTYPEDEFINITIONOID to query, with a QueryBuilder comparison operator.

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
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

assertQueryAttrENUMTYPEDEFINITIONOIDAccess

public void assertQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
                                                       boolean exact,
                                                       User usr)
                                                throws AccessException
Deprecated. Instead use assertQueryAttrENUMTYPEDEFINITIONOIDAccess(org.webdocwf.util.genericstore.data.EnumTypeDefinitionDO x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Ensure the given user is allowed to query the attribute

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute

assertQueryAttrENUMTYPEDEFINITIONOIDAccess

public void assertQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
                                                       java.lang.String cmp_op,
                                                       User usr)
                                                throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

assertQueryAttrENUMTYPEDEFINITIONOIDAccess

public void assertQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
                                                       User usr)
                                                throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

hasQueryAttrENUMTYPEDEFINITIONOIDAccess

public boolean hasQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
                                                       boolean exact,
                                                       User usr)
                                                throws AccessEvalException
Deprecated. Instead use hasQueryAttrENUMTYPEDEFINITIONOIDAccess(org.webdocwf.util.genericstore.data.EnumTypeDefinitionDO x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Check whether the given user is allowed to query the attribute

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute
AccessEvalException

hasQueryAttrENUMTYPEDEFINITIONOIDAccess

public boolean hasQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
                                                       java.lang.String cmp_op,
                                                       User usr)
                                                throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

hasQueryAttrENUMTYPEDEFINITIONOIDAccess

public boolean hasQueryAttrENUMTYPEDEFINITIONOIDAccess(EnumTypeDefinitionDO x,
                                                       User usr)
                                                throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The ENUMTYPEDEFINITIONOID of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

setQueryBEGINSTATE

public void setQueryBEGINSTATE(boolean x,
                               java.lang.String cmp_op)
                        throws DataObjectException,
                               QueryException
Set the BEGINSTATE to query, with a QueryBuilder comparison operator.

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQueryBEGINSTATE

public void setQueryBEGINSTATE(boolean x,
                               boolean exact)
                        throws DataObjectException,
                               QueryException
Deprecated. Instead use setQueryBEGINSTATE(boolean x,String cmp_op)

Set the BEGINSTATE to query.

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
Throws:
DataObjectException - If a database access error occurs.
QueryException

setQueryBEGINSTATE

public void setQueryBEGINSTATE(boolean x)
                        throws DataObjectException,
                               QueryException
Set the BEGINSTATE to query

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
Throws:
DataObjectException - If a database access error occurs.
QueryException

addOrderByBEGINSTATE

public void addOrderByBEGINSTATE(boolean direction_flag)
Add BEGINSTATE to the ORDER BY clause. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.

Parameters:
direction_flag - True for ascending order, false for descending

addOrderByBEGINSTATE

public void addOrderByBEGINSTATE()
Add BEGINSTATE to the ORDER BY clause. This convenience method assumes ascending order. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.


setQueryBEGINSTATE

public void setQueryBEGINSTATE(boolean x,
                               boolean exact,
                               User usr)
                        throws DataObjectException,
                               QueryException,
                               AccessException
Deprecated. Instead use setQueryBEGINSTATE(boolean x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension

Set the BEGINSTATE to query.

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQueryBEGINSTATE

public void setQueryBEGINSTATE(boolean x,
                               User usr)
                        throws DataObjectException,
                               QueryException,
                               AccessException
Set the BEGINSTATE to query.

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute WebDocWf extension
QueryException

setQueryBEGINSTATE

public void setQueryBEGINSTATE(boolean x,
                               java.lang.String cmp_op,
                               User usr)
                        throws DataObjectException,
                               QueryException,
                               AccessException
Set the BEGINSTATE to query, with a QueryBuilder comparison operator.

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
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

assertQueryAttrBEGINSTATEAccess

public void assertQueryAttrBEGINSTATEAccess(boolean x,
                                            boolean exact,
                                            User usr)
                                     throws AccessException
Deprecated. Instead use assertQueryAttrBEGINSTATEAccess(boolean x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Ensure the given user is allowed to query the attribute

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute

assertQueryAttrBEGINSTATEAccess

public void assertQueryAttrBEGINSTATEAccess(boolean x,
                                            java.lang.String cmp_op,
                                            User usr)
                                     throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

assertQueryAttrBEGINSTATEAccess

public void assertQueryAttrBEGINSTATEAccess(boolean x,
                                            User usr)
                                     throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

hasQueryAttrBEGINSTATEAccess

public boolean hasQueryAttrBEGINSTATEAccess(boolean x,
                                            boolean exact,
                                            User usr)
                                     throws AccessEvalException
Deprecated. Instead use hasQueryAttrBEGINSTATEAccess(boolean x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Check whether the given user is allowed to query the attribute

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute
AccessEvalException

hasQueryAttrBEGINSTATEAccess

public boolean hasQueryAttrBEGINSTATEAccess(boolean x,
                                            java.lang.String cmp_op,
                                            User usr)
                                     throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

hasQueryAttrBEGINSTATEAccess

public boolean hasQueryAttrBEGINSTATEAccess(boolean x,
                                            User usr)
                                     throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The BEGINSTATE of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

setQueryENDSTATE

public void setQueryENDSTATE(boolean x,
                             java.lang.String cmp_op)
                      throws DataObjectException,
                             QueryException
Set the ENDSTATE to query, with a QueryBuilder comparison operator.

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQueryENDSTATE

public void setQueryENDSTATE(boolean x,
                             boolean exact)
                      throws DataObjectException,
                             QueryException
Deprecated. Instead use setQueryENDSTATE(boolean x,String cmp_op)

Set the ENDSTATE to query.

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
Throws:
DataObjectException - If a database access error occurs.
QueryException

setQueryENDSTATE

public void setQueryENDSTATE(boolean x)
                      throws DataObjectException,
                             QueryException
Set the ENDSTATE to query

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
Throws:
DataObjectException - If a database access error occurs.
QueryException

addOrderByENDSTATE

public void addOrderByENDSTATE(boolean direction_flag)
Add ENDSTATE to the ORDER BY clause. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.

Parameters:
direction_flag - True for ascending order, false for descending

addOrderByENDSTATE

public void addOrderByENDSTATE()
Add ENDSTATE to the ORDER BY clause. This convenience method assumes ascending order. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.


setQueryENDSTATE

public void setQueryENDSTATE(boolean x,
                             boolean exact,
                             User usr)
                      throws DataObjectException,
                             QueryException,
                             AccessException
Deprecated. Instead use setQueryENDSTATE(boolean x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension

Set the ENDSTATE to query.

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQueryENDSTATE

public void setQueryENDSTATE(boolean x,
                             User usr)
                      throws DataObjectException,
                             QueryException,
                             AccessException
Set the ENDSTATE to query.

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute WebDocWf extension
QueryException

setQueryENDSTATE

public void setQueryENDSTATE(boolean x,
                             java.lang.String cmp_op,
                             User usr)
                      throws DataObjectException,
                             QueryException,
                             AccessException
Set the ENDSTATE to query, with a QueryBuilder comparison operator.

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
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

assertQueryAttrENDSTATEAccess

public void assertQueryAttrENDSTATEAccess(boolean x,
                                          boolean exact,
                                          User usr)
                                   throws AccessException
Deprecated. Instead use assertQueryAttrENDSTATEAccess(boolean x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Ensure the given user is allowed to query the attribute

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute

assertQueryAttrENDSTATEAccess

public void assertQueryAttrENDSTATEAccess(boolean x,
                                          java.lang.String cmp_op,
                                          User usr)
                                   throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

assertQueryAttrENDSTATEAccess

public void assertQueryAttrENDSTATEAccess(boolean x,
                                          User usr)
                                   throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

hasQueryAttrENDSTATEAccess

public boolean hasQueryAttrENDSTATEAccess(boolean x,
                                          boolean exact,
                                          User usr)
                                   throws AccessEvalException
Deprecated. Instead use hasQueryAttrENDSTATEAccess(boolean x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Check whether the given user is allowed to query the attribute

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute
AccessEvalException

hasQueryAttrENDSTATEAccess

public boolean hasQueryAttrENDSTATEAccess(boolean x,
                                          java.lang.String cmp_op,
                                          User usr)
                                   throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

hasQueryAttrENDSTATEAccess

public boolean hasQueryAttrENDSTATEAccess(boolean x,
                                          User usr)
                                   throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The ENDSTATE of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

setQueryLONGNAME

public void setQueryLONGNAME(java.lang.String x,
                             java.lang.String cmp_op)
                      throws DataObjectException,
                             QueryException
Set the LONGNAME to query, with a QueryBuilder comparison operator.

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQueryLONGNAME

public void setQueryLONGNAME(java.lang.String x,
                             boolean exact)
                      throws DataObjectException,
                             QueryException
Deprecated. Instead use setQueryLONGNAME(String x,String cmp_op)

Set the LONGNAME to query.

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
Throws:
DataObjectException - If a database access error occurs.
QueryException

setQueryLONGNAME

public void setQueryLONGNAME(java.lang.String x)
                      throws DataObjectException,
                             QueryException
Set the LONGNAME to query

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
Throws:
DataObjectException - If a database access error occurs.
QueryException

addOrderByLONGNAME

public void addOrderByLONGNAME(boolean direction_flag)
Add LONGNAME to the ORDER BY clause. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.

Parameters:
direction_flag - True for ascending order, false for descending

addOrderByLONGNAME

public void addOrderByLONGNAME()
Add LONGNAME to the ORDER BY clause. This convenience method assumes ascending order. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.


setQueryLONGNAME

public void setQueryLONGNAME(java.lang.String x,
                             boolean exact,
                             User usr)
                      throws DataObjectException,
                             QueryException,
                             AccessException
Deprecated. Instead use setQueryLONGNAME(String x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension

Set the LONGNAME to query.

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQueryLONGNAME

public void setQueryLONGNAME(java.lang.String x,
                             User usr)
                      throws DataObjectException,
                             QueryException,
                             AccessException
Set the LONGNAME to query.

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute WebDocWf extension
QueryException

setQueryLONGNAME

public void setQueryLONGNAME(java.lang.String x,
                             java.lang.String cmp_op,
                             User usr)
                      throws DataObjectException,
                             QueryException,
                             AccessException
Set the LONGNAME to query, with a QueryBuilder comparison operator.

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
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

assertQueryAttrLONGNAMEAccess

public void assertQueryAttrLONGNAMEAccess(java.lang.String x,
                                          boolean exact,
                                          User usr)
                                   throws AccessException
Deprecated. Instead use assertQueryAttrLONGNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Ensure the given user is allowed to query the attribute

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute

assertQueryAttrLONGNAMEAccess

public void assertQueryAttrLONGNAMEAccess(java.lang.String x,
                                          java.lang.String cmp_op,
                                          User usr)
                                   throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

assertQueryAttrLONGNAMEAccess

public void assertQueryAttrLONGNAMEAccess(java.lang.String x,
                                          User usr)
                                   throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

hasQueryAttrLONGNAMEAccess

public boolean hasQueryAttrLONGNAMEAccess(java.lang.String x,
                                          boolean exact,
                                          User usr)
                                   throws AccessEvalException
Deprecated. Instead use hasQueryAttrLONGNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Check whether the given user is allowed to query the attribute

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute
AccessEvalException

hasQueryAttrLONGNAMEAccess

public boolean hasQueryAttrLONGNAMEAccess(java.lang.String x,
                                          java.lang.String cmp_op,
                                          User usr)
                                   throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

hasQueryAttrLONGNAMEAccess

public boolean hasQueryAttrLONGNAMEAccess(java.lang.String x,
                                          User usr)
                                   throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

setUserMatchLONGNAME

public void setUserMatchLONGNAME(java.lang.String x)
                          throws DataObjectException,
                                 QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the LONGNAME to query with a user wildcard string

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query with user wildcards
Throws:
DataObjectException - If a database access error occurs.
QueryException

setUserMatchLONGNAME

public void setUserMatchLONGNAME(java.lang.String x,
                                 User usr)
                          throws DataObjectException,
                                 QueryException,
                                 AccessException
Deprecated. Use comparison operators instead WebDocWf extension

Set the LONGNAME to query with a user wildcard string

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query with user wildcards
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setDBMatchLONGNAME

public void setDBMatchLONGNAME(java.lang.String x)
                        throws DataObjectException,
                               QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the LONGNAME to query with a DB wildcard string

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcards
Throws:
DataObjectException - If a database access error occurs.
QueryException

setDBMatchLONGNAME

public void setDBMatchLONGNAME(java.lang.String x,
                               User usr)
                        throws DataObjectException,
                               QueryException,
                               AccessException
Deprecated. Use comparison operators instead WebDocWf extension

Set the LONGNAME to query with a DB wildcard string

Parameters:
x - The LONGNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcards
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQuerySHORTNAME

public void setQuerySHORTNAME(java.lang.String x,
                              java.lang.String cmp_op)
                       throws DataObjectException,
                              QueryException
Set the SHORTNAME to query, with a QueryBuilder comparison operator.

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQuerySHORTNAME

public void setQuerySHORTNAME(java.lang.String x,
                              boolean exact)
                       throws DataObjectException,
                              QueryException
Deprecated. Instead use setQuerySHORTNAME(String x,String cmp_op)

Set the SHORTNAME to query.

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
Throws:
DataObjectException - If a database access error occurs.
QueryException

setQuerySHORTNAME

public void setQuerySHORTNAME(java.lang.String x)
                       throws DataObjectException,
                              QueryException
Set the SHORTNAME to query

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
Throws:
DataObjectException - If a database access error occurs.
QueryException

addOrderBySHORTNAME

public void addOrderBySHORTNAME(boolean direction_flag)
Add SHORTNAME to the ORDER BY clause. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.

Parameters:
direction_flag - True for ascending order, false for descending

addOrderBySHORTNAME

public void addOrderBySHORTNAME()
Add SHORTNAME to the ORDER BY clause. This convenience method assumes ascending order. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.


setQuerySHORTNAME

public void setQuerySHORTNAME(java.lang.String x,
                              boolean exact,
                              User usr)
                       throws DataObjectException,
                              QueryException,
                              AccessException
Deprecated. Instead use setQuerySHORTNAME(String x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension

Set the SHORTNAME to query.

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQuerySHORTNAME

public void setQuerySHORTNAME(java.lang.String x,
                              User usr)
                       throws DataObjectException,
                              QueryException,
                              AccessException
Set the SHORTNAME to query.

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute WebDocWf extension
QueryException

setQuerySHORTNAME

public void setQuerySHORTNAME(java.lang.String x,
                              java.lang.String cmp_op,
                              User usr)
                       throws DataObjectException,
                              QueryException,
                              AccessException
Set the SHORTNAME to query, with a QueryBuilder comparison operator.

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
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

assertQueryAttrSHORTNAMEAccess

public void assertQueryAttrSHORTNAMEAccess(java.lang.String x,
                                           boolean exact,
                                           User usr)
                                    throws AccessException
Deprecated. Instead use assertQueryAttrSHORTNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Ensure the given user is allowed to query the attribute

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute

assertQueryAttrSHORTNAMEAccess

public void assertQueryAttrSHORTNAMEAccess(java.lang.String x,
                                           java.lang.String cmp_op,
                                           User usr)
                                    throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

assertQueryAttrSHORTNAMEAccess

public void assertQueryAttrSHORTNAMEAccess(java.lang.String x,
                                           User usr)
                                    throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

hasQueryAttrSHORTNAMEAccess

public boolean hasQueryAttrSHORTNAMEAccess(java.lang.String x,
                                           boolean exact,
                                           User usr)
                                    throws AccessEvalException
Deprecated. Instead use hasQueryAttrSHORTNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Check whether the given user is allowed to query the attribute

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute
AccessEvalException

hasQueryAttrSHORTNAMEAccess

public boolean hasQueryAttrSHORTNAMEAccess(java.lang.String x,
                                           java.lang.String cmp_op,
                                           User usr)
                                    throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

hasQueryAttrSHORTNAMEAccess

public boolean hasQueryAttrSHORTNAMEAccess(java.lang.String x,
                                           User usr)
                                    throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

setUserMatchSHORTNAME

public void setUserMatchSHORTNAME(java.lang.String x)
                           throws DataObjectException,
                                  QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the SHORTNAME to query with a user wildcard string

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query with user wildcards
Throws:
DataObjectException - If a database access error occurs.
QueryException

setUserMatchSHORTNAME

public void setUserMatchSHORTNAME(java.lang.String x,
                                  User usr)
                           throws DataObjectException,
                                  QueryException,
                                  AccessException
Deprecated. Use comparison operators instead WebDocWf extension

Set the SHORTNAME to query with a user wildcard string

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query with user wildcards
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setDBMatchSHORTNAME

public void setDBMatchSHORTNAME(java.lang.String x)
                         throws DataObjectException,
                                QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the SHORTNAME to query with a DB wildcard string

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcards
Throws:
DataObjectException - If a database access error occurs.
QueryException

setDBMatchSHORTNAME

public void setDBMatchSHORTNAME(java.lang.String x,
                                User usr)
                         throws DataObjectException,
                                QueryException,
                                AccessException
Deprecated. Use comparison operators instead WebDocWf extension

Set the SHORTNAME to query with a DB wildcard string

Parameters:
x - The SHORTNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcards
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQueryKEYVALUE

public void setQueryKEYVALUE(java.lang.String x,
                             java.lang.String cmp_op)
                      throws DataObjectException,
                             QueryException
Set the KEYVALUE to query, with a QueryBuilder comparison operator.

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQueryKEYVALUE

public void setQueryKEYVALUE(java.lang.String x,
                             boolean exact)
                      throws DataObjectException,
                             QueryException
Deprecated. Instead use setQueryKEYVALUE(String x,String cmp_op)

Set the KEYVALUE to query.

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
Throws:
DataObjectException - If a database access error occurs.
QueryException

setQueryKEYVALUE

public void setQueryKEYVALUE(java.lang.String x)
                      throws DataObjectException,
                             QueryException
Set the KEYVALUE to query

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
Throws:
DataObjectException - If a database access error occurs.
QueryException

addOrderByKEYVALUE

public void addOrderByKEYVALUE(boolean direction_flag)
Add KEYVALUE to the ORDER BY clause. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.

Parameters:
direction_flag - True for ascending order, false for descending

addOrderByKEYVALUE

public void addOrderByKEYVALUE()
Add KEYVALUE to the ORDER BY clause. This convenience method assumes ascending order. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.


setQueryKEYVALUE

public void setQueryKEYVALUE(java.lang.String x,
                             boolean exact,
                             User usr)
                      throws DataObjectException,
                             QueryException,
                             AccessException
Deprecated. Instead use setQueryKEYVALUE(String x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension

Set the KEYVALUE to query.

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQueryKEYVALUE

public void setQueryKEYVALUE(java.lang.String x,
                             User usr)
                      throws DataObjectException,
                             QueryException,
                             AccessException
Set the KEYVALUE to query.

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute WebDocWf extension
QueryException

setQueryKEYVALUE

public void setQueryKEYVALUE(java.lang.String x,
                             java.lang.String cmp_op,
                             User usr)
                      throws DataObjectException,
                             QueryException,
                             AccessException
Set the KEYVALUE to query, with a QueryBuilder comparison operator.

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
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

assertQueryAttrKEYVALUEAccess

public void assertQueryAttrKEYVALUEAccess(java.lang.String x,
                                          boolean exact,
                                          User usr)
                                   throws AccessException
Deprecated. Instead use assertQueryAttrKEYVALUEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Ensure the given user is allowed to query the attribute

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute

assertQueryAttrKEYVALUEAccess

public void assertQueryAttrKEYVALUEAccess(java.lang.String x,
                                          java.lang.String cmp_op,
                                          User usr)
                                   throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

assertQueryAttrKEYVALUEAccess

public void assertQueryAttrKEYVALUEAccess(java.lang.String x,
                                          User usr)
                                   throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

hasQueryAttrKEYVALUEAccess

public boolean hasQueryAttrKEYVALUEAccess(java.lang.String x,
                                          boolean exact,
                                          User usr)
                                   throws AccessEvalException
Deprecated. Instead use hasQueryAttrKEYVALUEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Check whether the given user is allowed to query the attribute

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute
AccessEvalException

hasQueryAttrKEYVALUEAccess

public boolean hasQueryAttrKEYVALUEAccess(java.lang.String x,
                                          java.lang.String cmp_op,
                                          User usr)
                                   throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

hasQueryAttrKEYVALUEAccess

public boolean hasQueryAttrKEYVALUEAccess(java.lang.String x,
                                          User usr)
                                   throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

setUserMatchKEYVALUE

public void setUserMatchKEYVALUE(java.lang.String x)
                          throws DataObjectException,
                                 QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the KEYVALUE to query with a user wildcard string

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query with user wildcards
Throws:
DataObjectException - If a database access error occurs.
QueryException

setUserMatchKEYVALUE

public void setUserMatchKEYVALUE(java.lang.String x,
                                 User usr)
                          throws DataObjectException,
                                 QueryException,
                                 AccessException
Deprecated. Use comparison operators instead WebDocWf extension

Set the KEYVALUE to query with a user wildcard string

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query with user wildcards
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setDBMatchKEYVALUE

public void setDBMatchKEYVALUE(java.lang.String x)
                        throws DataObjectException,
                               QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the KEYVALUE to query with a DB wildcard string

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query with DB wildcards
Throws:
DataObjectException - If a database access error occurs.
QueryException

setDBMatchKEYVALUE

public void setDBMatchKEYVALUE(java.lang.String x,
                               User usr)
                        throws DataObjectException,
                               QueryException,
                               AccessException
Deprecated. Use comparison operators instead WebDocWf extension

Set the KEYVALUE to query with a DB wildcard string

Parameters:
x - The KEYVALUE of the GENERICENUMVALUEDEFINITION to query with DB wildcards
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQueryXMLNAME

public void setQueryXMLNAME(java.lang.String x,
                            java.lang.String cmp_op)
                     throws DataObjectException,
                            QueryException
Set the XMLNAME to query, with a QueryBuilder comparison operator.

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
Throws:
DataObjectException - If a database access error occurs.
QueryException - If comparison operator is inappropriate (e.g. CASE_SENSITIVE_CONTAINS on an integer field).

setQueryXMLNAME

public void setQueryXMLNAME(java.lang.String x,
                            boolean exact)
                     throws DataObjectException,
                            QueryException
Deprecated. Instead use setQueryXMLNAME(String x,String cmp_op)

Set the XMLNAME to query.

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
Throws:
DataObjectException - If a database access error occurs.
QueryException

setQueryXMLNAME

public void setQueryXMLNAME(java.lang.String x)
                     throws DataObjectException,
                            QueryException
Set the XMLNAME to query

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
Throws:
DataObjectException - If a database access error occurs.
QueryException

addOrderByXMLNAME

public void addOrderByXMLNAME(boolean direction_flag)
Add XMLNAME to the ORDER BY clause. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.

Parameters:
direction_flag - True for ascending order, false for descending

addOrderByXMLNAME

public void addOrderByXMLNAME()
Add XMLNAME to the ORDER BY clause. This convenience method assumes ascending order. NOTE: The DO cache does not yet support the Order By operation. Using the addOrderBy method forces the query to hit the database.


setQueryXMLNAME

public void setQueryXMLNAME(java.lang.String x,
                            boolean exact,
                            User usr)
                     throws DataObjectException,
                            QueryException,
                            AccessException
Deprecated. Instead use setQueryXMLNAME(String x,String cmp_op, org.webdocwf.dods.access.User usr) WebDocWf extension

Set the XMLNAME to query.

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setQueryXMLNAME

public void setQueryXMLNAME(java.lang.String x,
                            User usr)
                     throws DataObjectException,
                            QueryException,
                            AccessException
Set the XMLNAME to query.

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute WebDocWf extension
QueryException

setQueryXMLNAME

public void setQueryXMLNAME(java.lang.String x,
                            java.lang.String cmp_op,
                            User usr)
                     throws DataObjectException,
                            QueryException,
                            AccessException
Set the XMLNAME to query, with a QueryBuilder comparison operator.

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
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

assertQueryAttrXMLNAMEAccess

public void assertQueryAttrXMLNAMEAccess(java.lang.String x,
                                         boolean exact,
                                         User usr)
                                  throws AccessException
Deprecated. Instead use assertQueryAttrXMLNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Ensure the given user is allowed to query the attribute

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute

assertQueryAttrXMLNAMEAccess

public void assertQueryAttrXMLNAMEAccess(java.lang.String x,
                                         java.lang.String cmp_op,
                                         User usr)
                                  throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

assertQueryAttrXMLNAMEAccess

public void assertQueryAttrXMLNAMEAccess(java.lang.String x,
                                         User usr)
                                  throws AccessException
Ensure the given user is allowed to query the attribute

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Throws:
AccessException - The user is not allowed to query this attribute WebDocWf extension

hasQueryAttrXMLNAMEAccess

public boolean hasQueryAttrXMLNAMEAccess(java.lang.String x,
                                         boolean exact,
                                         User usr)
                                  throws AccessEvalException
Deprecated. Instead use hasQueryAttrXMLNAMEAccess(String x, String cmp_op, org.webdocwf.dods.access.User usr ) WebDocWf extension

Check whether the given user is allowed to query the attribute

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
exact - to use matches or not
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute
AccessEvalException

hasQueryAttrXMLNAMEAccess

public boolean hasQueryAttrXMLNAMEAccess(java.lang.String x,
                                         java.lang.String cmp_op,
                                         User usr)
                                  throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
cmp_op - QueryBuilder comparison operator to use.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

hasQueryAttrXMLNAMEAccess

public boolean hasQueryAttrXMLNAMEAccess(java.lang.String x,
                                         User usr)
                                  throws AccessEvalException
Check whether the given user is allowed to query the attribute

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query.
usr - The user for security check
Returns:
Whether the given user is allowed to query the attribute WebDocWf extension
AccessEvalException

setUserMatchXMLNAME

public void setUserMatchXMLNAME(java.lang.String x)
                         throws DataObjectException,
                                QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the XMLNAME to query with a user wildcard string

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query with user wildcards
Throws:
DataObjectException - If a database access error occurs.
QueryException

setUserMatchXMLNAME

public void setUserMatchXMLNAME(java.lang.String x,
                                User usr)
                         throws DataObjectException,
                                QueryException,
                                AccessException
Deprecated. Use comparison operators instead WebDocWf extension

Set the XMLNAME to query with a user wildcard string

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query with user wildcards
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

setDBMatchXMLNAME

public void setDBMatchXMLNAME(java.lang.String x)
                       throws DataObjectException,
                              QueryException
Deprecated. Use comparison operators instead WebDocWf extension

Set the XMLNAME to query with a DB wildcard string

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcards
Throws:
DataObjectException - If a database access error occurs.
QueryException

setDBMatchXMLNAME

public void setDBMatchXMLNAME(java.lang.String x,
                              User usr)
                       throws DataObjectException,
                              QueryException,
                              AccessException
Deprecated. Use comparison operators instead WebDocWf extension

Set the XMLNAME to query with a DB wildcard string

Parameters:
x - The XMLNAME of the GENERICENUMVALUEDEFINITION to query with DB wildcards
usr - The user for security check
Throws:
DataObjectException - If a database access error occurs.
AccessException - The user is not allowed to query this attribute
QueryException

getQueryBuilder

public QueryBuilder getQueryBuilder()
Returns the 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.


or

public void or()
Insert an 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 ANDed 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.

See Also:
to construct more elaborate queries.

openParen

public void openParen()
Place an open parenthesis in the 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.

See Also:
to construct more elaborate queries.

closeParen

public void closeParen()
Place a closing parenthesis in the 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.


DODS 5.1 API