296 lines
11 KiB
HTML
296 lines
11 KiB
HTML
<?xml version="1.0" encoding="ascii"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<title>linspector.lib.tasks.task.Task</title>
|
|
<link rel="stylesheet" href="epydoc.css" type="text/css" />
|
|
<script type="text/javascript" src="epydoc.js"></script>
|
|
</head>
|
|
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
|
alink="#204080">
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="linspector-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table width="100%" cellpadding="0" cellspacing="0">
|
|
<tr valign="top">
|
|
<td width="100%">
|
|
<span class="breadcrumbs">
|
|
<a href="linspector-module.html">Package linspector</a> ::
|
|
<a href="linspector.lib-module.html">Package lib</a> ::
|
|
<a href="linspector.lib.tasks-module.html">Package tasks</a> ::
|
|
<a href="linspector.lib.tasks.task-module.html">Module task</a> ::
|
|
Class Task
|
|
</span>
|
|
</td>
|
|
<td>
|
|
<table cellpadding="0" cellspacing="0">
|
|
<!-- hide/show private -->
|
|
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
|
|
onclick="toggle_private();">hide private</a>]</span></td></tr>
|
|
<tr><td align="right"><span class="options"
|
|
>[<a href="frames.html" target="_top">frames</a
|
|
>] | <a href="linspector.lib.tasks.task.Task-class.html"
|
|
target="_top">no frames</a>]</span></td></tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
<h1 class="epydoc">Class Task</h1><p class="nomargin-top"><span class="codelink"><a href="linspector.lib.tasks.task-pysrc.html#Task">source code</a></span></p>
|
|
<dl><dt>Known Subclasses:</dt>
|
|
<dd>
|
|
<ul class="subclass-list">
|
|
<li><a href="linspector.lib.tasks.sms.SmsTask-class.html">sms.SmsTask</a></li><li>, <a href="linspector.lib.tasks.xmpp.XmppTask-class.html">xmpp.XmppTask</a></li><li>, <a href="linspector.lib.tasks.email.EmailTask-class.html">email.EmailTask</a></li> </ul>
|
|
</dd></dl>
|
|
|
|
<hr />
|
|
<p>Base class for all built-in Tasks.</p>
|
|
|
|
<!-- ==================== INSTANCE METHODS ==================== -->
|
|
<a name="section-InstanceMethods"></a>
|
|
<table class="summary" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Instance Methods</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-InstanceMethods"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr class="private">
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="linspector.lib.tasks.task.Task-class.html#_execute" class="summary-sig-name" onclick="show_private();">_execute</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">taskType</span>,
|
|
<span class="summary-sig-arg">msg</span>)</span><br />
|
|
internal method which gets called for any member in a hostgroup.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.tasks.task-pysrc.html#Task._execute">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="linspector.lib.tasks.task.Task-class.html#execute_task" class="summary-sig-name">execute_task</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">msg</span>)</span><br />
|
|
this is the method tasks usually override.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.tasks.task-pysrc.html#Task.execute_task">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a name="get_task_type"></a><span class="summary-sig-name">get_task_type</span>(<span class="summary-sig-arg">self</span>)</span><br />
|
|
:return: the type set by set_type_task</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.tasks.task-pysrc.html#Task.get_task_type">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td width="15%" align="right" valign="top" class="summary">
|
|
<span class="summary-type"> </span>
|
|
</td><td class="summary">
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td><span class="summary-sig"><a href="linspector.lib.tasks.task.Task-class.html#set_task_type" class="summary-sig-name">set_task_type</a>(<span class="summary-sig-arg">self</span>,
|
|
<span class="summary-sig-arg">taskType</span>)</span><br />
|
|
sets the type of this task.</td>
|
|
<td align="right" valign="top">
|
|
<span class="codelink"><a href="linspector.lib.tasks.task-pysrc.html#Task.set_task_type">source code</a></span>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<!-- ==================== METHOD DETAILS ==================== -->
|
|
<a name="section-MethodDetails"></a>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="table-header">
|
|
<td colspan="2" class="table-header">
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
<tr valign="top">
|
|
<td align="left"><span class="table-header">Method Details</span></td>
|
|
<td align="right" valign="top"
|
|
><span class="options">[<a href="#section-MethodDetails"
|
|
class="privatelink" onclick="toggle_private();"
|
|
>hide private</a>]</span></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="_execute"></a>
|
|
<div class="private">
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">_execute</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">taskType</span>,
|
|
<span class="sig-arg">msg</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="linspector.lib.tasks.task-pysrc.html#Task._execute">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>internal method which gets called for any member in a hostgroup. It
|
|
determines if it has an appropriate type by comparing taskType with
|
|
get_task_type(). Calls execute_task() if the type matches</p>
|
|
<p>:param taskType: the type of the fail which is compared with
|
|
get_task_type() :param msg: the error message</p>
|
|
<p>:return: True if execute_task() is called succesfully, else False</p>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="execute_task"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">execute_task</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">msg</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="linspector.lib.tasks.task-pysrc.html#Task.execute_task">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>this is the method tasks usually override. It gets called anytime the
|
|
task should get executed</p>
|
|
<p>default does nothing</p>
|
|
<p>:param msg: the msg for this task</p>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<a name="set_task_type"></a>
|
|
<div>
|
|
<table class="details" border="1" cellpadding="3"
|
|
cellspacing="0" width="100%" bgcolor="white">
|
|
<tr><td>
|
|
<table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
<tr valign="top"><td>
|
|
<h3 class="epydoc"><span class="sig"><span class="sig-name">set_task_type</span>(<span class="sig-arg">self</span>,
|
|
<span class="sig-arg">taskType</span>)</span>
|
|
</h3>
|
|
</td><td align="right" valign="top"
|
|
><span class="codelink"><a href="linspector.lib.tasks.task-pysrc.html#Task.set_task_type">source code</a></span>
|
|
</td>
|
|
</tr></table>
|
|
|
|
<p>sets the type of this task.</p>
|
|
<p>Be aware! this method can only get called once!</p>
|
|
<p>:param taskType: the type of this task</p>
|
|
<dl class="fields">
|
|
</dl>
|
|
</td></tr></table>
|
|
</div>
|
|
<br />
|
|
<!-- ==================== NAVIGATION BAR ==================== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0"
|
|
bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="middle">
|
|
<!-- Home link -->
|
|
<th> <a
|
|
href="linspector-module.html">Home</a> </th>
|
|
|
|
<!-- Tree link -->
|
|
<th> <a
|
|
href="module-tree.html">Trees</a> </th>
|
|
|
|
<!-- Index link -->
|
|
<th> <a
|
|
href="identifier-index.html">Indices</a> </th>
|
|
|
|
<!-- Help link -->
|
|
<th> <a
|
|
href="help.html">Help</a> </th>
|
|
|
|
<th class="navbar" width="100%"></th>
|
|
</tr>
|
|
</table>
|
|
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
<tr>
|
|
<td align="left" class="footer">
|
|
Generated by Epydoc 3.0.1 on Wed Jun 19 03:26:57 2013
|
|
</td>
|
|
<td align="right" class="footer">
|
|
<a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
>http://epydoc.sourceforge.net</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<script type="text/javascript">
|
|
<!--
|
|
// Private objects are initially displayed (because if
|
|
// javascript is turned off then we want them to be
|
|
// visible); but by default, we want to hide them. So hide
|
|
// them unless we have a cookie that says to show them.
|
|
checkCookie();
|
|
// -->
|
|
</script>
|
|
</body>
|
|
</html>
|