Interface MoneybotInterface


  • public interface MoneybotInterface
    This class provides an interface to some core and high-level Moneydance functions that are (or will be) accessible across different versions and implementations of Moneydance
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<Account> accountsWithType​(java.lang.String accountTypeStr)
      Gets a list of all accounts with the given account type ID.
      void closeWebBot()  
      Account getAccountForID​(java.lang.String accountID)
      Gets the account having the given ID string, if it exists
      java.lang.String getField​(java.lang.Object object, java.lang.String fieldID, java.lang.String fieldLabel, java.lang.String fieldDescription, java.lang.String defaultValue, boolean isPassword)
      Get a string value that is associated with the given object (account, transaction, etc) and optionally prompt the user for the value.
      RobotWebSession getWebBot()  
      void setField​(java.lang.Object object, java.lang.String fieldID, java.lang.String fieldValue, boolean isPassword)
      Stores a field associated with the given object (account, transaction, etc).
    • Method Detail

      • closeWebBot

        void closeWebBot()
      • getField

        java.lang.String getField​(java.lang.Object object,
                                  java.lang.String fieldID,
                                  java.lang.String fieldLabel,
                                  java.lang.String fieldDescription,
                                  java.lang.String defaultValue,
                                  boolean isPassword)
        Get a string value that is associated with the given object (account, transaction, etc) and optionally prompt the user for the value.
        Parameters:
        object - the object with which the field is associated. If null, the field is assumed to be global to the entire data set
        fieldID - the unique ID of the field, used for storing and retrieving the field value. If null, the field is not retrieved and we simply prompt the user
        defaultValue - the default value to use if the field is not available from storage. If non-null, then this is used instead of prompting the user
        fieldLabel - the name of the field, used as a label for the text input prompt. If null, the user will not be prompted if the value is not available.
        fieldDescription - detailed text to be used if prompting the user for a value
        isPassword - if true, the storage and user prompts are treated as a password (ie, not synced and prompts use password fields) prompting, if necessary
      • setField

        void setField​(java.lang.Object object,
                      java.lang.String fieldID,
                      java.lang.String fieldValue,
                      boolean isPassword)
        Stores a field associated with the given object (account, transaction, etc).
        Parameters:
        object - the object with which the field is associated. If null, the field is assumed to be global to the entire data set
        fieldID - the unique ID of the field, which will also be used to retrieve the value
        fieldValue - the value of the field to be stored, or null to delete the field
        isPassword - if true, the storage treats the field as a password (ie, not synced, observes the 'store passwords in file' setting)
      • accountsWithType

        java.util.List<Account> accountsWithType​(java.lang.String accountTypeStr)
        Gets a list of all accounts with the given account type ID. If no type ID is provided, return all accounts (ie non-categories). Account IDs are a string with one of the these values: "b": BANK "c": CREDIT_CARD "a": ASSET "l": LIABILITY "i": INCOME "e": EXPENSE "v": INVESTMENT "s": SECURITY "o": LOAN "r": ROOT
      • getAccountForID

        Account getAccountForID​(java.lang.String accountID)
        Gets the account having the given ID string, if it exists