com.ibm.ccd.ui.portlets.search.core
Interface IBaseSearch

All Known Implementing Classes:
LookupTableSearchBean, SearchBean

public interface IBaseSearch

This interface lists the methods for search criteria and search results


Field Summary
static java.lang.String AND_OPERATOR
          search logical operator AND
static java.lang.String BUSINESS_ACTION_CONFIG
          indiccates the application mode
static java.lang.String BUSINESS_ACTION_EDIT
          indiccates the application mode
static java.lang.String BUSINESS_ACTION_VIEW
          indiccates the application mode
static java.lang.String BUSINESS_FUNCTION_SEARCH
          Indicates the business function search criteria
static java.lang.String CLASS_NAME_FILE_SAVED_SEARCH
          Indicats tyhe name of class for file implementation of nterface Isavesearch
static java.lang.String DEFAULT_BOOLEAN_OPERATOR
          Indicates the default boolean operator
static java.lang.String DEFAULT_DATE_OPERATOR
          Indicates the default date operator
static java.lang.String DEFAULT_NUMERIC_OPERATOR
          Indicates the default text operator
static java.lang.String DEFAULT_TEXT_OPERATOR
          Indicates the default text operator
static java.lang.String DEFAULT_TRAVERSAL_SIZE
          Indicates the default traversal size
static java.lang.String FLAG_FALSE
          Indicates possible value of flag attribute
static java.lang.String FLAG_TRUE
          Indicates possible value of flag attribute
static java.lang.String FORM_ACTION_CONFIG
          Indicates the form acotion for serach view jsp
static java.lang.String FORM_ACTION_EDIT_SEARCH_CRITERIA
          Indicates the form acotion for serach edit jsp
static java.lang.String FORM_ACTION_PERFORM_SEARCH
          Indicates the form action
static java.lang.String FORM_ACTION_QUICK_SEARCH
          indicates the form action for quick search
static java.lang.String FORM_ACTION_SAVED_SEARCH
          indicates the form action for saved search
static java.lang.String FORM_ACTION_VIEW
          Indicates the form acotion for serach view jsp
static java.lang.String FORM_ACTION_WORK_WITH_ITEM
          Indicates the form action
static java.lang.String HISTORY_FOLDER_NAME
          name of folder for file saved search history
static java.lang.String KEY_ACTION
          key used as parameter name in urlGenration tag
static java.lang.String KEY_MAX_SAVED_SEARCHS
          Indicates the key for storing max saved searchs limit in PortletSettings
static java.lang.String KEY_SAVED_SEARCH_KEY
          indicates the key for saved search in PortletRequest Object
static java.lang.String KEY_SEARCH_CONFIG_BEAN
          Indicates the key for storing SearchConfigBean
static java.lang.String KEY_SEARCH_CRITERIA_BEAN
          Indicates the key for storing SearchCriteriaViewBean
static java.lang.String KEY_SEARCH_ID
          indcates the key for search ID in PortletRequest object
static java.lang.String KEY_SEARCH_RESULTS_BEAN
          Indicates the key for storing SearchResultsViewBean
static java.lang.String KEY_SELECT_SEARCH_CRITERIA
          Name of HTML SELECT contol for search Criteria
static java.lang.String KEY_SELECT_SEARCH_RESULT
          Name of HTML SELECT contol for search Result
static java.lang.String KEY_TRAVERSAL_SIZE
          Key for storing traversal size
static java.lang.String LABEL_CONFIG_SUBMIT
          key for button label
static java.lang.String LABEL_DOWNLOAD
          label for download button on result tab
static java.lang.String LABEL_KEY_NONE
          Indicates the key for 'None'
static java.lang.String LABEL_SCROLL_SIZE
          key for filed name fleld
static java.lang.String LABEL_VIEW_AND
          indicates the lable for "And"
static java.lang.String MAX_SEARCH_COLS
          Indicates the key for storing max no of columns allowed for search
static java.lang.String MAX_SEARCH_HISTORY
          Indicates the constant for retriing label
static java.lang.String MAX_SEARCH_RESULTS
          Indicates constant for max search results to be returned
static java.lang.String MAX_TRAVERSAL_SIZE
           
static java.lang.String MSG_APPLICATION_EXCEPTION
          Indicates the message code for application exception message
static java.lang.String MSG_CONFIG_UPDATE_SUCCESS
          Indicates message code for data updation success
static java.lang.String MSG_EDIT_INFO
          Indicates message code for info on edit page
static java.lang.String MSG_EDIT_UPDATE_SUCCESS
          Indicates message code for data updation success
static java.lang.String MSG_INVALID_NUMBER_VALUE
          Indicates the message code
static java.lang.String MSG_INVALID_TRAVERSAL_SIZE
           
static java.lang.String MSG_MAX_FETCHED_RESULTS
          Indicates message code for max fetched results
static java.lang.String MSG_NO_SEARCH_CRITERIA
          Displays message that no search criteria is entered by user
static java.lang.String MSG_SEARCH_ATTRIBUTES_NOT_SELECTED
          indicates the message user has not selected any search critria
static java.lang.String MSG_SEARCH_CRITERIA
          Indicates key for search history messgae
static java.lang.String MSG_SEARCH_HISTORY
          Indicates key for search history messgae
static java.lang.String MSG_SELECT_QUICK_SEARCH
          Indicates the message to slect search criteria
static java.lang.String MSG_SYSTEM_EXCEPTION
          Indicates the message code for application exception message
static java.lang.String MSG_TRY_LATER
          Indicates the message code for processing failur
static java.lang.String OP_BEGINSWITH
          Indicates the name of text operator
static java.lang.String OP_BEGINSWITH_NOT
          Indicates the name of text operator
static java.lang.String OP_CONTAINS
          Indicates the name of text operator
static java.lang.String OP_CONTAINS_NOT
          Indicates the name of text operator
static java.lang.String OP_ENDSWITH
          Indicates the name of text operator
static java.lang.String OP_ENDSWITH_NOT
          Indicates the name of text operator
static java.lang.String OP_EXACTMATCH
          Indicates the name of text operator
static java.lang.String OP_EXACTMATCH_NOT
          Indicates the name of text operator
static java.lang.String OP_ISEMPTY
          Indicates the name of text operator
static java.lang.String OP_ISEMPTY_NOT
          Indicates the name of text operator
static java.lang.String PREFIX_LOCALISATION
          Indicates the prefix for keys in properties files
static java.lang.String PREFIX_SEARCH_CRITERIA
          Indicates prefix for search criteria column
static java.lang.String PREFIX_SEARCH_RESULT
          Indicates prefix for search result column
static java.lang.String RELATIVE_FOLDER_PATH
          relative path of foler from servlet real path
static java.lang.String SEARCH_RESULT_FORM_ACTION_EDIT
          Indicates the form action for serach result edit jsp
static java.lang.String SEARCH_RESULT_FORM_ACTION_VIEW
          Indicates the form action for serach result view jsp
static java.lang.String TYPE_SELECT
          Indicates the UI control of type select
static java.lang.String TYPE_TEXT
          Indicates the UI control of type text
static java.lang.String URL_STRING_SEPERATOR
          Indicates the seperator used in search URL String
static java.lang.String WORK_WITH_ITEM_PORLET_NAME
          indicates path of help jsp
static java.lang.String WPC_SEARCH_ATTRIBUTE_END_TAG
          search Attribute end tag
static java.lang.String WPC_SEARCH_ATTRIBUTE_START_TAG
          search Attribute start tag
static java.lang.String WPC_SEARCH_ELEMENT_END_TAG
          end of search tag
static java.lang.String WPC_SEARCH_ELEMENT_OPERATOR_END_TAG
          search element operator end tag
static java.lang.String WPC_SEARCH_ELEMENT_OPERATOR_START_TAG
          search element operator start tag
static java.lang.String WPC_SEARCH_ELEMENT_START_TAG
          start of search tag
static java.lang.String WPC_SEARCH_OPERATOR_END_TAG
          search operator end tag
static java.lang.String WPC_SEARCH_OPERATOR_OR_START_TAG
          search operator start tag
