org.homeunix.thecave.buddi.model
Interface Source

All Superinterfaces:
java.lang.Comparable<ModelObject>, ModelObject
All Known Subinterfaces:
Account, BudgetCategory
All Known Implementing Classes:
AccountImpl, BudgetCategoryImpl, SourceImpl

public interface Source
extends ModelObject


Method Summary
 java.lang.String getFullName()
          Returns the full name of this source.
 java.lang.String getName()
          Returns the name of the source
 java.lang.String getNotes()
          Return the notes associated with this source.
 boolean isDeleted()
          Is this source marked as deleted? When the user tries to delete a source, we try first to remove it from the model; if that cannot work (due to transactions referencing it), we mark it as deleted.
 void setDeleted(boolean deleted)
          Sets the deleted status of this source.
 void setName(java.lang.String name)
          Sets the name of this source.
 void setNotes(java.lang.String notes)
          Sets the free form notes associated with this account.
 
Methods inherited from interface org.homeunix.thecave.buddi.model.ModelObject
compareTo, getDocument, getModified, getUid, setChanged, setDocument
 

Method Detail

getFullName

java.lang.String getFullName()
Returns the full name of this source. The details of this will differ for Accounts and Budget Categories.

Returns:

getName

java.lang.String getName()
Returns the name of the source

Returns:

getNotes

java.lang.String getNotes()
Return the notes associated with this source.

Returns:

isDeleted

boolean isDeleted()
Is this source marked as deleted? When the user tries to delete a source, we try first to remove it from the model; if that cannot work (due to transactions referencing it), we mark it as deleted. Depending on the preferences, we may or may not display sources which are marked as deleted.

Returns:

setDeleted

void setDeleted(boolean deleted)
                throws InvalidValueException
Sets the deleted status of this source.

Parameters:
deleted -
Throws:
InvalidValueException

setName

void setName(java.lang.String name)
             throws InvalidValueException
Sets the name of this source.

Parameters:
name -
Throws:
InvalidValueException

setNotes

void setNotes(java.lang.String notes)
              throws InvalidValueException
Sets the free form notes associated with this account.

Parameters:
notes -
Throws:
InvalidValueException