Sophie: ghc-hledger-lib-devel-0.14-2.fc14 x86

ghc-hledger-lib-devel-0.14-2.fc14.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Hledger.Data.Posting</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Hledger-Data-Posting.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>hledger-lib-0.14: Reusable types and utilities for the hledger accounting tool and financial apps in general.</TD
><TD CLASS="topbut"
><A HREF="src/Hledger-Data-Posting.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Hledger.Data.Posting</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>A <TT
><A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
></TT
> represents a <TT
><A HREF="Hledger-Data-Types.html#t%3AMixedAmount"
>MixedAmount</A
></TT
> being added to or subtracted from a
single <TT
><A HREF="Hledger-Data-Types.html#t%3AAccount"
>Account</A
></TT
>.  Each <TT
><A HREF="Hledger-Data-Types.html#t%3ATransaction"
>Transaction</A
></TT
> contains two or more postings which
should add up to 0. Postings also reference their parent transaction, so
we can get a date or description for a posting (from the transaction).
Strictly speaking, &quot;entry&quot; is probably a better name for these.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3AshowPosting"
>showPosting</A
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AshowPostingForRegister"
>showPostingForRegister</A
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AisReal"
>isReal</A
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AisVirtual"
>isVirtual</A
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AisBalancedVirtual"
>isBalancedVirtual</A
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AhasAmount"
>hasAmount</A
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AaccountNamesFromPostings"
>accountNamesFromPostings</A
> :: [<A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
>] -&gt; [<A HREF="Hledger-Data-Types.html#t%3AAccountName"
>AccountName</A
>]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsumPostings"
>sumPostings</A
> :: [<A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
>] -&gt; <A HREF="Hledger-Data-Types.html#t%3AMixedAmount"
>MixedAmount</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ApostingDate"
>postingDate</A
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/time-1.1.4/Data-Time-Calendar.html#t%3ADay"
>Day</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ApostingCleared"
>postingCleared</A
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AisPostingInDateSpan"
>isPostingInDateSpan</A
> :: <A HREF="Hledger-Data-Types.html#t%3ADateSpan"
>DateSpan</A
> -&gt; <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AisEmptyPosting"
>isEmptyPosting</A
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ApostingsDateSpan"
>postingsDateSpan</A
> :: [<A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
>] -&gt; <A HREF="Hledger-Data-Types.html#t%3ADateSpan"
>DateSpan</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:showPosting"
><A NAME="v%3AshowPosting"
></A
></A
><B
>showPosting</B
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#showPosting"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:showPostingForRegister"
><A NAME="v%3AshowPostingForRegister"
></A
></A
><B
>showPostingForRegister</B
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#showPostingForRegister"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:isReal"
><A NAME="v%3AisReal"
></A
></A
><B
>isReal</B
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#isReal"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:isVirtual"
><A NAME="v%3AisVirtual"
></A
></A
><B
>isVirtual</B
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#isVirtual"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:isBalancedVirtual"
><A NAME="v%3AisBalancedVirtual"
></A
></A
><B
>isBalancedVirtual</B
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#isBalancedVirtual"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:hasAmount"
><A NAME="v%3AhasAmount"
></A
></A
><B
>hasAmount</B
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#hasAmount"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:accountNamesFromPostings"
><A NAME="v%3AaccountNamesFromPostings"
></A
></A
><B
>accountNamesFromPostings</B
> :: [<A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
>] -&gt; [<A HREF="Hledger-Data-Types.html#t%3AAccountName"
>AccountName</A
>]</TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#accountNamesFromPostings"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:sumPostings"
><A NAME="v%3AsumPostings"
></A
></A
><B
>sumPostings</B
> :: [<A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
>] -&gt; <A HREF="Hledger-Data-Types.html#t%3AMixedAmount"
>MixedAmount</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#sumPostings"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:postingDate"
><A NAME="v%3ApostingDate"
></A
></A
><B
>postingDate</B
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/time-1.1.4/Data-Time-Calendar.html#t%3ADay"
>Day</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#postingDate"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:postingCleared"
><A NAME="v%3ApostingCleared"
></A
></A
><B
>postingCleared</B
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#postingCleared"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Is this posting cleared? If this posting was individually marked
 as cleared, returns True. Otherwise, return the parent
 transaction's cleared status or, if there is no parent
 transaction, return False.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:isPostingInDateSpan"
><A NAME="v%3AisPostingInDateSpan"
></A
></A
><B
>isPostingInDateSpan</B
> :: <A HREF="Hledger-Data-Types.html#t%3ADateSpan"
>DateSpan</A
> -&gt; <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#isPostingInDateSpan"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Does this posting fall within the given date span ?
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:isEmptyPosting"
><A NAME="v%3AisEmptyPosting"
></A
></A
><B
>isEmptyPosting</B
> :: <A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#isEmptyPosting"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:postingsDateSpan"
><A NAME="v%3ApostingsDateSpan"
></A
></A
><B
>postingsDateSpan</B
> :: [<A HREF="Hledger-Data-Types.html#t%3APosting"
>Posting</A
>] -&gt; <A HREF="Hledger-Data-Types.html#t%3ADateSpan"
>DateSpan</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Data-Posting.html#postingsDateSpan"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Get the minimal date span which contains all the postings, or
 DateSpan Nothing Nothing if there are none.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>