seitime-frappe/frappe/docs/current/api/model/frappe.model.naming.html
2015-12-04 10:22:48 +05:30

209 lines
No EOL
5.8 KiB
HTML

<!-- title: frappe.model.naming --><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/frappe/blob/develop/frappe/model/naming.py"
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
</div>
<p class="docs-attr-name">
<a name="frappe.model.naming._set_amended_name" href="#frappe.model.naming._set_amended_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>_set_amended_name</b>
<i class="text-muted">(doc)</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="frappe.model.naming.append_number_if_name_exists" href="#frappe.model.naming.append_number_if_name_exists" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>append_number_if_name_exists</b>
<i class="text-muted">(doc)</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="frappe.model.naming.de_duplicate" href="#frappe.model.naming.de_duplicate" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>de_duplicate</b>
<i class="text-muted">(doctype, name)</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="frappe.model.naming.get_default_naming_series" href="#frappe.model.naming.get_default_naming_series" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>get_default_naming_series</b>
<i class="text-muted">(doctype)</i>
</p>
<div class="docs-attr-desc"><p>get default value for <code>naming_series</code> property</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.model.naming.getseries" href="#frappe.model.naming.getseries" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>getseries</b>
<i class="text-muted">(key, digits, doctype=)</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="frappe.model.naming.make_autoname" href="#frappe.model.naming.make_autoname" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>make_autoname</b>
<i class="text-muted">(key, doctype=)</i>
</p>
<div class="docs-attr-desc"><p>Creates an autoname from the given key:</p>
<p><strong>Autoname rules:</strong></p>
<pre><code> * The key is separated by '.'
* '####' represents a series. The string before this part becomes the prefix:
Example: ABC.#### creates a series ABC0001, ABC0002 etc
* 'MM' represents the current month
* 'YY' and 'YYYY' represent the current year
</code></pre>
<p><em>Example:</em></p>
<pre><code> * DE/./.YY./.MM./.##### will create a series like
DE/09/01/0001 where 09 is the year, 01 is the month and 0001 is the series
</code></pre>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.model.naming.revert_series_if_last" href="#frappe.model.naming.revert_series_if_last" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>revert_series_if_last</b>
<i class="text-muted">(key, name)</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="frappe.model.naming.set_name_by_naming_series" href="#frappe.model.naming.set_name_by_naming_series" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>set_name_by_naming_series</b>
<i class="text-muted">(doc)</i>
</p>
<div class="docs-attr-desc"><p>Sets name by the <code>naming_series</code> property</p>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.model.naming.set_new_name" href="#frappe.model.naming.set_new_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>set_new_name</b>
<i class="text-muted">(doc)</i>
</p>
<div class="docs-attr-desc"><p>Sets the `name`` property for the document based on various rules.</p>
<ol>
<li>If amened doc, set suffix.</li>
<li>If <code>autoname</code> method is declared, then call it.</li>
<li>If <code>autoname</code> property is set in the DocType (<code>meta</code>), then build it using the <code>autoname</code> property.</li>
<li>If <code>name</code> is already defined, use that name</li>
<li>If no rule defined, use hash.</li>
</ol>
<h4>Note:</h4>
<p><strong>Parameters:</strong></p>
<ul>
<li><strong><code>doc</code></strong> - Document to be named.</li>
</ul>
</div>
<br>
<p class="docs-attr-name">
<a name="frappe.model.naming.validate_name" href="#frappe.model.naming.validate_name" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.model.naming.<b>validate_name</b>
<i class="text-muted">(doctype, name, case=None, merge=False)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<!-- autodoc -->