com.sap.netweaver.bc.uwl.connect

Class ConnectorFilter

java.lang.Object
  extended bycom.sap.netweaver.bc.uwl.connect.ConnectorFilter

public final class ConnectorFilter
extends Object

Contains information on filtering that needs to be done by the connector when items are to be retreived. This information is passed to IProviderConnector.geItems() method.

See Also:
IProviderConnector.getItems(com.sap.netweaver.bc.uwl.UWLContext, java.lang.String, com.sap.netweaver.bc.uwl.connect.ConnectorFilter, java.lang.String), ConnectorResult

Constructor Summary
ConnectorFilter()
           
 
Method Summary
 Date getCurrentUwlSystemTime()
          Specifies the time when method call began.
 Date getFromTime()
          Specifies explictly what is the start date for retrieving items.
 Date getLastSystemSynchronizationTime()
          Provider Connector optionally may set the time at the system, when returning the result.
 Date getLastUwlSynchronizationTime()
          Specifies the time when last synchronization was done.
 void setCurrentUwlSystemTime(Date d)
          This is for internal usage only.
 void setFromTime(Date date)
          Sets the from time.
 void setLastSystemSynchronizationTime(Date date)
           
 void setLastUwlSynchronizationTime(Date date)
          Specifies the time when last synchronization was done.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConnectorFilter

public ConnectorFilter()
Method Detail

getCurrentUwlSystemTime

public Date getCurrentUwlSystemTime()
Specifies the time when method call began. Time is measures on the machine where UWL is running. This time is cluster safe and taken from the database server.

Returns:
non null

setCurrentUwlSystemTime

public void setCurrentUwlSystemTime(Date d)
This is for internal usage only.

Parameters:
d - non null

getFromTime

public Date getFromTime()
Specifies explictly what is the start date for retrieving items. For example, for history items, only past 3 months are important.

Returns:
could be null. Caller has to take care of it.

setFromTime

public void setFromTime(Date date)
Sets the from time.

Parameters:
date -

getLastUwlSynchronizationTime

public Date getLastUwlSynchronizationTime()
Specifies the time when last synchronization was done. This time is w.r.t to UWL and not the item's systems time.

Returns:
could be null

setLastUwlSynchronizationTime

public void setLastUwlSynchronizationTime(Date date)
Specifies the time when last synchronization was done. This time is w.r.t to UWL and not the item's systems time.

Parameters:
date - could be null

getLastSystemSynchronizationTime

public Date getLastSystemSynchronizationTime()
Provider Connector optionally may set the time at the system, when returning the result. In such cases, it is stored in uwl and passed back the next time getItems() is called. Do note that if Provider resides in the same box as UWL there is no need for this time since UWL time is same as the Provider systems time.

Returns:
could be null if not yet set.
See Also:
ConnectorResult.setSystemTimestamp(java.util.Date)

setLastSystemSynchronizationTime

public void setLastSystemSynchronizationTime(Date date)


Copyright 2006 SAP AG Complete Copyright Notice