Package com.ibm.di.connector.maximo.core

Class MxConnLookup

java.lang.Object

com.ibm.di.connector.maximo.core.AbstractMxConnMode

com.ibm.di.connector.maximo.core.MxConnIterator

com.ibm.di.connector.maximo.core.MxConnLookup

public final class MxConnLookup
extends MxConnIterator

Connector support for Lookup mode.

Since:

7.1

See Also:

MxConnIterator

Field Summary

Fields inherited from class com.ibm.di.connector.maximo.core.MxConnIterator

returnHierarchicalEntries, XML_QUERY_TAG, XML_RESPONSE_TAG, XML_RSSTART_ATTR, XML_RSTOTAL_ATTR

Fields inherited from class com.ibm.di.connector.maximo.core.AbstractMxConnMode

ACTION_ATTR, ACTION_ATTR_PREFIXED, ADD_ACTION, ADDCHANGE_ACTION, CHANGE_ACTION, CHANGED_ATTR, DELETE_ACTION, logger, REPLACE_ACTION

Constructor Summary

Constructors

Constructor	Description
MxConnLookup(MxConnConfiguration cfg, Log logger)	Constructs a MxConnLookup.
MxConnLookup(MxConnConfiguration cfg, Log logger, boolean returnHierarchicalEntries)	Constructs a MxConnLookup.

Method Summary

Modifier and Type	Method	Description
void	setSearchCriteria(SearchCriteria searchCriteria)	Defines the criteria used in the query operation.

Methods inherited from class com.ibm.di.connector.maximo.core.MxConnIterator

executeQuery, getNext

Methods inherited from class com.ibm.di.connector.maximo.core.AbstractMxConnMode

getCfg, post, setCreation, setMessageId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MxConnLookup

public MxConnLookup(MxConnConfiguration cfg,
                    Log logger)

Constructs a MxConnLookup.

Parameters:

cfg - the connector configuration object

logger - logger of the connector

MxConnLookup

public MxConnLookup(MxConnConfiguration cfg,
                    Log logger,
                    boolean returnHierarchicalEntries)

Constructs a MxConnLookup.

Parameters:

cfg - the connector configuration object

logger - logger of the connector

returnHierarchicalEntries - if true hierarchical entries will be returned

Method Detail

setSearchCriteria

public void setSearchCriteria(SearchCriteria searchCriteria)
                       throws MxConnectorException

Defines the criteria used in the query operation.

Parameters:

searchCriteria - criteria used in the query operation

Throws:

MxConnectorException - if hierarchical entries are not used and criteria.getType() != SearchCriteria.SEARCH_AND

MxConnectorException - if hierarchical entries are not used and some SearchCriteria.rscSearch has match attribute different than SearchCriteria.EXACT and SearchCriteria.NOT_STRING

See Also:

MxConnConfiguration.PARAM_QUERY_CRITERIA, MxConnIterator.executeQuery(), EntryConverter.searchCriteriaToXml(SearchCriteria, SchemaElement, boolean)