Documentation for class generic (inherits from generic_view):


Properties:

name type default params representant foreign foreign_prop position
id CO_INTEGER SEQUENCE READONLY=1;HIDDEN=1 0 0
version CO_INTEGER 0 READONLY=1;HIDDEN=1 0 0
deleted CO_INTEGER 0 READONLY=1;HIDDEN=1 0 0

Methods:


method get
permission=1
description: this method retrieves data for given object. Object is identified using par_area, par_class and par_id
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING


method getProp
permission=1
description: This method retrieves value (CO_STRING) of given property for given object. Object is identified using par_area, par_class and par_id; property using prop_name.
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

prop_name
description: Name of prop to retrieve
type CO_STRING


method getChildrenCount
permission=9
description: This method retrieves number (CO_INTEGER) of (non-deleted) children given property for given object. Object is identified using child_class, child_prop and foreign_prop.
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

child_class
description: this is the name of the class of children counted
type CO_STRING

child_prop
description: this is the property name in child class that holds id of parent
type CO_STRING

foreign_prop
description: this is the prop in container (this:) class that holds id to copy to child class
type CO_STRING


method getCatalogWrapper
permission=9
description: This method retrieves id (CO_INDEX) of the catalog wrapper. Requires catalog class name. Returns -1 if not found.
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

catalog_class
description: this is the name of the catalog class
type CO_STRING


method increaseVersion
permission=2
description: Increases version number and sends action with the new version number. Checks whether object is deleted (updates only not deleted; returns -1 otherwise).
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method update
permission=2
description: This method updates one prop of one object. Sends action CO_OP_UPDATE
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

version
description: Version of object to be changed this must be current version in database. If version = -1 than it is not used. Default value is -1.
type CO_INTEGER

par_prop
description: Name of the prop to be updated
type CO_STRING

new_value
description: New value for prop. All values are passed as CO_STRING type!
type CO_STRING


method multiUpdate
permission=2
description: This method updates properties of one object. Sends actions CO_OP_UPDATE
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

version
description: Version of object to be changed this must be current version in database. If version = -1 than it is not used. Default value is -1.
type CO_INTEGER

par_props
description: Name of the properties to be updated
type CO_ARRAY_OF_STRINGS

new_values
description: New values for properties. All values are passed as CO_STRING type!
type CO_ARRAY_OF_STRINGS


method delete
permission=3
description: Sets deleted prop to 1. Sends action CO_OP_DELETE.
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

version
description: Version of object to be changed this must be current version in database. If version = -1 than it is not used. Default value is -1.
type CO_INTEGER


method undelete
permission=4
description: Sets deleted prop to 0. Sends action CO_OP_UNDELETE.
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

version
description: Version of object to be changed this must be current version in database. If version = -1 than it is not used. Default value is -1.
type CO_INTEGER


method insertChild
permission=8
description: this is method for inserting object into container. You can specify class_name of child element
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

child_class
description: this is the name of class tu insert record in
type CO_STRING

child_prop
description: this is the property name in child class that holds id of parent
type CO_STRING

foreign_prop
description: this is the prop in container (this:) class that holds id to copy to child class
type CO_STRING


method getRelatedData
permission=9
description: retrieves data of related class
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

related_class
description: Name of the class to retrieve related data from. Current class (par_class) should be container for related_class
type CO_STRING

related_prop
description: Name of prop in the related class used to form relation
type CO_STRING

dynamic_prop
description: If not null is name of prop where is stored dynamic name of container class
type CO_STRING


method getWithSchema
permission=1
description: Retrieves schema for given class
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callbacks
type CO_ARRAY_OF_STRINGS


method getSchemaRelatedAndData
permission=9
description: Retrieves schema related tables and data for given class element
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callbacks
type CO_ARRAY_OF_STRINGS


method getWithSchemaX
permission=1
description: Retrieves schema for given class
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callbacks
type CO_ARRAY_OF_STRINGS


method getSchemaXRelatedAndData
permission=9
description: Retrieves schema related tables and data for given class element
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callbacks
type CO_ARRAY_OF_STRINGS

deep_level
type CO_INTEGER


method getForRelatedSchemaAndData_old
permission=9
description: Retrieves schema related tables and data for given class element
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

related_class
type CO_STRING

related_prop
type CO_STRING

dynamic_prop
description: If not null is name of prop where is stored dynamic name of container class
type CO_STRING

callbacks
type CO_ARRAY_OF_STRINGS


method getForRelatedSchemaAndData
permission=9
description: Retrieves schema related tables and data for given class element
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

related_class
type CO_STRING

related_prop
type CO_STRING

dynamic_prop
description: If not null is name of prop where is stored dynamic name of container class
type CO_STRING

callbacks
type CO_ARRAY_OF_STRINGS

deep_level
type CO_INTEGER


method showForm
permission=1
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

deep_level
type CO_INTEGER

context_name
description: Name of context in which we execute this form. Now this is the name of additionall menu
type CO_STRING

context1
description: Additionall parameter passed to menu
type CO_STRING

context2
description: Additionall parameter passed to menu
type CO_STRING

context3
description: Additionall parameter passed to menu
type CO_STRING