Package com.uc4.api.objects

Class Operator

java.lang.Object
com.uc4.api.objects.Operator
public class Operator extends Object
Operator settings of an Nofitication.

  • Constructor Details

    • Operator

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

  • Method Details

    • store

      protected void store(com.uc4.util.XMLDocument doc, 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(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(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(String emailAddress)
      Removes the specified Operator from this Notification.
      Parameters:
      emailAddress - e-mail address
      Returns:
      True if the recipient was removed successfully

    • operatorIterator

      public 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