public abstract class AbstractSearchFacadeClient extends AbstractBusinessObjectDocumentFacadeClient
This class provides a set of methods that can be used to communicate with the Search facade. This class represents a library of Search operations that can be performed. The purpose of this class is to hide the details about constructing the business object document that represents the service request into simple Java methods. The complexity of building the request document and making the request is all managed by this client class of the Search facade.
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
IBM Copyright notice field.
|
Constructor and Description |
---|
AbstractSearchFacadeClient()
Creates an instance of the client to communicate with the Search facade.
|
AbstractSearchFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
Creates an instance of the client to communicate with the Search facade.
|
Modifier and Type | Method and Description |
---|---|
RespondSearchTermAssociationType | changeSearchTermAssociation(ChangeSearchTermAssociationType aChangeSearchTermAssociation)
This method will communicate with the SearchTermAssociation facade and send the specified ChangeSearchTermAssociation request.
|
protected AcknowledgeSearchTermAssociationDataAreaType | checkAcknowledgeSearchTermAssociation(AcknowledgeSearchTermAssociationDataAreaType acknowledgeSearchTermAssociationDataArea)
This method will examine the AcknowledgeSearchTermAssociationDataArea to see if there is any error information reported.
|
protected RespondSearchTermAssociationDataAreaType | checkRespondSearchTermAssociation(RespondSearchTermAssociationDataAreaType respondSearchTermAssociationDataArea)
This method will examine the RespondSearchTermAssociationDataArea to see if there is any error information reported.
|
protected ShowSearchTermAssociationDataAreaType | checkShowSearchTermAssociation(ShowSearchTermAssociationDataAreaType showSearchTermAssociationDataArea)
This method will examine the ShowSearchTermAssociationDataArea to see if there is any error information reported.
|
protected SearchFactory | getSearchFactory()
This method will return the default instance of the Search Factory.
|
ShowSearchTermAssociationType | getSearchTermAssociation(GetSearchTermAssociationType aGetSearchTermAssociation)
This method will communicate with the Search facade and send the specified GetSearchTermAssociation.
|
ShowSearchTermAssociationDataAreaType | getSearchTermAssociation(GetType getVerb)
This method returns the ShowSearchTermAssociationDataArea when issuing the specified get expression to fetch SearchTermAssociations.
|
java.util.List | getSearchTermAssociation(java.lang.String expressionLanguage, java.lang.String expression)
This method returns a list of SearchTermAssociations based on the expression specified.
|
AcknowledgeSearchTermAssociationType | processSearchTermAssociation(ProcessSearchTermAssociationType aProcessSearchTermAssociation)
This method will communicate with the Search facade and send the specified ProcessSearchTermAssociation request.
|
public static final java.lang.String COPYRIGHT
public AbstractSearchFacadeClient()
public AbstractSearchFacadeClient(BusinessContextType businessContext, javax.security.auth.callback.CallbackHandler callbackHandler)
protected SearchFactory getSearchFactory()
public ShowSearchTermAssociationType getSearchTermAssociation(GetSearchTermAssociationType aGetSearchTermAssociation)
public AcknowledgeSearchTermAssociationType processSearchTermAssociation(ProcessSearchTermAssociationType aProcessSearchTermAssociation)
public RespondSearchTermAssociationType changeSearchTermAssociation(ChangeSearchTermAssociationType aChangeSearchTermAssociation)
protected AcknowledgeSearchTermAssociationDataAreaType checkAcknowledgeSearchTermAssociation(AcknowledgeSearchTermAssociationDataAreaType acknowledgeSearchTermAssociationDataArea) throws SearchTermAssociationException
protected RespondSearchTermAssociationDataAreaType checkRespondSearchTermAssociation(RespondSearchTermAssociationDataAreaType respondSearchTermAssociationDataArea) throws SearchTermAssociationException
protected ShowSearchTermAssociationDataAreaType checkShowSearchTermAssociation(ShowSearchTermAssociationDataAreaType showSearchTermAssociationDataArea) throws SearchTermAssociationException
public ShowSearchTermAssociationDataAreaType getSearchTermAssociation(GetType getVerb) throws SearchTermAssociationException
public java.util.List getSearchTermAssociation(java.lang.String expressionLanguage, java.lang.String expression) throws SearchTermAssociationException