Package com.simplicite.util
Class Agenda
- java.lang.Object
-
- com.simplicite.util.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 modestatic 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 floating, java.lang.String dateField, java.lang.String endDateField, 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 datejava.lang.String
getCurrentGroup()
Get current groupjava.lang.String
getCurrentUser()
Get current userjava.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)
Search data for a periodjava.lang.String
getDateFieldName()
Get date time field namejava.util.List<java.lang.String>
getDays(java.lang.String d)
Disposition daysjava.lang.String
getDisposition()
Gest dispositionjava.lang.String
getDurationFieldName()
Get duration field namejava.lang.String
getEndDateFieldName()
Get end date field namejava.lang.String
getEndHour()
Get end hour HH:MMjava.lang.String
getGroupFieldName()
Get group field namejava.lang.String[]
getGroups(ObjectDB object)
Groups linked to the objectjava.lang.String
getId()
Get IDjava.util.List<java.lang.String>
getLabelFieldNames()
Get label field namesjava.lang.String[]
getLogins(ObjectDB object)
Logins linked to the objectjava.lang.String
getMaxTime()
Get max time HH:MM:SSjava.lang.String
getMinTime()
Get min time HH:MM:SS (default 00:00:00)java.util.List<java.lang.String>
getMonth(java.lang.String d)
Search a monthjava.lang.String
getName()
Get nameint
getOpenDayCount()
Get openned dates countint
getQuantum()
Get the hour quantumjava.lang.String
getStartHour()
Get start hour HH:MMjava.lang.String
getUserFieldName()
Get user field namejava.util.List<java.lang.String>
getWeek(java.lang.String d)
Search a weekboolean
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 todayboolean
isMonthly()
Is monthlyboolean
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 datevoid
setCurrentGroup(java.lang.String group)
Set current groupvoid
setCurrentUser(java.lang.String user)
Set current uservoid
setDisposition(java.lang.String d)
Set dispositionvoid
setEnabled(boolean enabled)
Set enabledvoid
setEndHour(java.lang.String end)
Set end hour HH:MMvoid
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 todayvoid
setLabelFieldNames(java.util.List<java.lang.String> list)
Set label field namesvoid
setMaxTime(java.lang.String max)
Set max time HH:MM:SS (default 24:00:00)void
setMinTime(java.lang.String min)
Set min time HH:MM:SSvoid
setNavigable(boolean b)
Set navigablevoid
setOpenDays(boolean[] openDays)
Set open daysvoid
setQuantum(int q)
Set the hour quantum to display (default is 30 minutes)void
setStartHour(java.lang.String start)
Set start hour HH:MMvoid
setWorkingDays(int[] workingDays)
Set working days default {1,2,3,4,5}java.lang.String
toJSON(ObjectDB obj)
Serialize a JSON objectjava.lang.String
toString()
Generates basic string dump for agenda (useful for debug purposes)
-
-
-
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 floating, java.lang.String dateField, java.lang.String endDateField, java.util.List<java.lang.String> labelFields, java.lang.String durationField, java.lang.String userField, java.lang.String groupField)
Constructor- Parameters:
obj
- Agenda Objectid
- Agenda idname
- Agenda nameopenDays
- Week open days from monday to sundayfloating
- Floating date: true=first column is the requested date or today, false=from monday to sunday including the requested date or todaydateField
- Field dateendDateField
- Field end date optionallabelFields
- Field labelsdurationField
- Field duration optionaluserField
- Field user optionalgroupField
- Field group optional
-
-
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
-
getEndDateFieldName
public java.lang.String getEndDateFieldName()
Get end date field name- Returns:
- End date 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
-
setWorkingDays
public void setWorkingDays(int[] workingDays)
Set working days default {1,2,3,4,5}- Parameters:
workingDays
- Working 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 HH:MM- Parameters:
start
- Start hour
-
getStartHour
public java.lang.String getStartHour()
Get start hour HH:MM- Returns:
- Start hour
-
setEndHour
public void setEndHour(java.lang.String end)
Set end hour HH:MM- Parameters:
end
- End hour
-
getEndHour
public java.lang.String getEndHour()
Get end hour HH:MM- Returns:
- End hour
-
setMinTime
public void setMinTime(java.lang.String min)
Set min time HH:MM:SS- Parameters:
min
- Min time
-
getMinTime
public java.lang.String getMinTime()
Get min time HH:MM:SS (default 00:00:00)- Returns:
- Min time
-
setMaxTime
public void setMaxTime(java.lang.String max)
Set max time HH:MM:SS (default 24:00:00)- Parameters:
max
- Max time
-
getMaxTime
public java.lang.String getMaxTime()
Get max time HH:MM:SS- Returns:
- Max time
-
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)
Search data for a period- Parameters:
object
- Business objectstart
- yyyy-MM-ddend
- yyyy-MM-ddlogin
- Optional usergroup
- Optional groupresetFilter
- reset Filter ?- Returns:
- Object records
-
toString
public java.lang.String toString()
Generates basic string dump for agenda (useful for debug purposes)- Overrides:
toString
in classjava.lang.Object
- Returns:
- agenda as string
-
toJSON
public java.lang.String toJSON(ObjectDB obj)
Serialize a JSON object- Parameters:
obj
- Related business objest- Returns:
- JSON
-
-