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 | ||
inherits_acl | CO_INTEGER | 1 | HIDDEN=1;READONLY=1 | 0 | 50 | ||
name | CO_STRING | '' | 1 | 200 | |||
id_catalog_type | CO_INTEGER | 0 | 0 | catalog_type | id | 300 | |
id_item | CO_INTEGER | 0 | 0 | 300 | |||
description | CO_STRING | '' | SIZE=100 | 1 | 200 | ||
id_user | CO_INTEGER | 0 | SIZE=100 | 0 | user | id | 200 |
id_parent | CO_INTEGER | 0 | 0 | catalog | id | 350 |
method cut
description: Deletes objects and puts it into clipboard.
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
method paste
description: Gets objects from clipboard, undeletes it ands puts into current dir.
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
method moveItemByID
description: Moves item to other catalog. NOT IMPLEMENTED YET!
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
new_catalog
description: Id of destination catalog
type CO_INTEGER
method getFullPath
description: Retrieves full path for given object. Path is represented as string similar to file system path /root/sub_catalog1/sub_catalog2/item
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
callback
type CO_STRING
id_root
description: This is left end of the path (local root). If not found, then path is constructed to the catalog that has id_parent==0
type CO_INTEGER
method getTree
description: This method retrieves string with whole tree of objects
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 the prop to be put in tree string
type CO_STRING
deli
description: String used to separate objects taken from one container -- 'leaves'
type CO_STRING
group_deli
description: String used to separate containers -- 'branches'
type CO_STRING
method getParents
description: Retrieves ids of all parents
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
callback
type CO_STRING
id_root
description: This is left end of the path (local root). If not found, then path is constructed to the catalog that has id_parent==0
type CO_INTEGER
method getIdByPath
description: Finds object by path. If not found returns -1.
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
callback
type CO_STRING
id_root
description: This is left end of the path (local root) when we start search.
type CO_INTEGER
path
description: Path, when searched object is p.a: 'catalog/sub_catalog/object_name'
type CO_STRING
method getDocumentTypes
description: Retrieves all document types alowed to be stored in container of current class
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
callback
type CO_STRING
method insertCatalogItem
description: This method inserts object in container. It first creates object in class corresponding to id_type, then creates catalog item and sets relation between both
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
callback
type CO_STRING
name
description: this is the name of the item
type CO_STRING
description
description: this is the description of the item
type CO_STRING
id_type
description: this is the id of the type of the item being created
type CO_INTEGER
create_params
description: this is array of additional parameters that we can pass to target class to create object
type CO_ARRAY_OF_STRINGS
method unfoldCatalog
description: This method retrieves all items in current catalog that current user is allowed to see (__PERMISSION_GET).
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
callback
type CO_STRING
filter_type
description: 0 - all items not deleted, 1 - only containers not deleted, 2 - only deleted items
type CO_INTEGER
sort_prop
description: this is the name of property to sort values
type CO_STRING
method getItemData
description: This method retrieves data for current item with catalog_type name and creator name
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
callback
type CO_STRING
method delete
description: This method is setting deleted flag to 1 in catalog (proxy) object and original object
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
description: This method is setting deleted flag to 0 in catalog (proxy) object and original object
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 purge
description: This method removes catalog object and original object permamently
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 permissionOn
description: This method changes acls for catalog object and original object pointed by catalog
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
callback
type CO_STRING
id_permission
description: this is the id of permission that we wish to set on for current object
type CO_INTEGER
id_role
description: this is the id of the role that we want to grant permission
type CO_INTEGER
method permissionOff
description: This method changes acls for catalog object and original object pointed by catalog
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
callback
type CO_STRING
id_permission
description: this is the id of permission that we wish to set on for current object
type CO_INTEGER
id_role
description: this is the id of the role that we want to grant permission
type CO_INTEGER
method showCatalog
parameters:
par_area
type CO_STRING
par_class
type CO_STRING
par_id
type CO_INTEGER
root_name
description: in this parameter we pass the name of the catalog from which we start browsing
type CO_STRING