static java.lang.String WPC_SEARCH_OPERATOR_START_TAG
          search operator start tag
static java.lang.String WPC_SEARCH_PREDICATE_END_TAG
          search opperator end tag
static java.lang.String WPC_SEARCH_PREDICATE_START_TAG
          search value start tag
static java.lang.String WPC_SEARCH_VALUE_END_TAG
          search value end tag
static java.lang.String WPC_SEARCH_VALUE_START_TAG
          search value start tag
 
Method Summary
 java.lang.String getReqXML()
           
 java.util.ArrayList getSearchCriteriaElements()
          This methods returns the list of BasicSearchElements containig the search criteria.
 ResultData getSearchResults()
           
 void setReqXML(java.lang.String string)
           
 

Field Detail

TYPE_TEXT

static final java.lang.String TYPE_TEXT
Indicates the UI control of type text

See Also:
Constant Field Values

TYPE_SELECT

static final java.lang.String TYPE_SELECT
Indicates the UI control of type select

See Also:
Constant Field Values

FORM_ACTION_EDIT_SEARCH_CRITERIA

static final java.lang.String FORM_ACTION_EDIT_SEARCH_CRITERIA
Indicates the form acotion for serach edit jsp

See Also:
Constant Field Values

FORM_ACTION_VIEW

static final java.lang.String FORM_ACTION_VIEW
Indicates the form acotion for serach view jsp

See Also:
Constant Field Values

FORM_ACTION_CONFIG

static final java.lang.String FORM_ACTION_CONFIG
Indicates the form acotion for serach view jsp

See Also:
Constant Field Values

KEY_SEARCH_CRITERIA_BEAN

static final java.lang.String KEY_SEARCH_CRITERIA_BEAN
Indicates the key for storing SearchCriteriaViewBean

See Also:
Constant Field Values

BUSINESS_FUNCTION_SEARCH

static final java.lang.String BUSINESS_FUNCTION_SEARCH
Indicates the business function search criteria

See Also:
Constant Field Values

BUSINESS_ACTION_VIEW

static final java.lang.String BUSINESS_ACTION_VIEW
indiccates the application mode

See Also:
Constant Field Values

BUSINESS_ACTION_EDIT

static final java.lang.String BUSINESS_ACTION_EDIT
indiccates the application mode

See Also:
Constant Field Values

BUSINESS_ACTION_CONFIG

static final java.lang.String BUSINESS_ACTION_CONFIG
indiccates the application mode

See Also:
Constant Field Values

MAX_SEARCH_COLS

static final java.lang.String MAX_SEARCH_COLS
Indicates the key for storing max no of columns allowed for search

See Also:
Constant Field Values

MAX_SEARCH_RESULTS

static final java.lang.String MAX_SEARCH_RESULTS
Indicates constant for max search results to be returned

See Also:
Constant Field Values

MAX_TRAVERSAL_SIZE

static final java.lang.String MAX_TRAVERSAL_SIZE
See Also:
Constant Field Values

SEARCH_RESULT_FORM_ACTION_EDIT

static final java.lang.String SEARCH_RESULT_FORM_ACTION_EDIT
Indicates the form action for serach result edit jsp

See Also:
Constant Field Values

SEARCH_RESULT_FORM_ACTION_VIEW

static final java.lang.String SEARCH_RESULT_FORM_ACTION_VIEW
Indicates the form action for serach result view jsp

See Also:
Constant Field Values

KEY_SEARCH_RESULTS_BEAN

static final java.lang.String KEY_SEARCH_RESULTS_BEAN
Indicates the key for storing SearchResultsViewBean

See Also:
Constant Field Values

FORM_ACTION_PERFORM_SEARCH

static final java.lang.String FORM_ACTION_PERFORM_SEARCH
Indicates the form action

See Also:
Constant Field Values

FORM_ACTION_WORK_WITH_ITEM

static final java.lang.String FORM_ACTION_WORK_WITH_ITEM
Indicates the form action

See Also:
Constant Field Values

FORM_ACTION_SAVED_SEARCH

static final java.lang.String FORM_ACTION_SAVED_SEARCH
indicates the form action for saved search

See Also:
Constant Field Values

