Interface iObjectDesc

Basic information about object that are managed and holded by the fDataProvider inforation about object are passed by method getObjectDesc

interface iObjectDesc {
    extensions?: string[];
    filterTo?: string;
    groups: string;
    icon?: string;
    idFieldName: string;
    module: string;
    name: string;
    o?: iObject;
    path: string;
    type: frmobjectType;
    userAttrs?: iviewAttribute[];
    attribute(attrName): iDataAttribute;
    getOperation(operName, viewOperations?): iObjectOperation;
    prepareObject(listener): void;
}

Properties

extensions? filterTo? groups icon? idFieldName module name o? path type userAttrs?

Methods

attribute getOperation prepareObject

Properties

Optional extensions

extensions?: string[]

Optional list of objects that extends this object sorted

  • Server sorts extensions in right order to use
  • Server send information only about extensions that are valid for client (according to the set module and module options)

Optional filterTo

filterTo?: string

optional definition of the filter used in the link this object. Use only for common objects that are really filtered in the related tables like sysUser etc. Represents tableSQL->filterTo field in the json

groups

groups: string

Optional groups that modules can use for their needs Note: Internally are all groups stored in a single string, but functions operates with them like with and array

Using groups in scripts

Scripts support method g.objIsInGroup:

Example

=g.objIsInGroup(obj.systemObject, 'hasHelp')
   returns true if object has documentation

### Using for enums
Groups are transfered to the objectName enum and can be used for enumLimit

Example

"enumLimit":"='attr.<groupName>'"

### System-defined groups
Some groups are already defined and used by system
* _hasHelp_ - mark, that object has help file with documentation
* _sysUAttrs_ - object supports using user-attributes (marks, flags nad private comment)
* sysTranslations_ - object support translations

Optional icon

icon?: string

Name of the object icon; static icon, never dynamic

idFieldName

idFieldName: string

Name of the ID field name Loaded from json - not available without initialisation

module

module: string

name

name: string

Optional o

o?: iObject

object definitions from json - not loaded from server

  • Original version without changes made by fObjectManager
  • Filled by objectLoader

path

path: string

type

type: frmobjectType

Optional userAttrs

userAttrs?: iviewAttribute[]

list of user-defined object attributes

Methods

attribute

  • attribute(attrName): iDataAttribute

  • Provides object attribute, if available

    • Fails with error, if object is not prepared in advance

    Parameters

    • attrName: string

    Returns iDataAttribute

getOperation

  • getOperation(operName, viewOperations?): iObjectOperation

  • returns operation from the list of operations or undefined iff operation not defined Fill operation from parent, if any -> never search for operation other way than this

    Parameters

    Returns iObjectOperation

prepareObject

  • prepareObject(listener): void

  • Check that object is properly loaded and if not, loads it Always returns information through the listener

    Parameters

    • listener: aListener

    Returns void

Settings

Member Visibility

Theme

On This Page

extensionsfilterTogroupsiconidFieldNamemodulenameopathtypeuserAttrsattributegetOperationprepareObject