[an error occurred while processing this directive]
[<a href="index.shtml">Package Index</a></code> | <a href="index_std.shtml">Mudlib Index</a></code> | <a href="index_eff.shtml">Effect Index</a></code>]<br><h2>File /obj/handlers/inherit/case_control.c</h2>
This is the system for case control.  It keeps tracks of all the current
open cases in the area and any modifications that are done to them.<p>Written by Pinkfish<p>Started Tue Jul 11 18:09:01 PDT 2000
<h2>Includes</h2>
This class includes the following files /include/nomic_system.h<h2>Method index</h2>
<ul>
<li><a href="#add_new_case">add_new_case</a>(string, string, string, string *)<br/>
This method opens a new case.
<li><a href="#add_note_to_case">add_note_to_case</a>(string, int, string, string)<br/>
This method adds a note to the case.
<li><a href="#add_person_to_case">add_person_to_case</a>(string, int, string, string, string)<br/>
This method adds a person to the case.
<li><a href="#appeal_case">appeal_case</a>(string, int, string, string)<br/>
This method sets the case as reopened for an appeal.
<li><a href="#close_case">close_case</a>(string, int, string, string, mixed)<br/>
This method closes the case.
<li><a href="#create_area">create_area</a>(string)<br/>
This method creates an area.
<li><a href="#query_case_file_name">query_case_file_name</a>(int)<br/>
This method returns the file name for the case given the id.
<li><a href="#query_closed_case">query_closed_case</a>(string, int)<br/>
This method returns the case associated with the specified closed
case.
<li><a href="#query_closed_cases">query_closed_cases</a>(string)<br/>
This method returns the cases which are currently closed.
<li><a href="#query_event_name">query_event_name</a>(int)<br/>
This method returns the short name of the event type.
<li><a href="#query_next_case_id">query_next_case_id</a>()<br/>
This method finds the next case id.
<li><a href="#query_next_note_id">query_next_note_id</a>()<br/>
This method finds the next note id.
<li><a href="#query_note">query_note</a>(int)<br/>
This method return the exciting note associated with the case.
<li><a href="#query_note_file_name">query_note_file_name</a>(int)<br/>
This method returns the file name for the note given the id.
<li><a href="#query_open_case">query_open_case</a>(string, int)<br/>
This method returns the case associated with the specified open
case.
<li><a href="#query_open_cases">query_open_cases</a>(string)<br/>
This returns the cases which are currently open.
<li><a href="#query_recently_closed_case">query_recently_closed_case</a>(string, int)<br/>
This method returns the case associated with the specified recently
closed case.
<li><a href="#query_recently_closed_cases">query_recently_closed_cases</a>(string)<br/>
This method returns the set of recently closed cases.
<li><a href="#remove_person_from_case">remove_person_from_case</a>(string, int, string, string, string)<br/>
This method removes a person from the case.
<li><a href="#update_recently_closed_cases">update_recently_closed_cases</a>()<br/>
This method goes through and checks the recently closed cases to see
if any of them need to be moved to the closed set.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_new_case">
add_new_case</a><pre class="autodocfuncdef">
int add_new_case(string area,
                 string opener,
                 string short,
                 string * people)
</pre><dd><br />
This method opens a new case.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area the case is in<br />
opener - the person who opened it<br />
short - the short description of the case<br />
people - the people involved<br />
<br />
<dd><b>Returns:</b>
<br />0 on failure and teh case id on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_note_to_case">
add_note_to_case</a><pre class="autodocfuncdef">
int add_note_to_case(string area,
                     int id,
                     string person,
                     string text)
</pre><dd><br />
This method adds a note to the case.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area to get the case in<br />
id - the id of the case<br />
person - the person adding the note<br />
text - the actual note text<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_person_to_case">
add_person_to_case</a><pre class="autodocfuncdef">
int add_person_to_case(string area,
                       int id,
                       string adder,
                       string person,
                       string text)
</pre><dd><br />
This method adds a person to the case.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area the case is in<br />
id - the id of the case<br />
adder - the person that adds the person<br />
person - the person to be added to the case<br />
text - the reason for adding the person<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="appeal_case">
appeal_case</a><pre class="autodocfuncdef">
int appeal_case(string area,
                int id,
                string appealer,
                string reason)
</pre><dd><br />
This method sets the case as reopened for an appeal.  After an appeal
the case will be closed again.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area the case is in<br />
id - the of the case to appeal<br />
appealer - the person who does the appeal<br />
reason - the reason for the appeal<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="close_case">
close_case</a><pre class="autodocfuncdef">
int close_case(string area,
               int id,
               string closer,
               string result,
               mixed data)
