user or common query for object instances search


define - create new query

  query define   AdminName [user AdminName] { Query_DefineOption } [overwrite] [force];

clone - duplicate a query and set the properties / filters for the new instance

  query clone  AdminName [user AdminName] define AdminName [user AdminName] {Query_EditOption}                                     [overwrite] [force];

edit - update the query properties / filters

  query edit   AdminName [user AdminName] {Query_EditOption} [force];

show - print the query properties or filters

  query show   AdminName [user AdminName] [Query_GetOption] [Token_Option] [ExportFile_Option] ;

list - extract saved queries on the base of some filters

  query list AdminPatternList [user AdminName] {Filter_Option} [Query_GetOption]
                                     [Token_Option] [ExportFile_Option] ;

execute - execute a saved query

  query execute   AdminName [user AdminName] [maxitems NUMBER] [Query_Variables]                                 [Query_SaveToOption] [ Object_GetOption ] [Token_Option] [ExportFile_Option] ;

immediate - execute a query on the fly

  query immediate {Query_ExecuteOption} [maxitems NUMBER] [Query_Variables] [Query_SaveToOption]                                 [ Object_GetOption ] [Token_Option] [ExportFile_Option] ;

count - execute the query and count the result instance number

  query count   AdminName [user AdminName];

  query count immediate {Query_ExecuteOption};

undefine - remove a query from the database

  query undefine AdminName [user AdminName] ;

Query_DefineOption
	description GenericValue
	application AdminName
	image  FileName
	imagedata GenericString
	Query_ExecuteOption
	[! /not] hidden

Query_EditOption
	name AdminName
	description GenericValue
	application AdminName
	image  FileName
	imagedata GenericString
	objclass AdminPatternList
	objname GenericPatternList
	objrevision GenericPatternList
	Query_ExecuteOption
	[! /not] hidden

Query_ExecuteOption
	object AdminPatternList GenericPatternList GenericPatternList
	objdescr  AdminNamePattern
	holder AdminPatternList
	lifecycle AdminPatternList
	stage AdminPatternList
	objectspace AdminPatternList
	filter FilterExpression

Query_Variables
	vars VARIABLE = GenericValue { VARIABLE = GenericValue }

Query_SaveToOption
	objectgroup AdminName [ user AdminName ] [ overwrite ]

Query_GetOption
	get [Query_GetBasicOption]
	Query_GetBasicOption
		{ Query_GetBasicToken [as IDENTIFIER] { Query_GetBasicToken [as IDENTIFIER] } }
		Query_GetBasicToken [as IDENTIFIER]
		Query_GetBasicToken
			Common_GetBasicOption
			user
			objclass
			objname
			objrevision
			objdescr
			lifecycle
			stage
			holder
			objectspace
			filter

KEYWORDs
	application	the associated application menu
	description	the query description
	filter	represents a "where" expression for the OOQL query
	force	this flag allows to ignore errors during the creation/update
	holder	condition to filter the objects on the base of their associated holder
	hidden	hidden queries are not visible/usable
	image	local path for the query icon to upload
	imagedata	base64 code for the query icon
	lifecycle	condition to filter the objects on the base of their current lifecycle
	maxitems	maximum number of returned search results
	moddate	last modification date
	name	the query name
	object	conditions to filter the objects on the base of their class / name / revision
	objtclass	condition to filter the objects on the base of their class
	objdescr	condition to filter the objects on the base of their description
	objectgroup	add search result objects to a objectgroup
	objectspace	condition to filter the objects on the base of the objectspace
	objname	condition to filter the objects on the base of their name
	objrevision	condition to filter the objects on the base of their revision
	overwrite	drop the form if exists before to create the new one
	stage	condition to filter the objects on the base of their current stage
	user	the owner of the saved query
	vars	replace the variables with values in a predefined (saved) query