gov.nih.nci.caarray.domain.search
Interface BiomaterialSearchCategory

All Superinterfaces:
ResourceBasedEnum
All Known Implementing Classes:
ExternalBiomaterialSearchCategory, SearchSampleCategory, SearchSourceCategory

public interface BiomaterialSearchCategory
extends ResourceBasedEnum

Author:
mshestopalov

Method Summary
 java.lang.String[] getJoins()
          These are the fields to join against in the HQL query.
 java.lang.String getResourceKey()
           
 java.lang.String getWhereClause()
           
 

Method Detail

getResourceKey

java.lang.String getResourceKey()
Specified by:
getResourceKey in interface ResourceBasedEnum
Returns:
the resource key that should be used to retrieve a label for this SearchCategory in the UI

getJoins

java.lang.String[] getJoins()
These are the fields to join against in the HQL query. Is null if no join is necessary.

Returns:
the fields to join against

getWhereClause

java.lang.String getWhereClause()
Returns:
the where subclause for this search category. this method assumes that the subclause will be wrapped in parenthesis before being added to the overall where clause of a query.