com.uc4.api.objects

Class Calendar

java.lang.Object

com.uc4.api.objects.UC4Object

com.uc4.api.objects.Calendar

All Implemented Interfaces:

IChangeListener

public class Calendar
extends UC4Object
implements IChangeListener

Calendar object.

Constructor Summary

Constructors

Constructor and Description
Calendar()

Method Summary

Modifier and Type	Method and Description
void	addKeyword(CalendarKeyword keyword) Adds the specified calendar keyword to this calendar.
CalendarKeyword	getCalendarkeyword(UC4ObjectName keyword) Gets the specified calendar keyword from this calendar.
Header	header() Returns the header data of this object.
boolean	isExecutable() Returns true if this Object can be executed.
java.util.Iterator<CalendarKeyword>	keywordIterator() Iterator over CalendarKeyword.
protected void	loadContent(com.uc4.util.XMLDocument doc, ConnectionAttributes info)
boolean	removeKeyword(UC4ObjectName keyword) Removes the specified calendar keyword from this calendar It is not possible to remove all keywords.
int	size() Returns the number of keywords in this calendar.
protected void	storeContent(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes sessionInfo) Stores the object specific data under the objectElement element.
void	update() The update method is called if the object changed

Methods inherited from class com.uc4.api.objects.UC4Object

docu, getAccess, getIdnr, getModCount, getName, getType, isOldVersion, load, store, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Calendar

public Calendar()

Method Detail

header

public Header header()

Returns the header data of this object. This is the information of the header tab in the dialog client.

Returns:

header

loadContent

protected void loadContent(com.uc4.util.XMLDocument doc,
                           ConnectionAttributes info)

keywordIterator

public java.util.Iterator<CalendarKeyword> keywordIterator()

Iterator over CalendarKeyword. This iterator can be used to read calendar keywords.

Returns:

Iterator over calendar keywords

addKeyword

public void addKeyword(CalendarKeyword keyword)

Adds the specified calendar keyword to this calendar. The keyword will be overwritten if it already exsits.

Parameters:

keyword - Calendar keyword

removeKeyword

public boolean removeKeyword(UC4ObjectName keyword)

Removes the specified calendar keyword from this calendar It is not possible to remove all keywords. An IllegalStateException will be thrown if the last keyword should be deleted.

Parameters:

keyword - Name of the keyword

Returns:

True if and only if the keyword was successfully removed

getCalendarkeyword

public CalendarKeyword getCalendarkeyword(UC4ObjectName keyword)

Gets the specified calendar keyword from this calendar.

Parameters:

keyword - Name of the keyword

Returns:

the calendar keyword with the specified name or null

storeContent

protected void storeContent(com.uc4.util.XMLDocument doc,
                            org.w3c.dom.Element objectElement,
                            ConnectionAttributes sessionInfo)

Description copied from class: UC4Object

Stores the object specific data under the objectElement element.

Parameters:

doc - XML Document, used to create subelements

objectElement - the newly created elements are children of the objectElement element

sessionInfo - Information about the current session

update

public void update()

Description copied from interface: IChangeListener

The update method is called if the object changed

Specified by:

update in interface IChangeListener

size

public int size()

Returns the number of keywords in this calendar.

Returns:

Number of keywords

isExecutable

public boolean isExecutable()

Description copied from class: UC4Object

Returns true if this Object can be executed.

Specified by:

isExecutable in class UC4Object

Returns:

true if the Object can be executed, false if not.