| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Source |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Created on Jul 30, 2007 by wyatt | |
| 3 | */ | |
| 4 | package org.homeunix.thecave.buddi.model; | |
| 5 | ||
| 6 | import org.homeunix.thecave.buddi.plugin.api.exception.InvalidValueException; | |
| 7 | ||
| 8 | public interface Source extends ModelObject { | |
| 9 | ||
| 10 | /** | |
| 11 | * Returns the full name of this source. The details of this will differ | |
| 12 | * for Accounts and Budget Categories. | |
| 13 | * @return | |
| 14 | */ | |
| 15 | public String getFullName(); | |
| 16 | ||
| 17 | /** | |
| 18 | * Returns the name of the source | |
| 19 | * @return | |
| 20 | */ | |
| 21 | public String getName(); | |
| 22 | ||
| 23 | /** | |
| 24 | * Return the notes associated with this source. | |
| 25 | * @return | |
| 26 | */ | |
| 27 | public String getNotes(); | |
| 28 | ||
| 29 | /** | |
| 30 | * Is this source marked as deleted? When the user tries to delete a source, | |
| 31 | * we try first to remove it from the model; if that cannot work (due to | |
| 32 | * transactions referencing it), we mark it as deleted. Depending on the | |
| 33 | * preferences, we may or may not display sources which are marked as deleted. | |
| 34 | * @return | |
| 35 | */ | |
| 36 | public boolean isDeleted(); | |
| 37 | ||
| 38 | /** | |
| 39 | * Sets the deleted status of this source. | |
| 40 | * @param deleted | |
| 41 | * @throws InvalidValueException | |
| 42 | */ | |
| 43 | public void setDeleted(boolean deleted) throws InvalidValueException; | |
| 44 | ||
| 45 | /** | |
| 46 | * Sets the name of this source. | |
| 47 | * @param name | |
| 48 | * @throws InvalidValueException | |
| 49 | */ | |
| 50 | public void setName(String name) throws InvalidValueException; | |
| 51 | ||
| 52 | /** | |
| 53 | * Sets the free form notes associated with this account. | |
| 54 | * @param notes | |
| 55 | * @throws InvalidValueException | |
| 56 | */ | |
| 57 | public void setNotes(String notes) throws InvalidValueException; | |
| 58 | } |