com.uc4.communication.requests

Class CalendarList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.CalendarList

All Implemented Interfaces:

Iterable<CalendarList.CalendarListItem>

public class CalendarList
extends XMLRequest
implements Iterable<CalendarList.CalendarListItem>

Lists CALE object names or keywords of a specified calendar.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CalendarList.CalendarListItem Stores the name of a calendar/keyword its unique id.

Constructor Summary

Constructors

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.

Method Summary

Modifier and Type	Method and Description
CalendarList.CalendarListItem	find(String itemName) Returns CalendarListItem instance for the specified name.
Iterator<CalendarList.CalendarListItem>	iterator()
int	size() Returns the number of elements.

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, showQuarantineNotification

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CalendarList

public CalendarList()

Creates a new CalendarList request in order to get a list of calendar names.

CalendarList

public CalendarList(CalendarList.CalendarListItem calendar)

Creates a new CalendarList 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

find

public CalendarList.CalendarListItem find(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 Iterator<CalendarList.CalendarListItem> iterator()

Specified by:

iterator in interface Iterable<CalendarList.CalendarListItem>