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

java.lang.Object
  com.ibm.di.connector.maximo.core.AbstractMxConnMode
      com.ibm.di.connector.maximo.core.MxConnIterator

Direct Known Subclasses:

MxConnLookup

public class MxConnIterator
extends AbstractMxConnMode

Connector support for Iterator mode.

Since:

7.1

See Also:

AbstractMxConnMode

Field Summary

protected boolean	returnHierarchicalEntries Flag indicating whether flat or hierarchical entries will be returned.
static java.lang.String	XML_QUERY_TAG
static java.lang.String	XML_RESPONSE_TAG
static java.lang.String	XML_RSSTART_ATTR
static java.lang.String	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

MxConnIterator(MxConnConfiguration cfg, Log log)
Constructs a MxConnIterator.

MxConnIterator(MxConnConfiguration cfg, Log log, boolean returnHierarchicalEntries)
Constructs a MxConnIterator.

Method Summary

void	executeQuery() Sends the query request to Maximo.
Entry	getNext() Returns the next entry found in the query result.

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

Field Detail

XML_RSSTART_ATTR

public static final java.lang.String XML_RSSTART_ATTR

See Also:

Constant Field Values

XML_RSTOTAL_ATTR

public static final java.lang.String XML_RSTOTAL_ATTR

See Also:

Constant Field Values

XML_QUERY_TAG

public static final java.lang.String XML_QUERY_TAG

See Also:

Constant Field Values

XML_RESPONSE_TAG

public static final java.lang.String XML_RESPONSE_TAG

See Also:

Constant Field Values

returnHierarchicalEntries

protected boolean returnHierarchicalEntries

Flag indicating whether flat or hierarchical entries will be returned.

Constructor Detail

MxConnIterator

public MxConnIterator(MxConnConfiguration cfg,
                      Log log)

Constructs a MxConnIterator.

Parameters:

cfg - the connector configuration object

log - logger of the connector

MxConnIterator

public MxConnIterator(MxConnConfiguration cfg,
                      Log log,
                      boolean returnHierarchicalEntries)

Constructs a MxConnIterator.

Parameters:

cfg - the connector configuration object

log - logger of the connector

returnHierarchicalEntries - if true hierarchical entries will be used

Method Detail

executeQuery

public final void executeQuery()
                        throws MxConnectorException

Sends the query request to Maximo.

Throws:

MxConnectorException - if any of the required parameters (page size and query enterprise service) is missing

MxConnectorException - if any sort of comctMxmunication problem occurs

See Also:

MxConnConfiguration.checkIterator()

getNext

public final Entry getNext()
                    throws MxConnectorException

Returns the next entry found in the query result.

Returns:

next entry found, or null if there is no more entries

Throws:

MxConnectorException - if the query result can not be converted into an Entry object

See Also:

executeQuery()