@flexvertex/flexvertex-driver

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: FlexObject</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: FlexObject</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>FlexObject<span class="signature">(flexSchema<span class="signature-attributes">non-null</span>, className<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h2> <div class="class-description">Represents a FlexVertex FlexObject.</div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="FlexObject"><span class="type-signature"></span>new FlexObject<span class="signature">(flexSchema<span class="signature-attributes">non-null</span>, className<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>flexSchema</code></td> <td class="type"> <span class="param-type"><a href="FlexSchema.html">FlexSchema</a></span> </td> <td class="description last">The FlexSchema this FlexObject belongs</td> </tr> <tr> <td class="name"><code>className</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The name of the class of this FlexObject</td> </tr> </tbody> </table> <dl class="details"> </dl> </div> <h3 class="subsection-title">Classes</h3> <dl> <dt><a href="FlexObject.html">FlexObject</a></dt> <dd></dd> </dl> <h3 class="subsection-title">Members</h3> <h4 class="name" id="attributes"><span class="type-signature"></span>attributes<span class="type-signature"></span></h4> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>attributes</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">Returns this FlexObject's attributes</td> </tr> </tbody> </table> <dl class="details"> </dl> <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"></span></h4> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>className</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Returns the name of this FlexObject's class</td> </tr> </tbody> </table> <dl class="details"> </dl> <h4 class="name" id="objectKey"><span class="type-signature"></span>objectKey<span class="type-signature"></span></h4> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>objectKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Returns this FlexObject's ObjectKey</td> </tr> </tbody> </table> <dl class="details"> </dl> <h4 class="name" id="properties"><span class="type-signature"></span>properties<span class="type-signature"></span></h4> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>properties</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last">Returns this FlexObject's properties</td> </tr> </tbody> </table> <dl class="details"> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="connectFrom"><span class="type-signature"></span>connectFrom<span class="signature">(source<span class="signature-attributes">non-null</span>, options)</span><span class="type-signature"></span></h4> <div class="description"> Creates a <a href="FlexConnection.html">FlexConnection</a> from the source FlexObject to this FlexObject </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>source</code></td> <td class="type"> <span class="param-type"><a href="FlexObject.html">FlexObject</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>class</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">The connection class to use for the <a href="FlexConnection.html">FlexConnection</a></td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">The name to associate with the created connection (cannot be used with toName or fromName)</td> </tr> <tr> <td class="name"><code>toName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">The to name to associate with the created connection (cannot be used with name)</td> </tr> <tr> <td class="name"><code>fromName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">The from name to associate with the created connection (cannot be used with name)</td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> </dl> <h4 class="name" id="connectTo"><span class="type-signature"></span>connectTo<span class="signature">(destination<span class="signature-attributes">non-null</span>, options)</span><span class="type-signature"></span></h4> <div class="description"> Creates a <a href="FlexConnection.html">FlexConnection</a> from this FlexObject to the destination FlexObject </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>destination</code></td> <td class="type"> <span class="param-type"><a href="FlexObject.html">FlexObject</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>class</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">The connection class to use for the <a href="FlexConnection.html">FlexConnection</a></td> </tr> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">The name to associate with the created connection (cannot be used with toName or fromName)</td> </tr> <tr> <td class="name"><code>toName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">The to name to associate with the created connection (cannot be used with name)</td> </tr> <tr> <td class="name"><code>fromName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">The from name to associate with the created connection (cannot be used with name)</td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> </dl> <h4 class="name" id="getProperty"><span class="type-signature"></span>getProperty<span class="signature">(key<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <div class="param-desc"> This FlexObject's property named key if it exists </div> <h4 class="name" id="isNew"><span class="type-signature"></span>isNew<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <dl class="details"> </dl> <h5>Returns:</h5> <div class="param-desc"> True if this FlexObject has no ObjectKey defined yet </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="setProperty"><span class="type-signature"></span>setProperty<span class="signature">(key<span class="signature-attributes">non-null</span>, value<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> → {<a href="FlexObject.html">FlexObject</a>}</span></h4> <div class="description"> Sets a property on this FlexObject </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>key</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <div class="param-desc"> This FlexObject </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="FlexObject.html">FlexObject</a></span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FlexCargo.html">FlexCargo</a></li><li><a href="FlexCommons.html">FlexCommons</a></li><li><a href="FlexConnection.html">FlexConnection</a></li><li><a href="FlexJourney.html">FlexJourney</a></li><li><a href="FlexObject.html">FlexObject</a></li><li><a href="FlexResultSet.html">FlexResultSet</a></li><li><a href="FlexSchema.html">FlexSchema</a></li><li><a href="FlexSegment.html">FlexSegment</a></li><li><a href="FlexSession.html">FlexSession</a></li><li><a href="FlexVertex.html">FlexVertex</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sun Feb 23 2025 20:39:15 GMT-0700 (GMT-07:00) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>