FORM_ACTION_QUICK_SEARCH

static final java.lang.String FORM_ACTION_QUICK_SEARCH
indicates the form action for quick search

See Also:
Constant Field Values

KEY_ACTION

static final java.lang.String KEY_ACTION
key used as parameter name in urlGenration tag

See Also:
Constant Field Values

LABEL_SCROLL_SIZE

static final java.lang.String LABEL_SCROLL_SIZE
key for filed name fleld

See Also:
Constant Field Values

LABEL_CONFIG_SUBMIT

static final java.lang.String LABEL_CONFIG_SUBMIT
key for button label

See Also:
Constant Field Values

KEY_SEARCH_CONFIG_BEAN

static final java.lang.String KEY_SEARCH_CONFIG_BEAN
Indicates the key for storing SearchConfigBean

See Also:
Constant Field Values

MSG_INVALID_NUMBER_VALUE

static final java.lang.String MSG_INVALID_NUMBER_VALUE
Indicates the message code

See Also:
Constant Field Values

MSG_EDIT_INFO

static final java.lang.String MSG_EDIT_INFO
Indicates message code for info on edit page

See Also:
Constant Field Values

MSG_EDIT_UPDATE_SUCCESS

static final java.lang.String MSG_EDIT_UPDATE_SUCCESS
Indicates message code for data updation success

See Also:
Constant Field Values

MSG_CONFIG_UPDATE_SUCCESS

static final java.lang.String MSG_CONFIG_UPDATE_SUCCESS
Indicates message code for data updation success

See Also:
Constant Field Values

MSG_MAX_FETCHED_RESULTS

static final java.lang.String MSG_MAX_FETCHED_RESULTS
Indicates message code for max fetched results

See Also:
Constant Field Values

MSG_APPLICATION_EXCEPTION

static final java.lang.String MSG_APPLICATION_EXCEPTION
Indicates the message code for application exception message

See Also:
Constant Field Values

MSG_SYSTEM_EXCEPTION

static final java.lang.String MSG_SYSTEM_EXCEPTION
Indicates the message code for application exception message

See Also:
Constant Field Values

MSG_TRY_LATER

static final java.lang.String MSG_TRY_LATER
Indicates the message code for processing failur

See Also:
Constant Field Values

MSG_SEARCH_HISTORY

static final java.lang.String MSG_SEARCH_HISTORY
Indicates key for search history messgae

See Also:
Constant Field Values

MSG_SEARCH_CRITERIA

static final java.lang.String MSG_SEARCH_CRITERIA
Indicates key for search history messgae

See Also:
Constant Field Values

MSG_NO_SEARCH_CRITERIA

static final java.lang.String MSG_NO_SEARCH_CRITERIA
Displays message that no search criteria is entered by user

See Also:
Constant Field Values

MSG_SEARCH_ATTRIBUTES_NOT_SELECTED

static final java.lang.String MSG_SEARCH_ATTRIBUTES_NOT_SELECTED
indicates the message user has not selected any search critria

See Also:
Constant Field Values

MSG_SELECT_QUICK_SEARCH

static final java.lang.String MSG_SELECT_QUICK_SEARCH
Indicates the message to slect search criteria

See Also:
Constant Field Values

MSG_INVALID_TRAVERSAL_SIZE

static final java.lang.String MSG_INVALID_TRAVERSAL_SIZE
See Also:
Constant Field Values

PREFIX_SEARCH_RESULT

static final java.lang.String PREFIX_SEARCH_RESULT
Indicates prefix for search result column

See Also:
Constant Field Values

PREFIX_SEARCH_CRITERIA

static final java.lang.String PREFIX_SEARCH_CRITERIA
Indicates prefix for search criteria column

See Also:
Constant Field Values

KEY_TRAVERSAL_SIZE

static final java.lang.String KEY_TRAVERSAL_SIZE
Key for storing traversal size

See Also:
Constant Field Values

DEFAULT_TRAVERSAL_SIZE

static final java.lang.String DEFAULT_TRAVERSAL_SIZE
Indicates the default traversal size

See Also:
Constant Field Values

