OOQL language view

used to show object properties in tabled format


define - create new view definition

  view define AdminName [user AdminName] { View_DefineOption } [overwrite] [force];

clone - duplicate a view and set the properties for the new instance

  view clone AdminName [user AdminName] define AdminName [user AdminName] {View_EditOption}                                      [overwrite] [force];

edit - update the view properties

  view edit AdminName [user AdminName] {View_EditOption} [force];

show - print the view properties

  view show  AdminName [user AdminName] [View_GetOption] [Program_ArgsOption]
                                     [Token_Option] [ExportFile_Option] ;

list - extract views on the base of query filters

  view list AdminPatternList [user AdminName] {Filter_Option} [View_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

select - extract views on the base of query filters

  view select AdminPatternList {Filter_Option} [View_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

undefine - remove a view from the database

  view undefine AdminName [user AdminName] ;


View_DefineOption
description GenericValue
application AdminName
image  FileName
imagedata GenericString
format GenericString
params GenericString
View_ColumnListOption
[! /not] hidden

View_EditOption
name AdminName
description GenericValue
application AdminName
svnrev NUMBER
image  FileName
imagedata GenericString
format GenericString
params GenericString
View_ColumnEditListOption
[! /not] hidden

View_GetOption
get [View_GetBasicOption]
   
  View_GetBasicOption
  { View_GetBasicToken [as IDENTIFIER] { View_GetBasicToken [as IDENTIFIER] } }
  View_GetBasicToken [as IDENTIFIER]
     
    View_GetBasicToken
    Common_GetBasicOption  
    format  
    params  
    user  
    column.seeable [ . View_GetColumnBasicOption ]
    column.modifiable [ . View_GetColumnBasicOption ]
    column [ . View_GetColumnBasicOption ]
    column[] [ . View_GetColumnBasicOption ]
    column[ AdminName ] [ . View_GetColumnBasicOption ]


KEYWORDs
application the associated application menu
column a single column of the view or the full column list
column.modifiable list of editable columns
column.seeable list of visible columns
check.program performs all checks on input fields
description the view description
format defines view styles and properties
force this flag allows to ignore errors during the creation/update (for example, some actors not yet defined)
hidden administration hidden objects are not visible/usable
image local path for the view icon to upload
imagedata base64 code for the view icon
moddate last modification date
moduser last modification user
name the view name
origdate last creation date
overwrite drop the form if exists before to create the new one
params list of parameters used to filter the columns for the context user
user the owner of the view (common views are owned by the ADMIN user)
svnrev SVN repository revision number

view - column


View_ColumnListOption
column AdminName { View_ColumnOption }
                      [ get Object_GetBasicToken ] [ getlink Link_GetBasicToken ]
       
    View_ColumnOption
   
description GenericValue
    label  GenericString
    width   GenericNumber
    format  GenericString
    program Edit_Operator  AdminName event View_ColumnEvent
    access ViewColumn_Access { ViewColumn_Access }
    [! /not] hidden

View_ColumnEditListOption
column  Edit_AddOperator   AdminName { View_ColumnOption }
                      [ get Object_GetBasicToken ] [ getlink Link_GetBasicToken ]
column  change  AdminName { View_ColumnModOption }
                      [ get Object_GetBasicToken ] [ getlink Link_GetBasicToken ]
column  remove  AdminName 
column  Edit_MoveOperator   AdminName 
       
    View_ColumnModOption
   
name AdminName
   
description GenericValue
    label  GenericString
    width   GenericNumber
    format  GenericString
    program Edit_Operator  AdminName event View_ColumnEvent
    access ViewColumn_Access { ViewColumn_Access }
    [! /not] hidden

View_ColumnEvent
seeable
modifiable

ViewColumn_Access
community ViewColumn_AccessOption { , ViewColumn_AccessOption }
user AdminName ViewColumn_AccessOption { , ViewColumn_AccessOption }
team AdminName ViewColumn_AccessOption { , ViewColumn_AccessOption }
assignment AdminName ViewColumn_AccessOption { , ViewColumn_AccessOption }
   
  ViewColumn_AccessOption
  everything  
  nothing  
  [! /not] seeable  
  [! /not] modifiable  

View_GetColumnBasicOption
{ View_GetColumnBasicToken [as IDENTIFIER] { View_GetColumnBasicToken [as IDENTIFIER] } }
View_GetColumnBasicToken [as IDENTIFIER]
   
  View_GetColumnBasicToken
  name  
  description  
  label  
  width  
  format  
  value  
  program  
  program[ View_ColumnEvent ] [. Program_GetBasicOption]
  user [. User_GetBasicOption]
  user[] [. User_GetBasicOption]
  user[ AdminName ]  
  team [. Team_GetBasicOption]
  team[] [. Team_GetBasicOption]
  team[ AdminName ]  
  assignment [. Assignment_GetBasicOption]
  assignment[] [. Assignment_GetBasicOption]
  assignment[ AdminName ]  
  access[ View_ColumnEvent ]  
  hidden  


KEYWORDs
access[ event] check if the current user has access to the specified column condition/event
assignment user roles enabled for column conditions
assignment[name] list of conditions enabled for specific assignment name
community conditions valid to all application users
description the item description
editable check if the column values are generally editable
event defines a column condition associated to a filter program
 modifiable the column values are editable
seeable the column is visible
format defines column styles and properties
hidden set / check the column hidden condition
label the column label
name the column name
program program used to filter columns for a specific condition (or action/event)
team user groups enabled for column conditions
team[ name] list of conditions enabled for specific team name
user specific user enabled for column conditions
user[ name] list of conditions enabled for specific user name
value the field name / the basic name or other property associated to the column
width the column width


SAMPLES


view define VW01 user "name.surname" description "My first view" !hidden
   column C1 description "Column 1" label "COL1" width 102 editable get name
   column C2 description "Column 2" label "COL2" width 20 !editable getlink field[ATTR1] ;

view clone VW01 define VW02 description "General View"
   column addbefore C2 define C3 description "Column 3" label "COL3" width 11 !editable getlink field[ATTR2] ;

view clone VW01 define VW03 user "name.surname" description "My Second view" !hidden
   column addafter C2 define C3 description "Col 3" label "COL3" width 11 editable getlink field[ATTR3] ;

view edit VW03
   column addafter C1 define C5 description "Col. 5" label "COL5" width 22 !editable get field[ATTR5] ;

view edit VW02
   column change C3 get holder
   column change C2 get filetype.file.name ;

view undefine VW03 user "name.surname" ;

common syntax

Common_GetBasicOption
Common_GetBasicToken [ as IDENTIFIER ]

Common_GetBasicToken
id  
name  
origdate  
moddate  
moduser  
description  
svnrev  
hidden  
image  
imagedata  
feature[ AdminName ] [. Feature_GetBasicOption]
feature[] [. Feature_GetBasicOption]
feature [. Feature_GetBasicOption]
application [. Menu_GetBasicOption]
super  
admintype  

Edit_Operator
add
remove

Edit_RefOperator
addbefore AdminName set
addafter AdminName set
add
remove
movebefore
moveafter

Edit_AddOperator
addbefore AdminName define
addafter AdminName define
append

Edit_MoveOperator
movebefore
moveafter

Event_Type
action
check

AdminPatternList
AdminNamePattern {, AdminNamePattern}

AdminNamePattern
*
PATTERNIDENTIFIER
STRINGVAL
AdminName

GenericPatternList
GenericPattern {, GenericPattern}

GenericPattern
*
IDENTIFIER
PATTERNIDENTIFIER
GenericValue

AdminActor
user AdminName
team AdminName
assignment AdminName

AdminName
IDENTIFIER
QUOTED_STRING
SQUOTED_STRING

GenericValue
DATETIME
GenericNumber
GenericString
BOOLEANVAL

GenericString
STRINGVAL
QUOTED_STRING
SQUOTED_STRING

GenericNumber
NUMBER
REALNUMBER

Filter_Option
moddate Date_Range
application AdminNamePattern

Date_Range
=  DATETIME  
!= DATETIME
  
<  DATETIME
  
>  DATETIME
  
<= DATETIME
  
>= DATETIME
  
in [ DATETIME ; DATETIME ]
  
in ( DATETIME ; DATETIME ]
  
in [ DATETIME ; DATETIME )
  
in ( DATETIME ; DATETIME )  

Token_Option
token { Token_Separator { Token_Separator } }
token Token_Separator

Token_Separator
QUOTED_STRING
SQUOTED_STRING
IDENTIFIER
STRINGVAL
xml

ExportFile_Option
exportfile FileName [append] [xml]

ImportFile_Option
importfile FileName [xml / emxxml]

LogFile_Option
logfile FileName [append]

FileName
QUOTED_STRING
SQUOTED_STRING

basic elements
grammar rules
[ ] = optional element - only one item is allowed : ( 0 or 1 )
{ } = optional element - more than one is allowed : ( 0 or N )
/ = alternative
= one of ...
   
  all bold texts represent keywords or command syntax

IDVAL
#<5 dec digits [ 0-9 ]>-<8 hex digits [ 0-9 A-F ]>
  example:
  #00020-34F2A80E

COMMENT
// <any character until the end of the line(\n \r)>
  example:
  // My single line comment

LONGCOMMENT
/* <any character> */
 

example:
  /* My multi line comment starts here
  continue here
  and finish here */

DATETIME
<year 4 digits>[ - /. ]<month 2 digits>[ - /. ]<day 2 digits>
  examples:
   2009-12-23    2009/03/19   2009.11.14
<year 4 digits>[ - /. ]<month 2 digits>[ - /. ]<day 2 digits> <hours>:<minutes>:[<seconds>]
  examples:
   2009-12-23 10:23   2009/03/19 16:03:34  2009.11.14 00:20:04

NUMBER
[+-]<decimal digits [ 0-9 ]>
  examples:
   -1203   +276   25

BOOLEANVAL
true / false

REALNUMBER
[+-]<decimal digits [ 0-9 ]>.<decimal digits [ 0-9 ]>[E(+-)<esponent [0-9]>]
  example:
   -37.837   +2.3874   13.887   1.4862E-04

QUOTED_STRING
"<any character>"
  example:
   "my quoted string"

SQUOTED_STRING
'<any character>'
  example:
   'my single quoted string'

IDENTIFIER
<one o more of [ a-z A-Z ]><zero or more of [ a-z A-Z 0-9 _ ]>
  example:
   Var1    object_Name_02

STRINGVAL
<one or more of [ a-z A-Z 0-9 -_ $ ? @ | ~ % & / = : + \ # ' ]>
  a string not recognized as identifier

PATTERNIDENTIFIER
<a string with * (match 0 or more characters) and ? (match 1 character) wildcards>
  example:
   mypa*er?_ide?ti*

© 2008-2012 Mirko Solazzi | Website Templates by IceTemplates.com
Please Read: Privacy Policy and Terms of Use