org.homeunix.thecave.buddi.plugin.api.model
Interface ImmutableBudgetCategoryType

All Known Implementing Classes:

ImmutableBudgetCategoryTypeImpl

public interface ImmutableBudgetCategoryType

Method Summary

BudgetCategoryType	getBudgetCategoryType() Returns the raw (wrapped) model object.
java.util.Date	getBudgetPeriodOffset(java.util.Date date, int offset) Method to move forwards or backwards by the given number of periods.
java.lang.String	getDateFormat() Returns the date format associated with this budget period type.
long	getDaysInPeriod(java.util.Date date) Returns the number of days in the period specified by date.
java.util.Date	getEndOfBudgetPeriod(java.util.Date date) Returns the end of the budget period which contains the given date.
java.lang.String	getName() Returns the name of this budget period.
java.util.Date	getStartOfBudgetPeriod(java.util.Date date) Returns the start of the budget period which contains the given date.

Method Detail

getBudgetCategoryType

BudgetCategoryType getBudgetCategoryType()

Returns the raw (wrapped) model object. When you use this object, you lose the safety of using the API. It is not recommended to use this method unless you know what you are doing.

Returns:

getBudgetPeriodOffset

java.util.Date getBudgetPeriodOffset(java.util.Date date,
                                     int offset)

Method to move forwards or backwards by the given number of periods. This must conform to the following statements: If offset is 0, return the same date If offset is positive, add that many budget periods. For instance, if the value 3 is given, MONTHLY period is selected, and the current date is August 1, the return date will be November 1 (August + 3). If offset is negative, subtract that many budget periods. The inverse of this must be the same as positive; for instance, if you are given a date and you add '-3' to it, and then add '3' again, you must arrive at the same date as you started with.

Parameters:

date -

offset -

Returns:

getDateFormat

java.lang.String getDateFormat()

Returns the date format associated with this budget period type. This is used in the My Budgets window to format the date spinner and the column names. For information on how to display the format, please see the SimpleDateFormatter javadocs. For instance, for Monthly type, the value would be "MMM yyyy" (to show Aug 2007). For the Weekly type, since we want to show days as well, the format would be "dd MMM yyyy".

Returns:

getDaysInPeriod

long getDaysInPeriod(java.util.Date date)

Returns the number of days in the period specified by date. The given date can be any date within the budget period. For instance, if this class defines a Monthly type, passing in a date of August 4 2007 would return the value 31; passing in the date of September 20 2009 would return the value 30.

Parameters:

date -

Returns:

getEndOfBudgetPeriod

java.util.Date getEndOfBudgetPeriod(java.util.Date date)

Returns the end of the budget period which contains the given date.

Parameters:

date -

Returns:

getName

java.lang.String getName()

Returns the name of this budget period. It will be filtered through the translator before displaying it, do this can be a translation key if desired.

Returns:

getStartOfBudgetPeriod

java.util.Date getStartOfBudgetPeriod(java.util.Date date)

Returns the start of the budget period which contains the given date.

Parameters:

date -

Returns: