spec

You can use the spec script operations in your scriptlets to manipulate and work with specs.

addAttributeToAttrGroup script operation
Adds an attribute to the attribute collection.
addLocalesToAttrGroup script operation
Adds the locales to the Attribute Collection.
addLocalizedNodeToAttrGroup script operation
Associates the given localized node with this attribute collection.
addSpecToAttrGroup script operation
Associates all the nodes of the spec with this attribute collection. If the bDynamic flag is set to true then any additional nodes added to the spec, after the spec has been associated to the Attribute Collection, will become part of the Attribute Collection. If the bDynamic flag is set to false then only the nodes that are currently part of the spec will be added to the Attribute Collection.
addToSpecLocales script operation
Adds the given locales to the list of locales that are defined for the spec.
buildSpecNodeName script operation
Returns the parsed name that was passed in so that it can be used as a spec node name (spec node name only accept letters and characters, others are converted to an underscore _).
deleteAttrGroup script operation
Deletes the given attribute collection.
getAllAttrGroupsForAttribute script operation
Returns an array of attribute collections where the given attribute path is included. Returns null if the given attribute path is not included in any attribute collection.
getAllAttributePathsFromAttrGroup script operation
Returns all the attribute paths associated with this attribute collection.
getAttrGroupByName script operation
Returns the attribute collection with the given name.
getAttrGroupName script operation
Returns the name of this attribute collection.
getAttrGroupType script operation
Returns the type of this attribute collection.
getLocaleNode script operation
Returns the localized node for the supplied locale.
getLocales script operation
Returns the locales associated with the spec.
getLocalesOfAttrGroup script operation
Returns the locales of the Attribute Collection as a single String of comma-separated values.
getNodeAttributeValue script operation
Returns the value of this node's attribute, i.e., MAXLENGTH, MAX_OCCURRENCE, MIN_OCCURRENCE, HELP_URL, TYPE, etc.
getNodeAttributeValues script operation
Returns the values of this node's attributes in a Hash Map, i.e., MAXLENGTH, MIN_OCCURRENCE, STRING_ENUMERATION etc.
getNodeByPath script operation
Returns the node object for the given path in this spec.
getNodeChildren script operation
Returns the children for the node.
getNodeDisplayName script operation
Returns the display name of a locale node. Optionally, if the node is the parent of the locale nodes, pass in the locale for a particular locale node display name. If it is not valid for the node to have a display name, will return null.
getNodeId script operation
Returns the internal ID of this node that corresponds to the value stored in the database.
getNodeLocale script operation
Returns the locale object for this node if it is a locale specific node.
getNodeLookupTableName script operation
Returns the name of the Lookup Table associated with this node, if one exists.
getNodeName script operation
Returns the name of this node.
getNodePath script operation
Returns the path of this node.
getNodeSpec script operation
Returns the spec object for this node.
getPrimaryKeyNode script operation
Returns the primary-key node of this primary spec. If this is not a primary spec, returns null.
getSpecAttribNames script operation
Returns the names of each attribute(node) specified in the spec
getSpecAttribPaths script operation
Returns the names of each attribute(node) specified in the spec.
getSpecByName script operation
Returns the spec object with the corresponding name. By default, a mutable spec is returned. If an immutable spec is needed, then an optional boolean parameter bImmutable is specified to be true. Please note that only mutable specs can be modified.
getSpecMultiOccurAttributePaths script operation
Returns the multi occurrence attribute paths for this spec.
getSpecName script operation
Returns the name of this spec.
getSpecNameList script operation
Returns the names of the Specs that match the given filters. VALID Filters: ("PATTERN", String) ("CONTAINER", Container Object) Will return only specs attached to container ("SPECTYPE", String {"PRIMARY_SPEC", "SECONDARY_SPEC", "LOOKUPTABLE_SPEC", "FILE_SPEC"} comma separated list) ("LOCALIZED", String {YES, NO}) Will return only localized or only non-localized specs
getSpecNodes script operation
Returns a map of node paths to node objects for this spec.
getSpecPrimaryKeyAttributePath script operation
Returns the primary key attribute path for this spec. Returns null if the path is not valid for this spec.
getSpecSequenceAttributePaths script operation
Returns the sequence attribute paths for this spec.
getSpecType script operation
Returns the type of this spec.
getSpecUniqueAttributePaths script operation
Returns the unique attribute paths for this spec.
isLocalized script operation
Returns a boolean to indicate whether or not a spec is localized.
isNodeEditable script operation
Returns true if the node is editable. Returns false otherwise.
isNodeGrouping script operation
Returns true if the node is a grouping node, false otherwise.
isNodeIndexed script operation
Returns true if this node is indexed.
isNodeNonPersisted script operation
Returns true if the node is a non-persisted node, false otherwise.
isNodeSpecRoot script operation
Returns true if the node is a spec root node, false otherwise.
loadSpecFromXML script operation
Creates spec defined in specXML. Can be loaded into different companies .
new$AttrGroup script operation
Returns a new attribute collection with the given name, type and description. Type can only be GENERAL.
removeAttributeFromAttrGroup script operation
Removes the attribute from the attribute collection.
removeFromSpecLocales script operation
Removes the given locales from the list of locales that are defined for the spec.
removeLocalesFromAttrGroup script operation
Removes the locales from the Attribute Collection.
removeSpecFromAttrGroup script operation
Disassociates all the nodes of the spec from this attribute collection.
replaceSpecLocales script operation
Sets the given locales for the spec. Removes any existing locales.
setLocalized script operation
Sets the localized property of a spec.
setNodeEditable script operation
Sets the node to be editable or non-editable according to the boolean argument.
setNodeIndexed script operation
Sets the node to be indexed or not.

Parent topic: List of script operations by module

Parent topic: Script operations

Last updated: 23 October 2014