Coverage Report - org.homeunix.thecave.buddi.plugin.api.model.ImmutableSource
 
Classes in this File Line Coverage Branch Coverage Complexity
ImmutableSource
N/A
N/A
1
 
 1  
 /*
 2  
  * Created on Aug 12, 2007 by wyatt
 3  
  */
 4  
 package org.homeunix.thecave.buddi.plugin.api.model;
 5  
 
 6  
 import org.homeunix.thecave.buddi.model.Source;
 7  
 
 8  
 public interface ImmutableSource extends ImmutableModelObject {
 9  
         
 10  
         /**
 11  
          * Returns the full name of this source.  This differs for Account and Budget
 12  
          * Categories: for Accounts, it returns getName() and getType().getName();
 13  
          * for Budget Categories, it just returns getName().
 14  
          * @return
 15  
          */
 16  
         public String getFullName();
 17  
         
 18  
         /**
 19  
          * Returns the name of this source 
 20  
          * @return
 21  
          */
 22  
         public String getName();
 23  
         
 24  
         /**
 25  
          * Return any notes associated with this source
 26  
          * @return
 27  
          */
 28  
         public String getNotes();
 29  
         
 30  
         /**
 31  
          * Returns the wrapped object from the underlying data model.  By 
 32  
          * accessing this method, you bypass all protection which the Buddi API
 33  
          * gives you; it is not recommended to use this method unless you understand
 34  
          * the risks associated with it. 
 35  
          * @return
 36  
          */
 37  
         public Source getSource();
 38  
         
 39  
         /**
 40  
          * Is this source deleted?
 41  
          * @return
 42  
          */
 43  
         public boolean isDeleted();
 44  
 }