WPC_SEARCH_ELEMENT_START_TAG

static final java.lang.String WPC_SEARCH_ELEMENT_START_TAG
start of search tag

See Also:
Constant Field Values

WPC_SEARCH_ELEMENT_END_TAG

static final java.lang.String WPC_SEARCH_ELEMENT_END_TAG
end of search tag

See Also:
Constant Field Values

WPC_SEARCH_ATTRIBUTE_START_TAG

static final java.lang.String WPC_SEARCH_ATTRIBUTE_START_TAG
search Attribute start tag

See Also:
Constant Field Values

WPC_SEARCH_ATTRIBUTE_END_TAG

static final java.lang.String WPC_SEARCH_ATTRIBUTE_END_TAG
search Attribute end tag

See Also:
Constant Field Values

WPC_SEARCH_VALUE_START_TAG

static final java.lang.String WPC_SEARCH_VALUE_START_TAG
search value start tag

See Also:
Constant Field Values

WPC_SEARCH_VALUE_END_TAG

static final java.lang.String WPC_SEARCH_VALUE_END_TAG
search value end tag

See Also:
Constant Field Values

WPC_SEARCH_ELEMENT_OPERATOR_START_TAG

static final java.lang.String WPC_SEARCH_ELEMENT_OPERATOR_START_TAG
search element operator start tag

See Also:
Constant Field Values

WPC_SEARCH_ELEMENT_OPERATOR_END_TAG

static final java.lang.String WPC_SEARCH_ELEMENT_OPERATOR_END_TAG
search element operator end tag

See Also:
Constant Field Values

WPC_SEARCH_PREDICATE_START_TAG

static final java.lang.String WPC_SEARCH_PREDICATE_START_TAG
search value start tag

See Also:
Constant Field Values

WPC_SEARCH_PREDICATE_END_TAG

static final java.lang.String WPC_SEARCH_PREDICATE_END_TAG
search opperator end tag

See Also:
Constant Field Values

WPC_SEARCH_OPERATOR_START_TAG

static final java.lang.String WPC_SEARCH_OPERATOR_START_TAG
search operator start tag

See Also:
Constant Field Values

WPC_SEARCH_OPERATOR_OR_START_TAG

static final java.lang.String WPC_SEARCH_OPERATOR_OR_START_TAG
search operator start tag

See Also:
Constant Field Values

WPC_SEARCH_OPERATOR_END_TAG

static final java.lang.String WPC_SEARCH_OPERATOR_END_TAG
search operator end tag

See Also:
Constant Field Values

AND_OPERATOR

static final java.lang.String AND_OPERATOR
search logical operator AND

See Also:
Constant Field Values

WORK_WITH_ITEM_PORLET_NAME

static final java.lang.String WORK_WITH_ITEM_PORLET_NAME
indicates path of help jsp

See Also:
Constant Field Values

OP_BEGINSWITH

static final java.lang.String OP_BEGINSWITH
Indicates the name of text operator

See Also:
Constant Field Values

OP_BEGINSWITH_NOT

static final java.lang.String OP_BEGINSWITH_NOT
Indicates the name of text operator

See Also:
Constant Field Values

OP_CONTAINS

static final java.lang.String OP_CONTAINS
Indicates the name of text operator

See Also:
Constant Field Values

OP_CONTAINS_NOT

static final java.lang.String OP_CONTAINS_NOT
Indicates the name of text operator

See Also:
Constant Field Values

OP_ENDSWITH

static final java.lang.String OP_ENDSWITH
Indicates the name of text operator

See Also:
Constant Field Values

OP_ENDSWITH_NOT

static final java.lang.String OP_ENDSWITH_NOT
Indicates the name of text operator

See Also:
Constant Field Values

OP_ISEMPTY

static final java.lang.String OP_ISEMPTY
Indicates the name of text operator

See Also:
Constant Field Values

OP_ISEMPTY_NOT

static final java.lang.String OP_ISEMPTY_NOT
Indicates the name of text operator

See Also:
Constant Field Values

OP_EXACTMATCH

static final java.lang.String OP_EXACTMATCH
Indicates the name of text operator

See Also:
Constant Field Values

