Neolane - JavaScript API - v6.1.0

Unknown
SchemaNode

Represents the element of a schema

Methods
findNode Returns an instance of SchemaNode or null if the node doesn't exist and the mustExist parameter is set to false.
Properties
children Returns an object for which each property is a child node indexed by its name.
computeString Returns the string calculated by the current node.
dataPolicy Returns a string of characters which provides the data policy of the current node.
description Returns a string of characters describing the current node.
defaultValue Returns a string of characters which provides the default value of the current node.
editType Returns a string of characters which specifies the editing type of the current node.
enumeration Returns an Enumeration object which is the enumeration linked to the current node or null if there is no enumeration.
enumerationImage Returns the name of the image of the current node in the form of a string of characters.
folderModel Only on the root node, returns a string which contains the folder template(s). On the other nodes, it returns undefined .
image Returns the name of the image in the form of a string of characters.
integrity Returns the link integrity type.
keys Returns a table with definitions of the current node's SchemaKey keys.
hasEnumeration Returns a boolean which indicates whether the value of the current node is linked to an enumeration.
childrenCount Returns a number which specifies the number of child nodes.
hasSQLTable Returns a boolean which indicates whether the current node is linked to an SQL table.
hasUserEnumeration Returns a boolean which indicates whether the value of the current node is linked to a user enumeration.
help Returns the string of help characters.
schema Returns the instance of this node's parent Schema object.
isAdvanced Returns a boolean which indicates whether the current node is advanced or not.
isAnyType Returns a boolean which indicates whether the current node is ordinary.
isAttribute Returns a boolean which indicates whether the current node is an attribute.
isAutoIncrement Returns a boolean which indicates whether the value of the current node is incremented automatically.
isAutoPK Returns a boolean which indicates whether the current node is a primary key.
isBlob Returns a boolean which indicates whether the current node is a BLOB.
isCalculated Returns a boolean which indicates whether the value of the current node is the result of a calculation.
isCDATA Returns a boolean which indicates whether the current node is mapped from CDATA type XML.
isCollection Returns a boolean which indicates whether the current node is a collection of sub-elements and/or attributes.
isDefaultOnDuplicate Returns a boolean. If the value added is vrai , during record deduplication, the default value (defined in defaultValue ) is automatically reapplied during recording.
isElementOnly Returns a boolean which indicates whether the current node is a logical sub-division of the schema.
isExternalJoin True if the node is a link and if the join is external.
isFeature Returns a boolean which indicates whether the node is a feature.
isLink Returns a boolean which indicates whether the node is a link.
isMappedAsXML Returns a boolean which indicates whether the node is an XML mapping.
isMemo Returns a boolean which indicates whether the current node is mapped by a Memo.
isMemoData Returns a boolean which indicates whether the current node is mapped by a MemoData.
isNotNull Returns a boolean which indicates whether or not the current node can take the null value into account.
isRequired Returns a boolean which indicates whether or not the value of the current node is mandatory.
isRoot Returns a boolean which indicates whether the node is the root of the schema.
isSQL Returns a boolean which indicates whether the current node is mapped in SQL.
isTemporaryTable Returns a boolean indicating whether the table is a temporary table. The table will not be created during database creation.
isUnbound Returns a boolean which indicates whether the current node has an unlimited number of children of the same type.
isUser Returns a boolean which indicates whether or not the node is of user-type.
joinParts Returns a table of SchemaNode instances for which each element represents a condition of the join.
label Returns a string of characters which is the description of the current node.
name Returns a string of characters which is the name of the current node.
nodePath Returns a string of characters which is the absolute path of the current node.
parent Returns a SchemaNode object which is the parent object or null if there isn't one.
PKSequence Returns a character string that provides the name of the sequence to use for the primary key.
packageStatus Returns a number that gives the package status.
reverseLink If the element is a link, returns a SchemaNode object which represents a reverse link (via the target schema). If not, the property is not defined.
SQLName The SQL name of the field. The property is an empty string if the object isn't an SQL type field.
SQLTable The SQL name of the table. The property is an empty string if the object isn't the main element or if schema mapping isn't of SQL type.
size The size of the character string type.
tableDefinition An instance of a SchemaNode which is the description of the table containing the current node, null if there isn't one.
target The main element of the link target's schema. If the object isn't a link, the property isn't defined.
type Returns a string of characters which provides the current node's value type.
userEnumeration Returns a string of characters which is the name of the user enumeration used by the current node.
Features
Available in:
  • Content management
  • Delivery properties
  • Typology rule
  • JSSP
  • SOAP Method
  • WebApp
  • Workflow

Table of contents

previous page start next page