Class Agenda

  • All Implemented Interfaces:
    java.io.Serializable

    public class Agenda
    extends java.lang.Object
    implements java.io.Serializable
    Agenda instance
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DISP_MONTH
      Month display mode
      static java.lang.String DISP_WEEK
      Week display mode
    • Constructor Summary

      Constructors 
      Constructor Description
      Agenda​(ObjectDB obj, java.lang.String id, java.lang.String name, boolean[] openDays, boolean flying, java.lang.String dateField, java.util.List<java.lang.String> labelFields, java.lang.String durationField, java.lang.String userField, java.lang.String groupField)
      Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCurrentDate()
      Get current date
      java.lang.String getCurrentGroup()
      Get current group
      java.lang.String getCurrentUser()
      Get current user
      java.util.List<java.lang.String[]> getData​(ObjectDB object, java.lang.String start, java.lang.String end, java.lang.String login, java.lang.String group, boolean resetFilter)
      Find data for a period
      java.lang.String getDateFieldName()
      Get date time field name
      java.util.List<java.lang.String> getDays​(java.lang.String d)
      Disposition days
      java.lang.String getDisposition()
      Gest disposition
      java.lang.String getDurationFieldName()
      Get duration field name
      java.lang.String getEndHour()
      Get end hour
      java.lang.String getGroupFieldName()
      Get group field name
      java.lang.String[] getGroups​(ObjectDB object)
      Groups linked to the object
      java.lang.String getId()
      Get ID
      java.util.List<java.lang.String> getLabelFieldNames()
      Get label field names
      java.lang.String[] getLogins​(ObjectDB object)
      Logins linked to the object
      java.util.List<java.lang.String> getMonth​(java.lang.String d)
      Search a month
      java.lang.String getName()
      Get name
      int getOpenDayCount()
      Get openned dates count
      int getQuantum()
      Get the hour quantum
      java.lang.String getStartHour()
      Get start hour
      java.lang.String getUserFieldName()
      Get user field name
      java.util.List<java.lang.String> getWeek​(java.lang.String d)
      Search a week
      boolean isEnabled()
      Is enabled?
      boolean isFixed()
      First day is always the same?
      boolean isFloating()
      Is floating agenda? true=first column is the requested date or today, false=from Monday to Sunday including the requested date or today
      boolean isMonthly()
      Is monthly
      boolean isNavigable()
      Is navigable?
      boolean isOpenDay​(java.lang.String date)
      Is specified date open?
      boolean isOpenDay​(java.util.Date date)
      Is specified date open?
      boolean isWeekly()
      Is weekly?
      void setCurrentDate​(java.lang.String dt)
      Set current date
      void setCurrentGroup​(java.lang.String group)
      Set current group
      void setCurrentUser​(java.lang.String user)
      Set current user
      void setDisposition​(java.lang.String d)
      Set disposition
      void setEnabled​(boolean enabled)
      Set enabled
      void setEndHour​(java.lang.String end)
      Set end hour
      void setFloating​(boolean f)
      Set floating agenda: true=first column is the requested date or today, false=from Monday to Sunday including the requested date or today
      void setLabelFieldNames​(java.util.List<java.lang.String> list)
      Set label field names
      void setNavigable​(boolean b)
      Set navigable
      void setOpenDays​(boolean[] openDays)
      Set open days
      void setQuantum​(int q)
      Set the hour quantum to display (default is 30 minutes)
      void setStartHour​(java.lang.String start)
      Set start hour
      java.lang.String toJSON​(ObjectDB obj)
      Serialize a JSON object
      java.lang.String toString()
      Generates basic string dump for agenda (usefull for debug purposes)
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • DISP_WEEK

        public static final java.lang.String DISP_WEEK
        Week display mode
        See Also:
        Constant Field Values
      • DISP_MONTH

        public static final java.lang.String DISP_MONTH
        Month display mode
        See Also:
        Constant Field Values
    • Constructor Detail

      • Agenda

        public Agenda​(ObjectDB obj,
                      java.lang.String id,
                      java.lang.String name,
                      boolean[] openDays,
                      boolean flying,
                      java.lang.String dateField,
                      java.util.List<java.lang.String> labelFields,
                      java.lang.String durationField,
                      java.lang.String userField,
                      java.lang.String groupField)
        Constructor
        Parameters:
        obj - Agenda Object
        id - Agenda id
        name - Agenda name
        openDays - Week open days from monday to sunday
        flying - Flying agenda: true=first column is the requested date or today, false=from monday to sunday including the requested date or today
        dateField - Field date
        labelFields - Field labels
        durationField - Field duration
        userField - Field user
        groupField - Field group
    • Method Detail

      • getId

        public java.lang.String getId()
        Get ID
        Returns:
        ID
      • getName

        public java.lang.String getName()
        Get name
        Returns:
        Name
      • getDateFieldName

        public java.lang.String getDateFieldName()
        Get date time field name
        Returns:
        Date time field name
      • getDurationFieldName

        public java.lang.String getDurationFieldName()
        Get duration field name
        Returns:
        Duration field name
      • getLabelFieldNames

        public java.util.List<java.lang.String> getLabelFieldNames()
        Get label field names
        Returns:
        Lable field names
      • setLabelFieldNames

        public void setLabelFieldNames​(java.util.List<java.lang.String> list)
        Set label field names
        Parameters:
        list - List of label fiel names
      • isEnabled

        public boolean isEnabled()
        Is enabled?
        Returns:
        True if enabled
      • setEnabled

        public void setEnabled​(boolean enabled)
        Set enabled
        Parameters:
        enabled - Enabledd?
      • getUserFieldName

        public java.lang.String getUserFieldName()
        Get user field name
        Returns:
        User field name
      • getGroupFieldName

        public java.lang.String getGroupFieldName()
        Get group field name
        Returns:
        Group field name
      • getCurrentDate

        public java.lang.String getCurrentDate()
        Get current date
        Returns:
        Current date
      • setCurrentDate

        public void setCurrentDate​(java.lang.String dt)
        Set current date
        Parameters:
        dt - Current date
      • getCurrentGroup

        public java.lang.String getCurrentGroup()
        Get current group
        Returns:
        Current group
      • setCurrentGroup

        public void setCurrentGroup​(java.lang.String group)
        Set current group
        Parameters:
        group - Current group
      • getCurrentUser

        public java.lang.String getCurrentUser()
        Get current user
        Returns:
        Current user
      • setCurrentUser

        public void setCurrentUser​(java.lang.String user)
        Set current user
        Parameters:
        user - Current user
      • getDisposition

        public java.lang.String getDisposition()
        Gest disposition
        Returns:
        Disposition
      • setDisposition

        public void setDisposition​(java.lang.String d)
        Set disposition
        Parameters:
        d - Disposition
      • isWeekly

        public boolean isWeekly()
        Is weekly?
        Returns:
        True if weekly
      • isMonthly

        public boolean isMonthly()
        Is monthly
        Returns:
        True if monthly
      • isNavigable

        public boolean isNavigable()
        Is navigable?
        Returns:
        True if navigable
      • setNavigable

        public void setNavigable​(boolean b)
        Set navigable
        Parameters:
        b - Navigable?
      • isOpenDay

        public boolean isOpenDay​(java.lang.String date)
                          throws java.lang.Exception
        Is specified date open?
        Parameters:
        date - Date
        Returns:
        True if date is opened
        Throws:
        java.lang.Exception
      • isOpenDay

        public boolean isOpenDay​(java.util.Date date)
        Is specified date open?
        Parameters:
        date - Date
        Returns:
        True if date is opened
      • getOpenDayCount

        public int getOpenDayCount()
        Get openned dates count
        Returns:
        Opened dates count
      • setOpenDays

        public void setOpenDays​(boolean[] openDays)
        Set open days
        Parameters:
        openDays - Open days
      • isFloating

        public boolean isFloating()
        Is floating agenda? true=first column is the requested date or today, false=from Monday to Sunday including the requested date or today
        Returns:
        is floating agenda ?
      • isFixed

        public boolean isFixed()
        First day is always the same?
        Returns:
        True if firt day is always the same
      • setFloating

        public void setFloating​(boolean f)
        Set floating agenda: true=first column is the requested date or today, false=from Monday to Sunday including the requested date or today
        Parameters:
        f - floating agenda ?
      • setStartHour

        public void setStartHour​(java.lang.String start)
        Set start hour
        Parameters:
        start - Start hour
      • getStartHour

        public java.lang.String getStartHour()
        Get start hour
        Returns:
        Start hour
      • setEndHour

        public void setEndHour​(java.lang.String end)
        Set end hour
        Parameters:
        end - End hour
      • getEndHour

        public java.lang.String getEndHour()
        Get end hour
        Returns:
        End hour
      • setQuantum

        public void setQuantum​(int q)
        Set the hour quantum to display (default is 30 minutes)
        Parameters:
        q - subdivision of hour or day / list AGENDA_QUANTUM in minutes (5, 10, 15, 20, 30, 60, 90, 120, ... 720)
      • getQuantum

        public int getQuantum()
        Get the hour quantum
        Returns:
        The hour quantum in minutes
      • getDays

        public java.util.List<java.lang.String> getDays​(java.lang.String d)
        Disposition days
        Parameters:
        d - a day yyyy-MM-dd (today if null)
        Returns:
        Dates list yyyy-MM-dd (week or month)
      • getWeek

        public java.util.List<java.lang.String> getWeek​(java.lang.String d)
        Search a week
        Parameters:
        d - a day yyyy-MM-dd (today if null)
        Returns:
        Dates list (7 days flying or not) yyyy-MM-dd
      • getMonth

        public java.util.List<java.lang.String> getMonth​(java.lang.String d)
        Search a month
        Parameters:
        d - a day yyyy-MM-dd (today if null)
        Returns:
        Dates list including the day yyyy-MM-dd
      • getLogins

        public java.lang.String[] getLogins​(ObjectDB object)
        Logins linked to the object
        Parameters:
        object - Object
        Returns:
        Login list
      • getGroups

        public java.lang.String[] getGroups​(ObjectDB object)
        Groups linked to the object
        Parameters:
        object - Object
        Returns:
        Group list
      • getData

        public java.util.List<java.lang.String[]> getData​(ObjectDB object,
                                                          java.lang.String start,
                                                          java.lang.String end,
                                                          java.lang.String login,
                                                          java.lang.String group,
                                                          boolean resetFilter)
        Find data for a period
        Parameters:
        object - Business object
        start - yyyy-MM-dd
        end - yyyy-MM-dd
        login - Optional user
        group - Optional group
        resetFilter - reset Filter ?
        Returns:
        Object records
      • toString

        public java.lang.String toString()
        Generates basic string dump for agenda (usefull for debug purposes)
        Overrides:
        toString in class java.lang.Object
        Returns:
        agenda as string
      • toJSON

        public java.lang.String toJSON​(ObjectDB obj)
        Serialize a JSON object
        Parameters:
        obj - Related business objet
        Returns:
        JSON