OP_EXACTMATCH_NOT

static final java.lang.String OP_EXACTMATCH_NOT
Indicates the name of text operator

See Also:
Constant Field Values

FLAG_TRUE

static final java.lang.String FLAG_TRUE
Indicates possible value of flag attribute

See Also:
Constant Field Values

FLAG_FALSE

static final java.lang.String FLAG_FALSE
Indicates possible value of flag attribute

See Also:
Constant Field Values

PREFIX_LOCALISATION

static final java.lang.String PREFIX_LOCALISATION
Indicates the prefix for keys in properties files

See Also:
Constant Field Values

DEFAULT_TEXT_OPERATOR

static final java.lang.String DEFAULT_TEXT_OPERATOR
Indicates the default text operator

See Also:
Constant Field Values

DEFAULT_NUMERIC_OPERATOR

static final java.lang.String DEFAULT_NUMERIC_OPERATOR
Indicates the default text operator

See Also:
Constant Field Values

DEFAULT_BOOLEAN_OPERATOR

static final java.lang.String DEFAULT_BOOLEAN_OPERATOR
Indicates the default boolean operator

See Also:
Constant Field Values

DEFAULT_DATE_OPERATOR

static final java.lang.String DEFAULT_DATE_OPERATOR
Indicates the default date operator

See Also:
Constant Field Values

KEY_SAVED_SEARCH_KEY

static final java.lang.String KEY_SAVED_SEARCH_KEY
indicates the key for saved search in PortletRequest Object

See Also:
Constant Field Values

CLASS_NAME_FILE_SAVED_SEARCH

static final java.lang.String CLASS_NAME_FILE_SAVED_SEARCH
Indicats tyhe name of class for file implementation of nterface Isavesearch

See Also:
Constant Field Values

KEY_MAX_SAVED_SEARCHS

static final java.lang.String KEY_MAX_SAVED_SEARCHS
Indicates the key for storing max saved searchs limit in PortletSettings

See Also:
Constant Field Values

URL_STRING_SEPERATOR

static final java.lang.String URL_STRING_SEPERATOR
Indicates the seperator used in search URL String

See Also:
Constant Field Values

KEY_SEARCH_ID

static final java.lang.String KEY_SEARCH_ID
indcates the key for search ID in PortletRequest object

See Also:
Constant Field Values

MAX_SEARCH_HISTORY

static final java.lang.String MAX_SEARCH_HISTORY
Indicates the constant for retriing label

See Also:
Constant Field Values

HISTORY_FOLDER_NAME

static final java.lang.String HISTORY_FOLDER_NAME
name of folder for file saved search history

See Also:
Constant Field Values

RELATIVE_FOLDER_PATH

static final java.lang.String RELATIVE_FOLDER_PATH
relative path of foler from servlet real path

See Also:
Constant Field Values

LABEL_VIEW_AND

static final java.lang.String LABEL_VIEW_AND
indicates the lable for "And"

See Also:
Constant Field Values

LABEL_DOWNLOAD

static final java.lang.String LABEL_DOWNLOAD
label for download button on result tab

See Also:
Constant Field Values

KEY_SELECT_SEARCH_CRITERIA

static final java.lang.String KEY_SELECT_SEARCH_CRITERIA
Name of HTML SELECT contol for search Criteria

See Also:
Constant Field Values

KEY_SELECT_SEARCH_RESULT

static final java.lang.String KEY_SELECT_SEARCH_RESULT
Name of HTML SELECT contol for search Result

See Also:
Constant Field Values

LABEL_KEY_NONE

static final java.lang.String LABEL_KEY_NONE
Indicates the key for 'None'

See Also:
Constant Field Values
Method Detail

getSearchCriteriaElements

java.util.ArrayList getSearchCriteriaElements()
                                              throws java.lang.Exception
This methods returns the list of BasicSearchElements containig the search criteria.

Returns:
ArraList
Throws:
java.lang.Exception

getSearchResults

ResultData getSearchResults()
                            throws UIException
Throws:
UIException

getReqXML

java.lang.String getReqXML()

setReqXML

void setReqXML(java.lang.String string)