ARSperl
32 results

 view release on metacpan or  search on metacpan

html/manual/OO/form.html  view on Meta::CPAN 

<HTML>
<HEAD>
<TITLE>ARSperl Manual - OO Layer Overview</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<H1>ARSperl Programmer's Manual - OO Layer Form Object</H1>
</CENTER>

<H2> Methods </H2>

<DL>
<DT><A NAME="new"><B>constructor</B></A>
<PRE>
  $f = new ARS::form(-form =&gt; scalar string,
                     -vui  =&gt; scalar string,
                     -connection =&gt; ARS object);
</PRE>

    This is the default constructor. To make life easier, you should use
    the openForm() method available in the 
    <a href="connection.html">Connection Object</A>.

<P>
<DT><A NAME="DESTROY"><B>destructor</B></A>
	Currently, the form destructor does nothing.
<P>
<DT><A NAME="query"><B>query()</B></A>
<PRE>
  @matches =  $f->query(-query         =&gt; scalar string,
                        -maxhits       =&gt; scalar string,
                        -firstretrieve =&gt; scalar string);
</PRE>

    This function allows you to run a query against a Form. Both parameters 
    are optional. If you specify neither, you will get a list of all
    available records upto the limit imposed on the server. If you specify
    a qualifier and a maxhits number, you will get matching records upto
    the maximum number of hits you specified. <P> 
    This method returns a list of matching Record IDs. It does not
    currently return a "query list". 

<P>
<DT><A NAME="getFieldID"><B>getFieldID()</B></A>
<PRE>
  $id = $f->getFieldID(-field =&gt; scalar string);
</PRE>

    This an "internal" function that is used to translate a field name to a 
    field ID. Eventually, it will obey the VUI you specified. 
<P>

<DT><A NAME="getFieldName"><B>getFieldName()</B></A>
<PRE>
  $name = $f->getFieldName(-id =&gt; scalar string);
</PRE>

    This an "internal" function that is used to translate a field ID to a 
    field nameD. Eventually, it will obey the VUI you specified. 
<P>

<DT><A NAME="getEnumValues"><B>getEnumValues()</B></A>
<PRE>
  @vals = $f->getEnumValues(-field =&gt; scalar string);
</PRE>

   This function returns a list of enumeration values (labels)
   for a given field. If the field is not an enumeration field,
   an exception is thrown (type=ERROR, num=81006).
<P>

<DT><A NAME="getFieldType"><B>getFieldType()</B></A>
<PRE>
  $type = $f->getFieldType(-name =&gt; scalar string,
                           -id =&gt; scalar string);
</PRE>

    This an "internal" function that is used to retrieve the datatype of a
    particular field. You must specify one of the parameters. If you
    specify both, the -id parameter is ignore in favor of the -name



( run in 0.983 second using v1.01-cache-2.11-cpan-39bf76dae61 )