brotherton-erpnext/erpnext/docs/current/models/hr/holiday_list.html

354 lines
7.9 KiB
HTML
Raw Normal View History

2015-12-03 12:58:19 +00:00
<!-- title: Holiday List -->
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/hr/doctype/holiday_list"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<p><b>Table Name:</b> <code>tabHoliday List</code></p>
<h3>Fields</h3>
<table class="table table-bordered" style="table-layout: fixed;">
<thead>
<tr>
<th style="width: 5%">Sr</th>
<th style="width: 25%">Fieldname</th>
<th style="width: 20%">Type</th>
<th style="width: 25%">Label</th>
<th style="width: 25%">Options</th>
</tr>
</thead>
<tbody>
<tr >
<td>1</td>
<td class="danger" title="Mandatory"><code>holiday_list_name</code></td>
<td >
Data</td>
<td >
Holiday List Name
</td>
<td></td>
</tr>
<tr >
<td>2</td>
<td ><code>is_default</code></td>
<td >
Check</td>
<td >
Default
</td>
<td></td>
</tr>
<tr >
<td>3</td>
<td class="danger" title="Mandatory"><code>fiscal_year</code></td>
<td >
Link</td>
<td >
Fiscal Year
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/accounts/fiscal_year">Fiscal Year</a>
</td>
</tr>
<tr >
<td>4</td>
<td ><code>weekly_off</code></td>
<td >
Select</td>
<td >
Weekly Off
</td>
<td>
<pre>
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday</pre>
</td>
</tr>
<tr >
<td>5</td>
<td ><code>get_weekly_off_dates</code></td>
<td >
Button</td>
<td >
Get Weekly Off Dates
</td>
<td>
<pre>get_weekly_off_dates</pre>
</td>
</tr>
<tr >
<td>6</td>
<td ><code>holidays</code></td>
<td >
Table</td>
<td >
Holidays
</td>
<td>
<a href="https://frappe.github.io/erpnext/current/models/hr/holiday">Holiday</a>
</td>
</tr>
<tr >
<td>7</td>
<td ><code>clear_table</code></td>
<td >
Button</td>
<td >
Clear Table
</td>
<td>
<pre>clear_table</pre>
</td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>erpnext.hr.doctype.holiday_list.holiday_list</h4>
<h3 style="font-weight: normal;">Class <b>HolidayList</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="clear_table" href="#clear_table" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>clear_table</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_weekly_off_date_list" href="#get_weekly_off_date_list" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_weekly_off_date_list</b>
<i class="text-muted">(self, year_start_date, year_end_date)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="get_weekly_off_dates" href="#get_weekly_off_dates" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_weekly_off_dates</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="update_default_holiday_list" href="#update_default_holiday_list" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>update_default_holiday_list</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate" href="#validate" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_days" href="#validate_days" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_days</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="validate_values" href="#validate_values" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>validate_values</b>
<i class="text-muted">(self)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
</div>
<hr>
<p><span class="label label-info">Public API</span>
<br><code>/api/method/erpnext.hr.doctype.holiday_list.holiday_list.get_events</code>
</p>
<p class="docs-attr-name">
<a name="erpnext.hr.doctype.holiday_list.holiday_list.get_events" href="#erpnext.hr.doctype.holiday_list.holiday_list.get_events" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.hr.doctype.holiday_list.holiday_list.<b>get_events</b>
<i class="text-muted">(start, end, filters=None)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<p class="docs-attr-name">
<a name="erpnext.hr.doctype.holiday_list.holiday_list.get_fy_start_end_dates" href="#erpnext.hr.doctype.holiday_list.holiday_list.get_fy_start_end_dates" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
erpnext.hr.doctype.holiday_list.holiday_list.<b>get_fy_start_end_dates</b>
<i class="text-muted">(fiscal_year)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<h4>Linked In:</h4>
<ul>
<li>
<a href="https://frappe.github.io/erpnext/current/models/setup/company">Company</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/hr/employee">Employee</a>
</li>
<li>
<a href="https://frappe.github.io/erpnext/current/models/manufacturing/workstation">Workstation</a>
</li>
</ul>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->