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

All Superinterfaces:

java.lang.Comparable<ImmutableModelObject>, ImmutableBudgetCategory, ImmutableModelObject, ImmutableSource, MutableSource

All Known Implementing Classes:

MutableBudgetCategoryImpl

public interface MutableBudgetCategory
extends ImmutableBudgetCategory, MutableSource

Method Summary

java.util.List<MutableBudgetCategory>	getAllMutableChildren() Returns all children of this budget category, regardless of delete flag state.
java.util.List<MutableBudgetCategory>	getMutableChildren() Returns all visible children of this budget category.
MutableBudgetCategory	getParent() Returns the parent of this ImmutableBudgetCategory, or null if there is no parent.
void	setAmount(java.util.Date date, long amount) Sets the amount for the budget period which contains the given date.
void	setBudgetCategoryType(ImmutableBudgetCategoryType budgetCategoryType) Sets the budget period type associated with this budget category.
void	setIncome(boolean income) Sets whether this budget category represents income or not.
void	setParent(MutableBudgetCategory parent) Sets the parent of this budget category.

Methods inherited from interface org.homeunix.thecave.buddi.plugin.api.model.ImmutableBudgetCategory

getAllImmutableChildren, getAmount, getAmount, getBudgetCategory, getBudgetedDates, getBudgetPeriodType, getImmutableChildren, isIncome

Methods inherited from interface org.homeunix.thecave.buddi.plugin.api.model.ImmutableSource

getFullName, getName, getNotes, getSource, isDeleted

Methods inherited from interface org.homeunix.thecave.buddi.plugin.api.model.ImmutableModelObject

getModified, getRaw, getUid

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.homeunix.thecave.buddi.plugin.api.model.MutableSource

setDeleted, setName, setNotes

Methods inherited from interface org.homeunix.thecave.buddi.plugin.api.model.ImmutableSource

getFullName, getName, getNotes, getSource, isDeleted

Methods inherited from interface org.homeunix.thecave.buddi.plugin.api.model.ImmutableModelObject

getModified, getRaw, getUid

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

setAmount

void setAmount(java.util.Date date,
               long amount)
               throws InvalidValueException

Sets the amount for the budget period which contains the given date. This is defined by the currently selected BudgetCategoryType object associated with this category.

Parameters:

date -

amount -

Throws:

InvalidValueException

setBudgetCategoryType

void setBudgetCategoryType(ImmutableBudgetCategoryType budgetCategoryType)
                           throws InvalidValueException

Sets the budget period type associated with this budget category.

Throws:

InvalidValueException

setIncome

void setIncome(boolean income)
               throws InvalidValueException

Sets whether this budget category represents income or not.

Parameters:

income -

Throws:

InvalidValueException

setParent

void setParent(MutableBudgetCategory parent)
               throws InvalidValueException

Sets the parent of this budget category. Set to null for no parent.

Parameters:

parent -

Throws:

InvalidValueException

getParent

MutableBudgetCategory getParent()

Returns the parent of this ImmutableBudgetCategory, or null if there is no parent.

Specified by:

getParent in interface ImmutableBudgetCategory

Returns:

getMutableChildren

java.util.List<MutableBudgetCategory> getMutableChildren()

Returns all visible children of this budget category. 'Visible Children' are defined to be all children which do not have the deleted flag set, plus all children which have the deleted flag set IIF the Preferences define that the user wants to see deleted sources. This method is mostly used for GUI functions, such as reports and graphs; if you want to access the model it is usually a better idea to use the getAllChildren() method, which will return all children regardless of delete flag state.

Returns:

getAllMutableChildren

java.util.List<MutableBudgetCategory> getAllMutableChildren()

Returns all children of this budget category, regardless of delete flag state.

Returns: