SF.net SVN: ledger-smb:[3831] addons/1.3/budgetting/trunk/scripts/budgets. pl

[..hidden..]

Revision: 3831
          http://ledger-smb.svn.sourceforge.net/ledger-smb/?rev=3831&view=rev
Author:   einhverfr
Date:     2011-10-09 23:43:46 +0000 (Sun, 09 Oct 2011)
Log Message:
-----------
Beginnings of a workflow script

Added Paths:
-----------
    addons/1.3/budgetting/trunk/scripts/budgets.pl

Added: addons/1.3/budgetting/trunk/scripts/budgets.pl
===================================================================
--- addons/1.3/budgetting/trunk/scripts/budgets.pl	                        (rev 0)
+++ addons/1.3/budgetting/trunk/scripts/budgets.pl	2011-10-09 23:43:46 UTC (rev 3831)
@@ -0,0 +1,108 @@
+=head1 NAME
+LedgerSMB::Scripts::budgets
+
+=cut
+
+package LedgerSMB::Scripts::budgets;
+
+=head1 SYNOPSYS
+Budget workflow scripts.
+
+=head1 REQUIRES
+
+=over
+
+=item LedgerSMB::DBObject::Budget
+=item LedgerSMB::DBObject::Budget_Report
+
+=cut
+
+use LedgerSMB::DBObject::Budget;
+use LedgerSMB::DBObject::Budget_Report;
+
+=head1 METHODS
+
+=over
+
+=item variance_report
+Requires id field to be set.
+
+=cut
+
+sub variance_report {
+    my ($request) = @_;
+}
+
+=item new_budget 
+No inputs provided.  LedgerSMB::DBObject::Budget properties can be used to set
+defaults however.
+
+=cut
+
+sub new_budget {
+    my ($request) = @_;
+}
+
+=item save_budget
+LedgerSMB::DBObject::Budget properties required.  Lines represented by
+[property]_[line number] notation.
+
+=cut
+
+sub save_budget {
+    my ($request) = @_;
+} 
+
+=item approve
+Requires id.  Approves the budget.
+
+=cut
+
+sub approve {
+    my ($request) = @_;
+} 
+
+=item reject
+Requires id.  Rejects unapproved budget and deletes it.
+
+=cut
+
+sub reject {
+    my ($request) = @_;
+} 
+
+=item obsolete
+Requires id, Marks budget obsolete.
+
+=cut
+
+sub obsolete {
+    my ($request) = @_;
+} 
+
+=item add_note
+Requires id, subject, and note.  Adds a note to the budget.
+
+=cut
+
+sub add_note {
+    my ($request) = @_;
+} 
+
+=back
+
+=head1 SEE ALSO
+
+=over
+
+=item LedgerSMB::DBObject::Budget
+=item LedgerSMB::DBObject::Budget_Report
+
+=back
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2011 LedgerSMB Core Team.  This file is licensed under the GNU 
+General Public License version 2, or at your option any later version.  Please
+see the included License.txt for details.
+

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.