[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/applications_handler.c</h2>
 Applications handler
 @author Drakkos
 @started 30/01/2003

<h2>Includes</h2>
This class includes the following files /include/applications.h, /include/newbiehelpers.h, /include/player_handler.h, /include/playtesters.h, /include/mail.h, /include/playerinfo.h, /include/player.h, /include/library.h and /include/board.h<h2>Method index</h2>
<ul>
<li><a href="#add_application">add_application</a>(string, string, string, string)<br/>
This method adds an application into the system.
<li><a href="#add_application_type">add_application_type</a>(string, int, string, int, int, int, int, string *, string, string, int)<br/>
This method adds an application type into the system.
<li><a href="#application_requirements">application_requirements</a>(string)<br/>
This method lists all the requirements to apply for the specific
type.
<li><a href="#delete_application">delete_application</a>(string, string)<br/>
 Deletes an application from the system.
<li><a href="#delete_vouch">delete_vouch</a>(string, string, string)<br/>
This method deletes a vouch for a special person in the system.
<li><a href="#find_application">find_application</a>(string, string)<br/>
 Find a particular application.
<li><a href="#find_type">find_type</a>(string)<br/>
 Find a particular application type.
<li><a href="#format_application">format_application</a>(int)<br/>
This method formats the specified application for posting to the
board.
<li><a href="#list_applications">list_applications</a>()<br/>
This method lists all the current applications.
<li><a href="#list_applications_newbiehelpers">list_applications_newbiehelpers</a>()<br/>
This method returns the list of newbiehelpers who have applied to be
a happy new newbie helper.
<li><a href="#load_me">load_me</a>()<br/>
Loads the object.
<li><a href="#make_vouch">make_vouch</a>(string, string, string, string)<li><a href="#number_of_vouches">number_of_vouches</a>(string, string)<br/>
 Returns the number of vouches a player has received for an application.
<li><a href="#query_application_vouches">query_application_vouches</a>(string, string)<br/>
This method returns the vouches for the specified application.
<li><a href="#query_applications_accepted">query_applications_accepted</a>(string)<br/>
This checks to see if the domain is accepting applications at all.
<li><a href="#query_debug_types">query_debug_types</a>()<br/>
This returns the entire types array, used for debug purposes only.
<li><a href="#query_director_applications_accepted">query_director_applications_accepted</a>(string)<br/>
This checks to see if the domain is accepting applications at all.
<li><a href="#query_director_domain_status">query_director_domain_status</a>()<br/>
This method returns the status of the director domains.
<li><a href="#query_domain_status">query_domain_status</a>()<br/>
This method returns the status of the domain.
<li><a href="#query_intro_text">query_intro_text</a>(string)<br/>
This returns the intro text for the specific application type.
<li><a href="#query_questions">query_questions</a>(string)<br/>
This returns all the questions for the specific application type.
<li><a href="#query_responsibility">query_responsibility</a>(string)<br/>
This method returns the responsability of the position.
<li><a href="#query_types">query_types</a>()<br/>
This returns the various possible types of applications allowed.
<li><a href="#query_vouch">query_vouch</a>(string, string, string)<br/>
 Query the vouch for a particular player in a particular category.
<li><a href="#query_vouches_for_all">query_vouches_for_all</a>(string)<br/>
This method finds all the vouches for the specified person, irrelevant
of application.
<li><a href="#save_me">save_me</a>()<br/>
Saves the object.
<li><a href="#toggle_domain_lock">toggle_domain_lock</a>(string)<br/>
Turns on and off a lock on the domain so that applications are suspended
or allowed.
<li><a href="#valid_application">valid_application</a>(string, string)<br/>
This method checks to see if the application is valid or not.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_application">
add_application</a><pre class="autodocfuncdef">
int add_application(string t,
                    string n,
                    string te,
                    string dom)
</pre><dd><br />
This method adds an application into the system.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
t - the type of applicatioon to add<br />
n - the name of the person applying<br />
te - their text of the application<br />
dom - the domain to apply to<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_application_type">
add_application_type</a><pre class="autodocfuncdef">
varargs void add_application_type(string t,
                                  int v,
                                  string b,
                                  int g,
                                  int q,
                                  int a,
                                  int ti,
                                  string * qu,
                                  string intro,
                                  string responsibility,
                                  int cre_level)
</pre><dd><br />
This method adds an application type into the system.  The application
type has a bunch of requirements that must be met before you can apply
for the specified position.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
t - the type of the application<br />
v - the number of vouches required<br />
b - the board to post applications to<br />
g - the gp requirements<br />
q - the guild level requirement<br />
a - the age requirement<br />
qu - the questions to ask<br />
ti - the timeout<br />
intro - the introductory test<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="application_requirements">
application_requirements</a><pre class="autodocfuncdef">
string application_requirements(string type)
</pre><dd><br />
This method lists all the requirements to apply for the specific
type.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
type - the type of the application<br />
<br />
<dd><b>Returns:</b>
<br />the application requirements
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="delete_application">
delete_application</a><pre class="autodocfuncdef">
int delete_application(string t,
                       string n)
</pre><dd><br />
 Deletes an application from the system.

 @param name The name of the aplicant
 @param type The type of application.
 @return 1 for success, 0 for failure.

<br />

<dt class="autodocfuncname"><a name="delete_vouch">
delete_vouch</a><pre class="autodocfuncdef">
int delete_vouch(string who,
                 string name,
                 string position)
</pre><dd><br />
This method deletes a vouch for a special person in the system.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
who - the person doing the vouch<br />
name - the person who was vouched<br />
position - the position being vouched for
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="find_application">
find_application</a><pre class="autodocfuncdef">
int find_application(string name,
                     string type)
</pre><dd><br />
 Find a particular application.

 @param name The name of the candidate.
 @param type The type of application.
 @return the index of the candidate, or -1 if none found.

<br />

<dt class="autodocfuncname"><a name="find_type">
find_type</a><pre class="autodocfuncdef">
int find_type(string type)
</pre><dd><br />
 Find a particular application type.

 @param type The type of application.
 @return the index of the type, or -1 if none found.

<br />

<dt class="autodocfuncname"><a name="format_application">
format_application</a><pre class="autodocfuncdef">
string format_application(int i)
</pre><dd><br />
This method formats the specified application for posting to the
board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
i - the application id<br />
<br />
<dd><b>Returns:</b>
<br />the formatted application
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="list_applications">
list_applications</a><pre class="autodocfuncdef">
string list_applications()
</pre><dd><br />
This method lists all the current applications.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the list of current applications
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="list_applications_newbiehelpers">
list_applications_newbiehelpers</a><pre class="autodocfuncdef">
string list_applications_newbiehelpers()
</pre><dd><br />
This method returns the list of newbiehelpers who have applied to be
a happy new newbie helper.
<br />

<dt class="autodocfuncname"><a name="load_me">
load_me</a><pre class="autodocfuncdef">
void load_me()
</pre><dd><br />
Loads the object.
<br />

<dt class="autodocfuncname"><a name="make_vouch">
make_vouch</a><pre class="autodocfuncdef">
int make_vouch(string t,
               string p,
               string n,
               string v)
</pre>
<dt class="autodocfuncname"><a name="number_of_vouches">
number_of_vouches</a><pre class="autodocfuncdef">
int number_of_vouches(string name,
                      string type)
</pre><dd><br />
 Returns the number of vouches a player has received for an application.

 @param i The index of the application.
 @return 1 for success, 0 for failure.

<br />

<dt class="autodocfuncname"><a name="query_application_vouches">
query_application_vouches</a><pre class="autodocfuncdef">
mapping query_application_vouches(string type,
                                  string name)
</pre><dd><br />
This method returns the vouches for the specified application.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
type - the type of the application<br />
name - the person who is applying
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_applications_accepted">
query_applications_accepted</a><pre class="autodocfuncdef">
int query_applications_accepted(string dom)
</pre><dd><br />
This checks to see if the domain is accepting applications at all.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dom - the domain to check<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is accepting
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_debug_types">
query_debug_types</a><pre class="autodocfuncdef">
mixed * query_debug_types()
</pre><dd><br />
This returns the entire types array, used for debug purposes only.
<br />

<dt class="autodocfuncname"><a name="query_director_applications_accepted">
query_director_applications_accepted</a><pre class="autodocfuncdef">
int query_director_applications_accepted(string dom)
</pre><dd><br />
This checks to see if the domain is accepting applications at all.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dom - the domain to check<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is accepting
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_director_domain_status">
query_director_domain_status</a><pre class="autodocfuncdef">
mapping query_director_domain_status()
</pre><dd><br />
This method returns the status of the director domains.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the domain lockout status
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_domain_status">
query_domain_status</a><pre class="autodocfuncdef">
mapping query_domain_status()
</pre><dd><br />
This method returns the status of the domain.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the domain lockout status
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_intro_text">
query_intro_text</a><pre class="autodocfuncdef">
string query_intro_text(string type)
</pre><dd><br />
This returns the intro text for the specific application type.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
type - the type to look for the intro text to<br />
<br />
<dd><b>Returns:</b>
<br />the intro text.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_questions">
query_questions</a><pre class="autodocfuncdef">
string * query_questions(string type)
</pre><dd><br />
This returns all the questions for the specific application type.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
type - the type to look for the questions for<br />
<br />
<dd><b>Returns:</b>
<br />the questions
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_responsibility">
query_responsibility</a><pre class="autodocfuncdef">
string query_responsibility(string type)
</pre><dd><br />
This method returns the responsability of the position.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
type - the type to look for<br />
<br />
<dd><b>Returns:</b>
<br />the responsability of the position
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_types">
query_types</a><pre class="autodocfuncdef">
string * query_types()
</pre><dd><br />
This returns the various possible types of applications allowed.
<br />

<dt class="autodocfuncname"><a name="query_vouch">
query_vouch</a><pre class="autodocfuncdef">
string query_vouch(string t,
                   string p,
                   string n)
</pre><dd><br />
 Query the vouch for a particular player in a particular category.

 @param t The type of application.
 @param p The name of the player.
 @param n The name of the voucher.
 @return the text of the vouch or 0 if none exists.

<br />

<dt class="autodocfuncname"><a name="query_vouches_for_all">
query_vouches_for_all</a><pre class="autodocfuncdef">
mapping query_vouches_for_all(string name)
</pre><dd><br />
This method finds all the vouches for the specified person, irrelevant
of application.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the person to find the vouches for
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="save_me">
save_me</a><pre class="autodocfuncdef">
void save_me()
</pre><dd><br />
Saves the object.
<br />

<dt class="autodocfuncname"><a name="toggle_domain_lock">
toggle_domain_lock</a><pre class="autodocfuncdef">
int toggle_domain_lock(string dom)
</pre><dd><br />
Turns on and off a lock on the domain so that applications are suspended
or allowed.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dom - the domain to be locked
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="valid_application">
valid_application</a><pre class="autodocfuncdef">
int valid_application(string name,
                      string type)
</pre><dd><br />
This method checks to see if the application is valid or not.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the person being checked<br />
type - the type of application being checked<br />
<br />
<dd><b>Returns:</b>
<br />1 on success
<br /><br />
<br /></dl>

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