OOQL language command

menu item for a web/desktop user interface


define - create new command definition

  command define   AdminName {Command_DefineOption} [force];

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

  command clone  AdminName define AdminName {Command_EditOption} [force];

edit - update the command properties

  command edit   AdminName {Command_EditOption} [force];

show - print the command properties

  command show   AdminName [Command_GetOption] [Program_ArgsOption] [Token_Option]                                      [ExportFile_Option] ;

select - extract commands on the base of query filters

  command select AdminPatternList {Filter_Option} [Command_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

execute - execute the command (when command is executable and Href is a program reference)

  command execute AdminName [Program_ArgsOption] ;

undefine - remove a command from the database

  command undefine AdminName ;



Command_DefineOption
description GenericValue
application AdminName
image  FileName
imagedata GenericString
label GenericValue
href GenericValue
alt GenericValue
program AdminName
execute  AdminActor { AdminActor }
[! /not] executable
[! /not] hidden

Command_EditOption
name AdminName
description GenericValue
application AdminName
svnrev NUMBER
image  FileName
imagedata GenericString
label GenericValue
href GenericValue
alt GenericValue
program AdminName
execute  Edit_Operator   AdminActor { Edit_Operator   AdminActor }
[! /not] executable
[! /not] hidden

Command_GetOption
get [Command_GetBasicOption]
   
  Command_GetBasicOption
  { Command_GetBasicToken [as IDENTIFIER] { Command_GetBasicToken [as IDENTIFIER] } }
  Command_GetBasicToken [as IDENTIFIER]
     
    Command_GetBasicToken
    Common_GetBasicOption  
    label  
    href  
    alt  
    menu [. Menu_GetBasicOption]
    menu[] [. Menu_GetBasicOption]
    menu[ AdminName ]  
    execute  
    executable  
    program [. Program_GetBasicOption]
    access  


KEYWORDs
access check if the framework user has access to execute this command
alt the tooltip text or label
application the associated application menu
description the command description
execute list of actors enabled to execute this command
executable if command is executable you can run the command execute; the href must be set as: <program_name>?<param1>=<par_value1>&<param2>=<par_value2>&...
force this flag allows to ignore errors during the creation/update (for example, some execute actors or the access program not yet defined)
hidden administration hidden objects are not visible/usable
href the command url (hyperlink to jsp page or SWT panel)
image local path for the command icon to upload
imagedata base64 code for the command icon
moddate last modification date
label the command label (usually translated in dictionary)
menu list of menu parent menu(s)
name the command name
program program used to establish the access permission for the current user
svnrev SVN repository revision number


SAMPLES


command define CMD01 description "descCMD1" label "Command1" href "page1.jsp" alt "altval1" execute user User5 team TM1 assignment AS03;

command edit CMD01 description "descCMD2" label "Command2" href "/sub/page2.jsp" alt "altval2" execute add user User3 remove team TM1;

command clone CMD01 define CMD03 description "descCMD3" !hidden label "Search" href "http://www.google.com" alt "altval3" execute add user 'User2' remove user User5;

command edit CMD03 execute remove assignment AS03;

command show CMD03 get { label href alt description name execute access } token "|" ;

command select C*,CMD03 get { label href alt description name execute menu.name } token xml ;


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
json
json-
json+
xml
xml-
xml+

ExportFile_Option
exportfile FileName [append] [xml | json ]

ImportFile_Option
importfile FileName [xml | json |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 or more of [ a-z A-Z ]><zero or more of [ a-z A-Z 0-9 _ ]>
  example:
   Var1    object_Name_02

VARIABLE
$<one o more of [ a-z A-Z 0-9 ]><zero or more of [ a-z A-Z 0-9 _ ]>
 

example:
   $1   $var_02    $1b


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-2014 Mirko Solazzi | Website Templates by IceTemplates.com
Please Read: Privacy Policy and Terms of Use