Doc for assetCode

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Succinct Web Framework'
+copyright = '2022, Venkatraman Mahadevan'
+author = 'Venkatraman Mahadevan'
+
+# The full version, including alpha/beta/rc tags
+release = '2.8'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+'myst_parser',
+]
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+#html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,26 @@
+.. Succinct Web Framework documentation master file, created by
+   sphinx-quickstart on Fri Feb 18 15:00:56 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Succinct Web Framework's documentation!
+==================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   usage/overview
+   usage/quickstart
+   usage/detailed
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+
+..  
+    * :ref:`modindex`
+
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,3 @@
+# extensions
+
+myst-parser[sphinx]

docs/usage/assetcode.md

@@ -0,0 +1,76 @@
+# AssetCode
+>Use this table to store gst code  
+>This class maps to ASSET_CODE table in DB.
+
+## Maven Dependency
+### Add this dependency in pom.xml
+````xml
+<dependency>
+    <groupId>com.github.venkatramanm.swf-all</groupId>
+    <artifactId>swf-plugin-gst</artifactId>
+    <version>2.11</version>
+</dependency>
+
+````
+## Table Structure
+
+| Column | DataType | Model Field|
+|-|-|-|
+|CODE |  String | code |
+| DESCRIPTION|  String  | description|
+|RENTAL_ASSET_CODE_ID  | Long| rentalAssetCodeId|  
+| DELIVERED_ELECTRONICALLY | Boolean| deliveredElectronically|
+| GST_PCT | Double | gstPct|
+| LONG_DESCRIPTION|  String| longDescription
+### Methods in AssetCode Class
+> **Apart from getters and setters for columns following methods are available**
+> - boolean isHsn()
+> - boolean isSac()
+> - static AssetCode find(String code)
+> - AssetCode getRentalAssetCode()
+
+### Imports required
+#### Import this inside the .java file
+* import com.venky.swf.plugins.gst.db.model.assets.AssetCode
+
+## Example
+### How to insert a new AssetCode
+
+````java
+public class InsertAsset{ 
+    public static void main(String[] args){
+        AssetCode assetCode = Database.getTable(AssetCode.class).newRecord();
+        assetCode.setCode("HSN-------");
+    }
+}
+````
+
+### How to retrieve a AssetCode from DB using any field
+
+````java
+public class GetAsset{
+    public static void main(String[] args){
+        Select select = new Select().from(AssetCode.class);
+        Expression expression = new Expression(select.getPool(), "RENTAL_ASSET_CODE_ID", Operator.EQ, <"rentalAssetCode">);
+        List<AssetCode> assetCodes = select.where(expression).execute(1);
+    }
+}
+````
+### How to retrieve a AssetCode from DB using code
+
+````java
+public class GetAssetByCode{
+    public static void main(String[] args){
+        AssetCode assetCode = AssetCode.find("SAC-------");
+    }
+}
+````
+
+
+
+
+
+
+
+
+