Package com.uc4.communication.requests
Class CalendarList
- java.lang.Object
-
- com.uc4.communication.requests.XMLRequest
-
- com.uc4.communication.requests.CalendarList
-
- All Implemented Interfaces:
java.lang.Iterable<CalendarList.CalendarListItem>
public class CalendarList extends XMLRequest implements java.lang.Iterable<CalendarList.CalendarListItem>
Lists CALE object names or keywords of a specified calendar.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CalendarList.CalendarListItem
Stores the name of a calendar/keyword its unique id.
-
Constructor Summary
Constructors Constructor Description CalendarList()
Creates a newCalendarList
request in order to get a list of calendar names.CalendarList(CalendarList.CalendarListItem calendar)
Creates a newCalendarList
request which returns all keywords of the specified calendar.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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)
Sub classes extract the values from the XML document and provide public getter methods.protected boolean
isAllowedInClientZero()
This method is used internally.java.util.Iterator<CalendarList.CalendarListItem>
iterator()
int
size()
Returns the number of elements.-
Methods inherited from class com.uc4.communication.requests.XMLRequest
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
-
-
-
-
Constructor Detail
-
CalendarList
public CalendarList()
Creates a newCalendarList
request in order to get a list of calendar names.
-
CalendarList
public CalendarList(CalendarList.CalendarListItem calendar)
Creates a newCalendarList
request which returns all keywords of the specified calendar. If the calendar is not found an empty list is returned.- Parameters:
calendar
-CalendarListItem
instance of the calendar whose keywords should be returned
-
-
Method Detail
-
createRequest
protected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
Description copied from class:XMLRequest
Creates the XML Document for the request. This method is used internally.- Specified by:
createRequest
in classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the session
-
isAllowedInClientZero
protected boolean isAllowedInClientZero()
Description copied from class:XMLRequest
This method is used internally. Tests if thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- Returns:
true
if this request is allowed in client 0,false
otherwise
-
getSrc
protected java.lang.String getSrc()
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- Returns:
- Source
-
handleContent
protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
Description copied from class:XMLRequest
Sub classes extract the values from the XML document and provide public getter methods.- Overrides:
handleContent
in classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
find
public CalendarList.CalendarListItem find(java.lang.String itemName)
Returns CalendarListItem instance for the specified name.- Parameters:
itemName
- Name of the calendar of keyword- Returns:
- CalendarListItem or
null
if not found
-
size
public int size()
Returns the number of elements.- Returns:
- Number of calendar/keyword names
-
iterator
public java.util.Iterator<CalendarList.CalendarListItem> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<CalendarList.CalendarListItem>
-
-