OBEROn - OOQL Language

home

project

documentation

support

applications

downloads

contacts

objectgroup

user facility to collect object instances for generic purpose

define - create new objectgroup

  objectgroup define AdminName [user AdminName] { ObjectGroup_DefineOption } [overwrite] ;

clone - duplicate a objectgroup and set the properties or manage objects for the new instance

  objectgroup clone AdminName [user AdminName] define AdminName [user AdminName]                                     {ObjectGroup_EditOption} [overwrite] ;

edit - update the objectgroup properties or add/remove objects

  objectgroup edit AdminName [user AdminName] {ObjectGroup_EditOption} ;

show - print the objectgroup properties or the collected object list

  objectgroup show AdminName [user AdminName] [ObjectGroup_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

list - extract objectgroups on the base of query filters

  objectgroup list AdminPatternList [user AdminName] {Filter_Option} [ObjectGroup_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

undefine - remove a objectgroup from the database

  objectgroup undefine AdminName [user AdminName] ;

ObjectGroup_DefineOption
	description GenericValue
	application AdminName
	image FileName
	imagedata GenericString
	add ObjectIdName
	query execute AdminName [ user AdminName ]
	query immediate { Query_ExecuteOption }
	objectgroup AdminName [user AdminName]
	[! /not] hidden

ObjectGroup_EditOption
	name AdminName
	description GenericValue
	application AdminName
	image FileName
	imagedata GenericString
	add ObjectIdName
	remove ObjectIdName
	query execute AdminName [ user AdminName ]
	query immediate { Query_DefineOption }
	[! /not] hidden

ObjectGroup_GetOption
	get [ObjectGroup_GetBasicOption]

	ObjectGroup_GetBasicOption
		{ ObjectGroup_GetBasicToken [as IDENTIFIER] { ObjectGroup_GetBasicToken [as IDENTIFIER] } }
		ObjectGroup_GetBasicToken [as IDENTIFIER]

		ObjectGroup_GetBasicToken
			Common_GetBasicOption
			object	[ . Object_GetBasicOption ]
			object[]	[ . Object_GetBasicOption ]

KEYWORDs
	application	the associated application menu
	description	the objectgroup description
	hidden	hidden objectgroups are not visible/usable
	image	local path for the objectgroup icon to upload
	imagedata	base64 code for the objectgroup icon
	moddate	last modification date
	name	the objectgroup name
	object	get the collected object list
	overwrite	drop the form if exists before to create the new one
	objectgroup	add objects from another objectgroup
	query	add objects from a query
	user	the owner of the objectgroup

SAMPLES

objectgroup define "OG01" user User2 description "The Description"
add #00001-00000004 add CL04 'ObjectName' 02 overwrite;

objectgroup define "OG02" user "name.surname" query immediate objdescr d* overwrite ;

objectgroup clone "OG02" user "name.surname" define "OG03" user "name.surname" overwrite ;

objectgroup edit OG01 user User2 description "To Print" add #00001-00000064 add CL04 'Test' 06 ;

objectgroup edit "OG01" user User2 name "OG_01" remove #00001-00000009 remove CL04 'Test' 06 ;

objectgroup show "OG01" user User2;

objectgroup show "OG_01" user User2 get object.{class name id description } token xml ;

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

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: mypaer?_ide?ti