Package com.uc4.api.objects

Class SloFulfillment

java.lang.Object
com.uc4.api.objects.SloFulfillment
public class SloFulfillment extends Object
Represents the fulfillment sheet of SLO objects.

  • Constructor Details

    • SloFulfillment

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

  • Method Details

    • isConsiderMRT

      public boolean isConsiderMRT()
      Returns:
      true if the maximum runtime should be checked

    • isConsiderSRT

      public boolean isConsiderSRT()
      Returns:
      true if the minimum runtime should be checked

    • isConsiderStatus

      public boolean isConsiderStatus()
      Returns:
      true if the status should be checked

    • isConsiderStartTime

      public boolean isConsiderStartTime()
      Returns:
      true if start time should be checked

    • isConsiderEndTime

      public boolean isConsiderEndTime()
      Returns:
      true if end time should be checked

    • isSunday

      public boolean isSunday()
      Returns:
      True if sunday is selected

    • isMonday

      public boolean isMonday()
      Returns:
      True if monday is selected

    • isTuesday

      public boolean isTuesday()
      Returns:
      True if tuesday is selected

    • isWednesday

      public boolean isWednesday()
      Returns:
      True if wednesday is selected

    • isThursday

      public boolean isThursday()
      Returns:
      True if thursday is selected

    • isFriday

      public boolean isFriday()
      Returns:
      True if friday is selected

    • isSaturday

      public boolean isSaturday()
      Returns:
      True if saturday is selected

    • getExpectedStatus

      public TaskState getExpectedStatus()
      Returns:
      Expected status as defined in UC_ZUTYP.

    • getLatestStartTime

      public Time getLatestStartTime()
      Returns:
      Latest start time for fulfillment.

    • getLatestEndTime

      public Time getLatestEndTime()
      Returns:
      Latest end time for fulfillment.

    • setConsiderMRT

      public void setConsiderMRT(boolean considerMRT)
      Defines if the MRT should be considered.
      Parameters:
      considerMRT - true if the maximum runtime should be considered for fulfillment.

    • setConsiderSRT

      public void setConsiderSRT(boolean considerSRT)
      Defines if the SRT should be considered.
      Parameters:
      considerSRT - true if the minimum runtime should be considered for fulfillment.

    • setConsiderStatus

      public void setConsiderStatus(boolean considerStatus)
      Defines if the status should be considered.
      Parameters:
      considerStatus - true if the status should be considered for fulfillment.

    • setExpectedStatus

      public void setExpectedStatus(TaskState expectedStatus)
      Sets the expected status for fulfillment.
      Parameters:
      expectedStatus - Expected status

    • setConsiderStartTime

      public void setConsiderStartTime(boolean considerStartTime)
      Defines if start time should be considered.
      Parameters:
      considerStartTime - true if start time should be considered for fulfillment

    • setLatestStartTime

      public void setLatestStartTime(Time latestStartTime)
      Defines latest start time for fulfillment.
      Parameters:
      latestStartTime - sets Latest start time

    • setConsiderEndTime

      public void setConsiderEndTime(boolean considerEndTime)
      Defines if end time should be considered.
      Parameters:
      considerEndTime - true if start time should be considered for fulfillment

    • setLatestEndTime

      public void setLatestEndTime(Time latestEndTime)
      Defines latest end time for fulfillment.
      Parameters:
      latestEndTime - sets latest end time

    • setWeekdays

      public void setWeekdays(boolean mo, boolean tu, boolean we, boolean th, boolean fr, boolean sa, boolean su)
      Sets Weekdays.
      Parameters:
      mo - Monday
      tu - Tuesday
      we - Wednesday
      th - Thursday
      fr - Friday
      sa - Saturday
      su - Sunday

    • isExecuteOnFulfillment

      public boolean isExecuteOnFulfillment()
      Returns:
      true if an object should be executed on fulfillment

    • setExecuteOnFulfillment

      public void setExecuteOnFulfillment(boolean executeOnFulfillment)
      Parameters:
      executeOnFulfillment - true if an object should be executed on fulfillment, false otherwise.

    • isExecuteOnViolation

      public boolean isExecuteOnViolation()
      Returns:
      true if an object should be executed on violation

    • setExecuteOnViolation

      public void setExecuteOnViolation(boolean executeOnViolation)
      Parameters:
      executeOnViolation - true if an object should be executed on violation, false otherwise.

    • getOnFulfillmentObject

      public UC4ObjectName getOnFulfillmentObject()
      Returns the name of the object which is executed on fulfillment.
      Returns:
      Name of the object, can be empty but never null

    • setOnFulfillmentObject

      public void setOnFulfillmentObject(UC4ObjectName onFulfillmentObject)
      Sets the name of the object which is executed on fulfillment. The object name cannot contain variables.
      Parameters:
      onFulfillmentObject - Name, can be empty but not null.

    • getOnViolationObject

      public UC4ObjectName getOnViolationObject()
      Returns the name of the object which is executed on violation.
      Returns:
      Name of the object, can be empty but never null

    • setOnViolationObject

      public void setOnViolationObject(UC4ObjectName onViolationObject)
      Sets the name of the object which is executed on violation. The object name cannot contain variables.
      Parameters:
      onViolationObject - Name, can be empty but not null.

    • isEmailOnFulfillment

      public boolean isEmailOnFulfillment()
      Returns:
      true if a mail should be sent on fulfillment

    • setEmailOnFulfillment

      public void setEmailOnFulfillment(boolean emailOnFulfillment)
      Defines if a mail should be sent on fulfillment.
      Parameters:
      emailOnFulfillment - true if a mail should be sent on fulfillment

    • isEmailOnViolation

      public boolean isEmailOnViolation()
      Returns:
      true if a mail should be sent on violation

    • setEmailOnViolation

      public void setEmailOnViolation(boolean emailOnViolation)
      Defines if a mail should be sent on violation.
      Parameters:
      emailOnViolation - true if a mail should be sent on violation

    • getEmailRecipientFulfillment

      public String getEmailRecipientFulfillment()
      Returns the recipient of e-mails on fulfillment.
      Returns:
      mail address, can be an empty string if not set but never null

    • setEmailRecipientFulfillment

      public void setEmailRecipientFulfillment(String emailRecipientFulfillment)
      Sets the recipient of e-mails on fulfillment.
      Parameters:
      emailRecipientFulfillment - mail recipients separated by ";"

    • getEmailRecipientViolation

      public String getEmailRecipientViolation()
      Returns the recipient of e-mails on violation.
      Returns:
      mail address, can be an empty string if not set but never null

    • setEmailRecipientViolation

      public void setEmailRecipientViolation(String emailRecipientViolation)
      Sets the recipient of e-mails on violation.
      Parameters:
      emailRecipientViolation - mail recipients separated by ";"

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element objectElement)