IBM Rational Performance Tester SDK

com.ibm.rational.common.test.editor.framework.search
Class SearchOptionsContibutor

java.lang.Object
  extended by com.ibm.rational.common.test.editor.framework.search.SearchOptionsContibutor
All Implemented Interfaces:
com.ibm.rational.common.test.editor.framework.kernel.search.IExtensionPointPropertiesNames, com.ibm.rational.common.test.editor.framework.kernel.search.ISearchOptionsContributor

public abstract class SearchOptionsContibutor
extends Object
implements com.ibm.rational.common.test.editor.framework.kernel.search.ISearchOptionsContributor, com.ibm.rational.common.test.editor.framework.kernel.search.IExtensionPointPropertiesNames

Class to be used with com.ibm.rational.test.common.editor.framework.searchTypeOptionsContibutor extension point. This is default implementation of ISearchOptionsProvider.

Since:
RPT 7.0

Field Summary
 
Fields inherited from interface com.ibm.rational.common.test.editor.framework.kernel.search.IExtensionPointPropertiesNames
_CONTRIBUTOR_CLASS, _ID, _OPTIONS_CONTRIBUTOR, _OPTIONS_CONTRIBUTOR_ID, _TYPE_SEARCH_ID, DISCOVERY_INSTANCE, DISCOVERY_METHOD, DISCOVERY_TYPE, EDITOR_OBJECT_TYPE, EDITOR_TYPE, ENABLED, HANDLER_CLASS, ICON, LABEL, OBJECT_TYPE, SEARCHABLE_TYPE, SUB_ID
 
Constructor Summary
SearchOptionsContibutor()
          Default constructor, called from extension point loader.
 
Method Summary
 boolean canSearch()
          Default implementation return true.
 com.ibm.rational.common.test.editor.framework.kernel.search.ISearchComparator getComparator()
           
 SearchForTypeHandler getMasterHandler()
          Returns master handler
 boolean isEnabledAtRuntime()
           
 void nonUiSearchInit(SearchForTypeHandler searcher, boolean calledFromUi)
          Set search handler.
 void pageClosed()
          This implementation does nothing.
 void setComparator(com.ibm.rational.common.test.editor.framework.kernel.search.ISearchComparator comparator)
          Sets comparator.
 void setMasterHandler(SearchForTypeHandler masterHandler)
          Sets master handler.
abstract  void updateOptions(com.ibm.rational.common.test.editor.framework.kernel.search.SearchPageLayout layout)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.rational.common.test.editor.framework.kernel.search.ISearchOptionsContributor
createControl
 

Constructor Detail

SearchOptionsContibutor

public SearchOptionsContibutor()
Default constructor, called from extension point loader.

Method Detail

updateOptions

public abstract void updateOptions(com.ibm.rational.common.test.editor.framework.kernel.search.SearchPageLayout layout)
Specified by:
updateOptions in interface com.ibm.rational.common.test.editor.framework.kernel.search.ISearchOptionsContributor
See Also:
com.ibm.rational.common.test.editor.framework.search.ISearchOptionsProvider#updateOptions(org.eclipse.swt.widgets.Composite, com.ibm.rational.common.test.editor.framework.kernel.search.SearchPageLayout)

getComparator

public com.ibm.rational.common.test.editor.framework.kernel.search.ISearchComparator getComparator()
Specified by:
getComparator in interface com.ibm.rational.common.test.editor.framework.kernel.search.ISearchOptionsContributor
See Also:
ISearchOptionsContributor.getComparator()

setComparator

public void setComparator(com.ibm.rational.common.test.editor.framework.kernel.search.ISearchComparator comparator)
Sets comparator.

Parameters:
comparator - ISearchComparator

isEnabledAtRuntime

public boolean isEnabledAtRuntime()
Specified by:
isEnabledAtRuntime in interface com.ibm.rational.common.test.editor.framework.kernel.search.ISearchOptionsContributor
See Also:
ISearchOptionsContributor.isEnabledAtRuntime()

canSearch

public boolean canSearch()
Default implementation return true.

Specified by:
canSearch in interface com.ibm.rational.common.test.editor.framework.kernel.search.ISearchOptionsContributor
See Also:
com.ibm.rational.common.test.editor.framework.kernel.search.ISearchOptionsContributor#canSerach()

getMasterHandler

public SearchForTypeHandler getMasterHandler()
Returns master handler

Returns:
SearchForTypeHandler to which this contribution belongs.

setMasterHandler

public void setMasterHandler(SearchForTypeHandler masterHandler)
Sets master handler.

Parameters:
masterHandler - The masterHandler to set.

pageClosed

public void pageClosed()
This implementation does nothing.

Specified by:
pageClosed in interface com.ibm.rational.common.test.editor.framework.kernel.search.ISearchOptionsContributor

nonUiSearchInit

public void nonUiSearchInit(SearchForTypeHandler searcher,
                            boolean calledFromUi)
Set search handler.

Parameters:
searcher - SearchForTypeHandler
calledFromUi - boolean. If search is initiated from Search Dialog, this value is true. Downstream classes may want to initialize their searcher differently depending on this value.

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.