Index (api 1.9.0 API)

A B C D E F G H I L M O P S V W
All Classes and Interfaces|All Packages

A

AbstractPlugin<S> - Class in org.itsallcode.whiterabbit.api: Base class for plugins that support a defined PluginFeature.
AbstractPlugin(String, Class<S>) - Constructor for class org.itsallcode.whiterabbit.api.AbstractPlugin: Constructor.
ActivityData - Interface in org.itsallcode.whiterabbit.api.model: Model for a project activity on a given day including project id, duration and comment.

B

beginTask(String, int) - Method in interface org.itsallcode.whiterabbit.api.features.ProgressMonitor: Notifies that the main task is beginning.

C

close() - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin
close() - Method in interface org.itsallcode.whiterabbit.api.Plugin: Called before closing the plugin.
config - Variable in class org.itsallcode.whiterabbit.api.AbstractPlugin: The plugin configuration.
createActivityData() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage.ModelFactory: Create a new ActivityData instance.
createDayData() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage.ModelFactory: Create a new DayData instance.
createInstance() - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin: Plugins must implement this and return a new instance of the PluginFeature type.
createMonthData() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage.ModelFactory: Create a new MonthData instance.

D

DayData - Interface in org.itsallcode.whiterabbit.api.model: Model class representing a day with date, time for begin and end of work, activities etc.
DayType - Enum Class in org.itsallcode.whiterabbit.api.model: The type of a day.

E

export(ProjectReport, ProgressMonitor) - Method in interface org.itsallcode.whiterabbit.api.features.ProjectReportExporter: Start the export.

F

FLEX_TIME - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType: Flex time, reduce overtime (not working)

G

getActivities() - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Get the the ActivityDatas for this day.
getAvailableDataMonths() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage: Get all months for that data is available in the store.
getBegin() - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Get the begin working time of this day.
getCategory() - Method in interface org.itsallcode.whiterabbit.api.features.Holidays.HolidayInstance: Get the holiday category, e.g.
getComment() - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData: Get the activity's comment.
getComment() - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Get the comment of this day.
getComment() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportDay: Get the comment of this day.
getComments() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportActivity: Get the comments for this activity.
getCostCarrier() - Method in interface org.itsallcode.whiterabbit.api.model.Project: Get the cost carrier of this project.
getDataDir() - Method in interface org.itsallcode.whiterabbit.api.PluginConfiguration: Get the Path to the data directory.
getDate() - Method in interface org.itsallcode.whiterabbit.api.features.Holidays.HolidayInstance: Get the date of the holiday.
getDate() - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Get the date of this day.
getDate() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportDay: Get the date of this day.
getDays() - Method in interface org.itsallcode.whiterabbit.api.model.MonthData: Get the DayDatas in this month.
getDays() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReport: Get the days in this project report.
getDuration() - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData: Get the duration of the activity.
getEnd() - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Get the end working time of this day.
getFeature(Class<T>) - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin
getFeature(Class<T>) - Method in interface org.itsallcode.whiterabbit.api.Plugin: Get an instance of the given feature type.
getHolidays(LocalDate) - Method in interface org.itsallcode.whiterabbit.api.features.Holidays: Get all holidays for a given date.
getId() - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin
getId() - Method in interface org.itsallcode.whiterabbit.api.Plugin: The ID of this plugin.
getInterruption() - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Get the duration of the interruption of this day.
getLabel() - Method in interface org.itsallcode.whiterabbit.api.model.Project: Get the label of this project.
getMandatoryValue(String) - Method in interface org.itsallcode.whiterabbit.api.PluginConfiguration: Get property pluginId.propertyName from the config file.
getModelFactory() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage: Get the model factory that can be used to create instances of the model.
getMonth() - Method in interface org.itsallcode.whiterabbit.api.model.MonthData: Get the Month.
getMonth() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReport: Get the year and month of this project report.
getName() - Method in interface org.itsallcode.whiterabbit.api.features.Holidays.HolidayInstance: Get the local name of the holiday.
getOptionalValue(String) - Method in interface org.itsallcode.whiterabbit.api.PluginConfiguration: Get property pluginId.propertyName from the config file.
getOvertimePreviousMonth() - Method in interface org.itsallcode.whiterabbit.api.model.MonthData: Get the duration of the previous month's overtime.
getProject() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportActivity: Get the Project of this activity.
getProjectId() - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData: Get the project's ID.
getProjectId() - Method in interface org.itsallcode.whiterabbit.api.model.Project: Get the ID of this project.
getProjects() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReport: Get the activities in this project report.
getProjects() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportDay: Get the project activities of this day.
getType() - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Get the DayType of this day.
getType() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportDay: Get the DayType of this day.
getWorkingHours() - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Get the working hours of this day.
getWorkingTime() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportActivity: Get the working time used for for activity.
getYear() - Method in interface org.itsallcode.whiterabbit.api.model.MonthData: Get the year of this month.

H

