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 class
ConsoleSAP.EventHistoryFilter
This clas represents a single entry in the SAP ConsoleEvent of DataSource Event History.static class
ConsoleSAP.JavaEventHistoryFilter
This class represents a single entry in the SAP ConsoleEvent of DataSource Java Event History.static class
ConsoleSAP.XIChannelFilter
An 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 void
addFilter(ConsoleSAP.EventHistoryFilter filter)
Adds a single filter to the list of Event History filters.void
addFilter(ConsoleSAP.JavaEventHistoryFilter filter)
Adds a single filter to the list of Java Event History filters.void
addFilter(ConsoleSAP.XIChannelFilter filter)
Adds a single filter to the list of XI Communication Channel filters.void
clear()
Removes all filter entries.java.util.Iterator<ConsoleSAP.EventHistoryFilter>
eventHistoryIterator()
Returns anIterator
for all Event History filters.UC4ObjectName
getLoginName()
boolean
isDataSourceEventHistory()
Returnstrue
if Event History is selected as data source.boolean
isDataSourceJavaEventHistory()
Returnstrue
if Java Event History is selected as data source.boolean
isDataSourceXIChannels()
Returnstrue
if XI Communication Channels is selected as data source.java.util.Iterator<ConsoleSAP.JavaEventHistoryFilter>
javaEventHistoryIterator()
Returns anIterator
for all Java Event History filters.protected void
loadConsole(com.uc4.util.XMLDocument doc, org.w3c.dom.Element consoleElement)
void
selectEventHistory()
Sets the data source to Event History.void
selectJavaEventHistory()
Sets the data source to Java Event History.void
selectXIChannels()
Sets the data source to XI Communication Channels.void
setLoginName(UC4ObjectName loginName)
Sets the name of the login object.int
size()
protected void
storeConsole(com.uc4.util.XMLDocument doc, org.w3c.dom.Element consoleElement)
java.util.Iterator<ConsoleSAP.XIChannelFilter>
xiChannelIterator()
Returns anIterator
for 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:
loadConsole
in classConsoleEventSetting
-
storeConsole
protected void storeConsole(com.uc4.util.XMLDocument doc, org.w3c.dom.Element consoleElement)
- Specified by:
storeConsole
in 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 anIterator
for 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 anIterator
for 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 anIterator
for 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()
Returnstrue
if Event History is selected as data source.- Returns:
- true if data source is Event Historys
-
isDataSourceJavaEventHistory
public boolean isDataSourceJavaEventHistory()
Returnstrue
if Java Event History is selected as data source.- Returns:
- true if data source is Java Event Historys
-
isDataSourceXIChannels
public boolean isDataSourceXIChannels()
Returnstrue
if 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.
-
-