</pre><dd><br />
This method closes the case.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area the case is in<br />
id - the id of the case to close<br />
closer - the person that closes the case<br />
result - the string saying what the result of the case is<br />
desc - the description of the close reason<br />
data - special internal data used specifically for appeals<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="create_area">
create_area</a><pre class="autodocfuncdef">
void create_area(string area)
</pre><dd><br />
This method creates an area.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the name of the area to create
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_case_file_name">
query_case_file_name</a><pre class="autodocfuncdef">
string query_case_file_name(int id)
</pre><dd><br />
This method returns the file name for the case given the id.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
id - the id to return<br />
<br />
<dd><b>Returns:</b>
<br />the file name
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_closed_case">
query_closed_case</a><pre class="autodocfuncdef">
class nomic_case query_closed_case(string area,
                                   int id)
</pre><dd><br />
This method returns the case associated with the specified closed
case.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area to look for the case in<br />
id - the id of the case<br />
<br />
<dd><b>Returns:</b>
<br />the case class
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_closed_cases">
query_closed_cases</a><pre class="autodocfuncdef">
int * query_closed_cases(string area)
</pre><dd><br />
This method returns the cases which are currently closed.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area to get the cases in<br />
<br />
<dd><b>Returns:</b>
<br />the list of closed cases
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_event_name">
query_event_name</a><pre class="autodocfuncdef">
string query_event_name(int type)
</pre><dd><br />
This method returns the short name of the event type.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
type - the type to find the name of<br />
<br />
<dd><b>Returns:</b>
<br />the name of the type
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_next_case_id">
query_next_case_id</a><pre class="autodocfuncdef">
int query_next_case_id()
</pre><dd><br />
This method finds the next case id.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the next case id
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_next_note_id">
query_next_note_id</a><pre class="autodocfuncdef">
int query_next_note_id()
</pre><dd><br />
This method finds the next note id.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the next note id
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_note">
query_note</a><pre class="autodocfuncdef">
class nomic_case_note query_note(int note_num)
</pre><dd><br />
This method return the exciting note associated with the case.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
note_num - the number of the note<br />
<br />
<dd><b>Returns:</b>
<br />the note class, or 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_note_file_name">
query_note_file_name</a><pre class="autodocfuncdef">
string query_note_file_name(int id)
</pre><dd><br />
This method returns the file name for the note given the id.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
id - the id to return<br />
<br />
<dd><b>Returns:</b>
<br />the file name
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_open_case">
query_open_case</a><pre class="autodocfuncdef">
class nomic_case query_open_case(string area,
                                 int id)
</pre><dd><br />
This method returns the case associated with the specified open
case.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area to look for the case in<br />
id - the id of the case<br />
<br />
<dd><b>Returns:</b>
<br />the case class
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_open_cases">
query_open_cases</a><pre class="autodocfuncdef">
int * query_open_cases(string area)
</pre><dd><br />
This returns the cases which are currently open.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the are to get the cases in<br />
<br />
<dd><b>Returns:</b>
<br />the list of opened cases
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_recently_closed_case">
query_recently_closed_case</a><pre class="autodocfuncdef">
class nomic_case query_recently_closed_case(string area,
                                            int id)
</pre><dd><br />
This method returns the case associated with the specified recently
closed case.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area to look for the case in<br />
id - the id of the case<br />
<br />
<dd><b>Returns:</b>
<br />the case class
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_recently_closed_cases">
query_recently_closed_cases</a><pre class="autodocfuncdef">
int * query_recently_closed_cases(string area)
</pre><dd><br />
This method returns the set of recently closed cases.  These are
cases that can be appealed.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area to get the cases in<br />
<br />
<dd><b>Returns:</b>
<br />the list of recently closed cases
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_person_from_case">
remove_person_from_case</a><pre class="autodocfuncdef">
int remove_person_from_case(string area,
                            int id,
                            string remover,
                            string person,
                            string text)
</pre><dd><br />
This method removes a person from the case.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
area - the area the case is in<br />
id - the id of the case<br />
remover - the person that removes the person<br />
person - the person to be removed to the case<br />
text - the reason for removeing the person<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="update_recently_closed_cases">
update_recently_closed_cases</a><pre class="autodocfuncdef">
void update_recently_closed_cases()
</pre><dd><br />
This method goes through and checks the recently closed cases to see
if any of them need to be moved to the closed set.
<br />

</dl>
[an error occurred while processing this directive]