HOLIDAY - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType: Public holiday (not working)
Holidays - Interface in org.itsallcode.whiterabbit.api.features: PluginFeature that generates a List of Holidays.HolidayInstance for each day.
Holidays.HolidayInstance - Interface in org.itsallcode.whiterabbit.api.features: Represents a holiday instance.

I

init(PluginConfiguration) - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin
init(PluginConfiguration) - Method in interface org.itsallcode.whiterabbit.api.Plugin: Called once when loading the plugin.
isCanceled() - Method in interface org.itsallcode.whiterabbit.api.features.ProgressMonitor: Call this method repeatedly to check, if the user wants to cancel the process.
isRemainder() - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData: Check if this is the remainder activity.
isWorkDay() - Method in enum class org.itsallcode.whiterabbit.api.model.DayType: Check if this is a working day.

L

load(YearMonth) - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage: Get the data for the given month.
loadAll() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage: Get all available data.

M

MonthData - Interface in org.itsallcode.whiterabbit.api.model: Model class for data of a single month containing year, month, day data etc.
MonthDataStorage - Interface in org.itsallcode.whiterabbit.api.features: PluginFeature that provides a storage backend for month data.
MonthDataStorage.ModelFactory - Interface in org.itsallcode.whiterabbit.api.features: A MonthDataStorage.ModelFactory allows creating new instances of the data model.

O

org.itsallcode.whiterabbit.api - package org.itsallcode.whiterabbit.api
org.itsallcode.whiterabbit.api.features - package org.itsallcode.whiterabbit.api.features
org.itsallcode.whiterabbit.api.model - package org.itsallcode.whiterabbit.api.model

P

Plugin - Interface in org.itsallcode.whiterabbit.api: Implement this interface to create a plugin for WhiteRabbit.
PluginConfiguration - Interface in org.itsallcode.whiterabbit.api: The configuration of a Plugin that allows retrieving configuration values from the WhiteRabbit properties file ~/.whiterabbit.properties.
PluginFeature - Interface in org.itsallcode.whiterabbit.api.features: Super interface for all features supported by a Plugin.
ProgressMonitor - Interface in org.itsallcode.whiterabbit.api.features: A progress monitor passed to a PluginFeature that allows reporting the progress of process.
Project - Interface in org.itsallcode.whiterabbit.api.model: The project you work on during an activity containing an ID, label and cost carrier id.
ProjectReport - Interface in org.itsallcode.whiterabbit.api.model: A monthly project report.
ProjectReportActivity - Interface in org.itsallcode.whiterabbit.api.model: An activity during a day where you worked for a specific time duration on a Project.
ProjectReportDay - Interface in org.itsallcode.whiterabbit.api.model: The projects worked on during a single day of the ProjectReport including date and activities.
ProjectReportExporter - Interface in org.itsallcode.whiterabbit.api.features: A PluginFeature that allows exporting a monthly ProjectReport to another system.

S

setActivities(List<ActivityData>) - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Set the ActivityDatas for this day.
setBegin(LocalTime) - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Set the begin time for this day.
setComment(String) - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData: Set the activity's comment.
setComment(String) - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Set the comment for this day.
setDate(LocalDate) - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Set the date for this day.
setDays(List<DayData>) - Method in interface org.itsallcode.whiterabbit.api.model.MonthData: Set the DayDatas in this month.
setDuration(Duration) - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData: Set the duration of the activity.
setEnd(LocalTime) - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Set the end time for this day.
setInterruption(Duration) - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Set the duration of the interruption for this day.
setMonth(Month) - Method in interface org.itsallcode.whiterabbit.api.model.MonthData: Set a new Month.
setOvertimePreviousMonth(Duration) - Method in interface org.itsallcode.whiterabbit.api.model.MonthData: Set the duration of the previous month's overtime.
setProjectId(String) - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData: Set the project's ID.
setTaskName(String) - Method in interface org.itsallcode.whiterabbit.api.features.ProgressMonitor: Set the name of the current task shown to the user.
setType(DayType) - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Set the DayType for this day.
setWorkingHours(Duration) - Method in interface org.itsallcode.whiterabbit.api.model.DayData: Set the working hours for this day.
setYear(int) - Method in interface org.itsallcode.whiterabbit.api.model.MonthData: Set the year of this month.
SICK - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType: Sick, paid sick leave (not working)
store(YearMonth, MonthData) - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage: Store the data for a given month.
supports(Class<? extends PluginFeature>) - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin
supports(Class<? extends PluginFeature>) - Method in interface org.itsallcode.whiterabbit.api.Plugin: Check if this plugin supports the given feature.

V

VACATION - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType: Vacation, paid time off (not working)
valueOf(String) - Static method in enum class org.itsallcode.whiterabbit.api.model.DayType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.itsallcode.whiterabbit.api.model.DayType: Returns an array containing the constants of this enum class, in the order they are declared.

W

WEEKEND - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType: Weekend (Saturday, Sunday, not working)
WORK - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType: Normal working day
worked(int) - Method in interface org.itsallcode.whiterabbit.api.features.ProgressMonitor: Notifies that a given number of work unit of the main task has been completed.

A B C D E F G H I L M O P S V W
All Classes and Interfaces|All Packages