psdi.app.calendar

Class CalendarBreak

  • java.lang.Object
  • All Implemented Interfaces:
    java.rmi.Remote, CalendarBreakRemote, MboConstants, MboRemote, MaxRemoteProxy


    public class CalendarBreak
    extends Mbo
    implements CalendarBreakRemote
    Mbo object to represent CalendarBreak.

    Attribute Description

    AttributeDescription
    BREAKTYPEThe time the break ends on a given pattern day.
    ENDTIMEThe time the break ends on a given pattern day.
    ORGIDThe Organization.
    PATTERNDAYSEQOrdinal number identifying a specific day within a repeating pattern of days.
    SHIFTNUMIdentifier of shift that this pattern day belongs to.
    STARTTIMEThe time the break begins on a given pattern day.
    WORKHOURSThe duration of the break.
    • Constructor Detail

      • CalendarBreak

        public CalendarBreak(MboSet ms)
                      throws MXException,
                             java.rmi.RemoteException
        Construct the CalendarBreak object
        Throws:
        MXException
        java.rmi.RemoteException
    • Method Detail

      • appValidate

        public void appValidate()
                         throws MXException,
                                java.rmi.RemoteException
        Verifies the shift break is within the pattern day start and end time range.
        Overrides:
        appValidate in class Mbo
        Throws:
        MXException
        java.rmi.RemoteException
      • add

        public void add()
                 throws MXException,
                        java.rmi.RemoteException
        Adds a Calendar Break for the specified Pattern Day
        Specified by:
        add in interface MboRemote
        Overrides:
        add in class Mbo
        Throws:
        MXException
        java.rmi.RemoteException
      • breakOutOfRange

        public boolean breakOutOfRange(java.util.Date dayStartTime,
                                       java.util.Date dayEndTime,
                                       java.util.Date calendarBreakStartTime,
                                       java.util.Date calendarBreakEndTime)
        Validates shift break is out of Calendar Pattern Day time range.
        Specified by:
        breakOutOfRange in interface CalendarBreakRemote
        Parameters:
        dayStartTime - Pattern day start time
        dayEndTime -
        calendarBreakStartTime -
        calendarBreakEndTime -
        Returns:
        true Shift break is out of range.
      • checkRequiredFields

        public void checkRequiredFields(Mbo mbo)
                                 throws MXException,
                                        java.rmi.RemoteException
        Checks all required values are populated.
        Parameters:
        mbo - Record that is being evaluated for required fields.
        Throws:
        MXException
        java.rmi.RemoteException