Loading ...

OpenWGA 7.0 - TMLScript reference

Object:

HDBModel

Description

This is the basic object for HDBModel operations in TMLScript.

It offers methods to:

  • Perform all basic create/update/delete operations
  • Retrieve HDBModel related information from documents
See HDBModel framework from Concepts and features on details how to use this.
Retrieval Available as TMLScript global "HDBModel" in all model-enabled apps
Allowed in script types
  • WebTML pages and normal WebTML actions
  • Master actions
  • TMLScript tasks in jobs
  • Content type events
Properties and methods
Name Purpose
assignContentID(content, id) Assigns a content ID to the given content
createContent(hdbCreateParams)
createContent(contentClass, refDocument [, customParam])
createContent(tmlForm) 		Creates a new HDBModel content
definition The definition of the HDBModel document hierarchy
deleteContent(hdbDeleteParams)
deleteContent(content) 		Deletes a HDBModel content document
getDocument(id [, parent]) Retrieves a document by its HDBModel id
getID(document) Returns the HDBModel document id of the given document
getRelationSources(targetContent, contentClass, relationName, [, params]) Retrieves all contents pointing with a defined content relation to the given content
getRelationTargets(refContent, contentClass, targetContent [, params]) Retrieves all potential target documents of a given relation
isContent(document) Determines if the given document is a HDBModel content
isStorage(document) Determines if the given document is a HDBModel storage
newCreateContentParams(contentClass, refContent) Creates a HDBModelParams object for creating a HDBModel content document
newDeleteContentParams(content) Creates a HDBModelParams object for deleting a HDBModel content document
newUpdateContentParams(content) Creates a HDBModelParams object for updating a HDBModel content document
setContentEditors(content, contentEditors, childEditors) Sets the allowed editors for a content document
setContentReaders(content, listOfReaders) Sets the allowed readers for a content document
updateContent(hdbParams)
updateContent(content [, updateModule [, customParam]])
updateContent(tmlForm) 		Updates an existing HDBModel content document