updated documentation
[ocamldap:paurkedals-ocamldap.git] / doc / ocamldap / html / Ldap_ooclient.ldapentry.html
1 <html>
2 <head>
3 <link rel="stylesheet" href="style.css" type="text/css">
4 <link rel="Start" href="index.html">
5 <link rel="next" href="Ldap_ooclient.ldapcon.html">
6 <link rel="Up" href="Ldap_ooclient.html">
7 <link title="Index of types" rel=Appendix href="index_types.html">
8 <link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
9 <link title="Index of values" rel=Appendix href="index_values.html">
10 <link title="Index of class methods" rel=Appendix href="index_methods.html">
11 <link title="Index of classes" rel=Appendix href="index_classes.html">
12 <link title="Index of class types" rel=Appendix href="index_class_types.html">
13 <link title="Index of modules" rel=Appendix href="index_modules.html">
14 <link title="Lber" rel="Chapter" href="Lber.html">
15 <link title="Ldap_types" rel="Chapter" href="Ldap_types.html">
16 <link title="Ldap_error" rel="Chapter" href="Ldap_error.html">
17 <link title="Ldap_protocol" rel="Chapter" href="Ldap_protocol.html">
18 <link title="Ldap_url" rel="Chapter" href="Ldap_url.html">
19 <link title="Ldap_filter" rel="Chapter" href="Ldap_filter.html">
20 <link title="Ldap_dn" rel="Chapter" href="Ldap_dn.html">
21 <link title="Ldap_funclient" rel="Chapter" href="Ldap_funclient.html">
22 <link title="Ldap_ooclient" rel="Chapter" href="Ldap_ooclient.html">
23 <link title="Ldap_schemaparser" rel="Chapter" href="Ldap_schemaparser.html">
24 <link title="Ldap_funserver" rel="Chapter" href="Ldap_funserver.html">
25 <link title="Ldif_oo" rel="Chapter" href="Ldif_oo.html">
26 <link title="Ldap_toplevel" rel="Chapter" href="Ldap_toplevel.html">
27 <link title="Ldap_mutex" rel="Chapter" href="Ldap_mutex.html">
28 <link title="Ldif_changerec_oo" rel="Chapter" href="Ldif_changerec_oo.html">
29 <link title="Ldap_txooclient" rel="Chapter" href="Ldap_txooclient.html"><title>Ldap_ooclient.ldapentry</title>
30 </head>
31 <body>
32 <div class="navbar">&nbsp;<a href="Ldap_ooclient.html">Up</a>
33 &nbsp;<a href="Ldap_ooclient.ldapcon.html">Next</a>
34 </div>
35 <center><h1>Class <a href="type_Ldap_ooclient.ldapentry.html">Ldap_ooclient.ldapentry</a></h1></center>
36 <br>
37 <pre><span class="keyword">class</span> <a name="TYPEldapentry"></a>ldapentry : <code class="type"></code><code class="code"><span class="keyword">object</span></code> <a href="Ldap_ooclient.ldapentry.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>this object represents a remote object within local memory. It
38     records all local changes made to it (if it's changetype is set to
39     `MODIFY), and can commit them to the server at a later time via
40     <a href="Ldap_ooclient.ldapcon.html#METHODupdate_entry"><code class="code"><span class="constructor">Ldap_ooclient</span>.ldapcon.update_entry</code></a>.<br>
41 <hr width="100%">
42 <pre><span class="keyword">method</span> <a name="METHODadd"></a>add : <code class="type"><a href="Ldap_ooclient.html#TYPEop_lst">op_lst</a> -> unit</code></pre><div class="info">
43 add values to an attribute (or create a new attribute). Does
44       not change the server until you update<br>
45 </div>
46 <pre><span class="keyword">method</span> <a name="METHODattributes"></a>attributes : <code class="type">string list</code></pre><div class="info">
47 return a list of the type (name) of all the attributes present
48     on the object<br>
49 </div>
50 <pre><span class="keyword">method</span> <a name="METHODchanges"></a>changes : <code class="type">(<a href="Ldap_types.html#TYPEmodify_optype">Ldap_types.modify_optype</a> * string * string list) list</code></pre><div class="info">
51 return a list of changes made to the object in a the format of
52         a modify operation. For example, you can apply the changes to another
53         ldapentry object using the <a href="Ldap_ooclient.ldapentry.html#METHODmodify"><code class="code"><span class="constructor">Ldap_ooclient</span>.ldapentry.modify</code></a>
54         method<br>
55 </div>
56 <pre><span class="keyword">method</span> <a name="METHODchangetype"></a>changetype : <code class="type"><a href="Ldap_ooclient.html#TYPEchangetype">changetype</a></code></pre><div class="info">
57 return the changetype of the object<br>
58 </div>
59 <pre><span class="keyword">method</span> <a name="METHODdelete"></a>delete : <code class="type"><a href="Ldap_ooclient.html#TYPEop_lst">op_lst</a> -> unit</code></pre><div class="info">
60 delete attributes from the object, does not change the
61     directory until you update<br>
62 </div>
63 <pre><span class="keyword">method</span> <a name="METHODdn"></a>dn : <code class="type">string</code></pre><div class="info">
64 return the dn of the object<br>
65 </div>
66 <pre><span class="keyword">method</span> <a name="METHODdiff"></a>diff : <code class="type"><a href="Ldap_ooclient.ldapentry_t.html">ldapentry_t</a> -><br>       (<a href="Ldap_types.html#TYPEmodify_optype">Ldap_types.modify_optype</a> * string * string list) list</code></pre><div class="info">
67 given an ldapentry, return the differences between the current
68         entry and the specified entry in the form of a modify
69         operation which would make the specified entry the same as the
70         current entry.<br>
71 </div>
72 <pre><span class="keyword">method</span> <a name="METHODexists"></a>exists : <code class="type">string -> bool</code></pre><div class="info">
73 query whether the attribute type (name) exists in the object<br>
74 </div>
75 <pre><span class="keyword">method</span> <a name="METHODflush_changes"></a>flush_changes : <code class="type">unit</code></pre><div class="info">
76 clear all accumulated changes<br>
77 </div>
78 <pre><span class="keyword">method</span> <a name="METHODget_value"></a>get_value : <code class="type">string -> string list</code></pre><div class="info">
79 get the value of an attribute<br>
80 <b>Raises</b> <code>Not_found</code> If the
81         attribute does not exist.<br>
82 </div>
83 <pre><span class="keyword">method</span> <a name="METHODmodify"></a>modify : <code class="type">(<a href="Ldap_types.html#TYPEmodify_optype">Ldap_types.modify_optype</a> * string * string list) list -> unit</code></pre><div class="info">
84 Apply modifications to object in memory, does not change the
85         database until you update using
86         <a href="Ldap_ooclient.ldapcon.html#METHODupdate_entry"><code class="code"><span class="constructor">Ldap_ooclient</span>.ldapcon.update_entry</code></a><br>
87 </div>
88 <pre><span class="keyword">method</span> <a name="METHODprint"></a>print : <code class="type">unit</code></pre><div class="info">
89 <span class="warning">Deprecated.</span>print an ldif like representation of the object to stdout, see
90         Ldif_oo for standards compliant ldif. Usefull for toplevel
91         sessions.<br>
92 </div>
93 <pre><span class="keyword">method</span> <a name="METHODreplace"></a>replace : <code class="type"><a href="Ldap_ooclient.html#TYPEop_lst">op_lst</a> -> unit</code></pre><div class="info">
94 replace values in the object, does not change the database
95     until you call update<br>
96 </div>
97 <pre><span class="keyword">method</span> <a name="METHODset_changetype"></a>set_changetype : <code class="type"><a href="Ldap_ooclient.html#TYPEchangetype">changetype</a> -> unit</code></pre><div class="info">
98 set the changetype of the object<br>
99 </div>
100 <pre><span class="keyword">method</span> <a name="METHODset_dn"></a>set_dn : <code class="type">string -> unit</code></pre><div class="info">
101 set the dn of the object<br>
102 </div>
103 </body></html>