Package com.uc4.api.objects
Class ConsoleSAP
- java.lang.Object
-
- com.uc4.api.objects.ConsoleEventSetting
-
- com.uc4.api.objects.ConsoleSAP
-
public class ConsoleSAP extends ConsoleEventSetting
SAP Console Event.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classConsoleSAP.EventHistoryFilterThis clas represents a single entry in the SAP ConsoleEvent of DataSource Event History.static classConsoleSAP.JavaEventHistoryFilterThis class represents a single entry in the SAP ConsoleEvent of DataSource Java Event History.static classConsoleSAP.XIChannelFilterAn instance of this class represents a single entry in the list of filter for XI Communication channels.
-
Field Summary
-
Fields inherited from class com.uc4.api.objects.ConsoleEventSetting
TYPE_BS2000, TYPE_OS390, TYPE_OS400, TYPE_R3, TYPE_WINDOWS
-
-
Constructor Summary
Constructors Constructor Description ConsoleSAP()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddFilter(ConsoleSAP.EventHistoryFilter filter)Adds a single filter to the list of Event History filters.voidaddFilter(ConsoleSAP.JavaEventHistoryFilter filter)Adds a single filter to the list of Java Event History filters.voidaddFilter(ConsoleSAP.XIChannelFilter filter)Adds a single filter to the list of XI Communication Channel filters.voidclear()Removes all filter entries.java.util.Iterator<ConsoleSAP.EventHistoryFilter>eventHistoryIterator()Returns anIteratorfor all Event History filters.UC4ObjectNamegetLoginName()booleanisDataSourceEventHistory()Returnstrueif Event History is selected as data source.booleanisDataSourceJavaEventHistory()Returnstrueif Java Event History is selected as data source.booleanisDataSourceXIChannels()Returnstrueif XI Communication Channels is selected as data source.java.util.Iterator<ConsoleSAP.JavaEventHistoryFilter>javaEventHistoryIterator()Returns anIteratorfor all Java Event History filters.protected voidloadConsole(com.uc4.util.XMLDocument doc, org.w3c.dom.Element consoleElement)voidselectEventHistory()Sets the data source to Event History.voidselectJavaEventHistory()Sets the data source to Java Event History.voidselectXIChannels()Sets the data source to XI Communication Channels.voidsetLoginName(UC4ObjectName loginName)Sets the name of the login object.intsize()protected voidstoreConsole(com.uc4.util.XMLDocument doc, org.w3c.dom.Element consoleElement)java.util.Iterator<ConsoleSAP.XIChannelFilter>xiChannelIterator()Returns anIteratorfor all XI Communication Channel filters.-
Methods inherited from class com.uc4.api.objects.ConsoleEventSetting
getHostName, setHostName
-
-
-
-
Method Detail
-
loadConsole
protected void loadConsole(com.uc4.util.XMLDocument doc, org.w3c.dom.Element consoleElement)- Specified by:
loadConsolein classConsoleEventSetting
-
storeConsole
protected void storeConsole(com.uc4.util.XMLDocument doc, org.w3c.dom.Element consoleElement)- Specified by:
storeConsolein classConsoleEventSetting
-
getLoginName
public UC4ObjectName getLoginName()
- Returns:
- Name of the Login Object
-
setLoginName
public void setLoginName(UC4ObjectName loginName)
Sets the name of the login object.- Parameters:
loginName- Name of the Login Object
-
addFilter
public void addFilter(ConsoleSAP.EventHistoryFilter filter)
Adds a single filter to the list of Event History filters.- Parameters:
filter- Filter for the SAP Event history
-
addFilter
public void addFilter(ConsoleSAP.JavaEventHistoryFilter filter)
Adds a single filter to the list of Java Event History filters.- Parameters:
filter- Filter for the Java Event history
-
addFilter
public void addFilter(ConsoleSAP.XIChannelFilter filter)
Adds a single filter to the list of XI Communication Channel filters.- Parameters:
filter- Filter for XI Communication Channel monitoring
-
clear
public void clear()
Removes all filter entries.
-
eventHistoryIterator
public java.util.Iterator<ConsoleSAP.EventHistoryFilter> eventHistoryIterator()
Returns anIteratorfor all Event History filters. This iterator can also be used to remove filter entries.- Returns:
- Iterator over EventHistoryFilter
-
javaEventHistoryIterator
public java.util.Iterator<ConsoleSAP.JavaEventHistoryFilter> javaEventHistoryIterator()
Returns anIteratorfor all Java Event History filters. This iterator can also be used to remove filter entries.- Returns:
- Iterator over JavaEventHistoryFilter
-
xiChannelIterator
public java.util.Iterator<ConsoleSAP.XIChannelFilter> xiChannelIterator()
Returns anIteratorfor all XI Communication Channel filters. This iterator can also be used to remove filter entries.- Returns:
- Iterator over xiChannelIterator
-
size
public int size()
- Returns:
- Number of filters.
-
isDataSourceEventHistory
public boolean isDataSourceEventHistory()
Returnstrueif Event History is selected as data source.- Returns:
- true if data source is Event Historys
-
isDataSourceJavaEventHistory
public boolean isDataSourceJavaEventHistory()
Returnstrueif Java Event History is selected as data source.- Returns:
- true if data source is Java Event Historys
-
isDataSourceXIChannels
public boolean isDataSourceXIChannels()
Returnstrueif XI Communication Channels is selected as data source.- Returns:
- true if data source is XI
-
selectEventHistory
public void selectEventHistory()
Sets the data source to Event History.
-
selectJavaEventHistory
public void selectJavaEventHistory()
Sets the data source to Java Event History.
-
selectXIChannels
public void selectXIChannels()
Sets the data source to XI Communication Channels.
-
-