public class CalendarList extends XMLRequest implements java.lang.Iterable<CalendarList.CalendarListItem>
Modifier and Type | Class and Description |
---|---|
static class |
CalendarList.CalendarListItem
Stores the name of a calendar/keyword its unique id.
|
Constructor and Description |
---|
CalendarList()
Creates a new
CalendarList request in order to get a list of calendar names. |
CalendarList(CalendarList.CalendarListItem calendar)
Creates a new
CalendarList request which returns all keywords of the specified calendar. |
Modifier and Type | Method and Description |
---|---|
protected void |
createRequest(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element request,
ConnectionAttributes sessionInfo)
Creates the XML Document for the request.
|
CalendarList.CalendarListItem |
find(java.lang.String itemName)
Returns CalendarListItem instance for the specified name.
|
protected java.lang.String |
getSrc()
Returns the request source.
|
protected void |
handleContent(com.uc4.util.XMLDocument doc,
ConnectionAttributes session) |
protected boolean |
isAllowedInClientZero()
This method is used internally.
|
java.util.Iterator<CalendarList.CalendarListItem> |
iterator() |
int |
size()
Returns the number of elements.
|
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
public CalendarList()
CalendarList
request in order to get a list of calendar names.public CalendarList(CalendarList.CalendarListItem calendar)
CalendarList
request which returns all keywords of the specified calendar.
If the calendar is not found an empty list is returned.calendar
- CalendarListItem
instance of the calendar whose keywords should be returnedprotected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
XMLRequest
createRequest
in class XMLRequest
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the sessionprotected boolean isAllowedInClientZero()
XMLRequest
XMLRequest
is allowed in client 0.
The default implementation returns false
, subclasses may override.isAllowedInClientZero
in class XMLRequest
true
if this request is allowed in client 0, false
otherwiseprotected java.lang.String getSrc()
XMLRequest
getSrc
in class XMLRequest
protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
handleContent
in class XMLRequest
public CalendarList.CalendarListItem find(java.lang.String itemName)
itemName
- Name of the calendar of keywordnull
if not foundpublic int size()
public java.util.Iterator<CalendarList.CalendarListItem> iterator()
iterator
in interface java.lang.Iterable<CalendarList.CalendarListItem>