com.uc4.api.objects

Class Operator

java.lang.Object

com.uc4.api.objects.Operator

public class Operator
extends java.lang.Object

Operator settings of an Nofitication.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Operator(com.uc4.util.XMLDocument doc)

Method Summary

Modifier and Type	Method and Description
void	addEmail(java.lang.String emailAddress) Sets an e-mail address to which a notified sent.
void	addEmail(java.lang.String emailAddress, CalendarCondition condition) Sets an e-mail address to which a notified sent on the specified calendar condition.
void	addOperator(UC4ObjectName operator) Adds a new Operator without a calendar condition.
void	addOperator(UC4ObjectName operator, CalendarCondition condition) Adds a new Operator which is notified on the specified calendar condition.
void	clear() Removes all recipients.
java.util.Iterator<ICallOperatorCondition>	operatorIterator() Returns an iterator over ICallOperatorCondition.
int	operatorSize() Returns the number of operator entries returned by the operatorIterator method.
boolean	removeMail(java.lang.String emailAddress) Removes the specified Operator from this Notification.
boolean	removeOperator(UC4ObjectName operator) Removes the specified Operator from this Notification.
protected void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request)

Methods inherited from class java.lang.Object

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

Constructor Detail

Operator

protected Operator(com.uc4.util.XMLDocument doc)

Method Detail

store

protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element request)

clear

public void clear()

Removes all recipients.

addOperator

public void addOperator(UC4ObjectName operator,
                        CalendarCondition condition)

Adds a new Operator which is notified on the specified calendar condition.

Parameters:

operator - Operator which should be notified when this Notification starts

condition - Calendar condition

addEmail

public void addEmail(java.lang.String emailAddress,
                     CalendarCondition condition)

Sets an e-mail address to which a notified sent on the specified calendar condition.

Parameters:

emailAddress - e-mail address

condition - Calendar condition

addOperator

public void addOperator(UC4ObjectName operator)

Adds a new Operator without a calendar condition.

Parameters:

operator - Operator which should be notified when this Notification starts

addEmail

public void addEmail(java.lang.String emailAddress)

Sets an e-mail address to which a notified sent.

Parameters:

emailAddress - e-mail address

removeOperator

public boolean removeOperator(UC4ObjectName operator)

Removes the specified Operator from this Notification.

Parameters:

operator - Name of an Operator or UserGroup

Returns:

True if the Operator was removed successfully

removeMail

public boolean removeMail(java.lang.String emailAddress)

Removes the specified Operator from this Notification.

Parameters:

emailAddress - e-mail address

Returns:

True if the recipient was removed successfully

operatorIterator

public java.util.Iterator<ICallOperatorCondition> operatorIterator()

Returns an iterator over ICallOperatorCondition.

Returns:

Iterator over Operator assignments

operatorSize

public int operatorSize()

Returns the number of operator entries returned by the operatorIterator method.

Returns:

Number of operator entries