queryods.h

IBM Lotus C++ API 7.0a for IBM Lotus Notes/Domino Directory Release --------- ------------------

#if defined(OS400) && (__OS400_TGTVRM__ >= 510)
#pragma datamodel(P128)
#endif

/*********************************************************************/
/*                                                                   */
/* Licensed Materials - Property of IBM                              */
/*                                                                   */
/* L-GHUS-5VMPGW, L-GHUS-5S3PEE                                      */
/* (C) Copyright IBM Corp. 1995, 2004  All Rights Reserved           */
/*                                                                   */
/* US Government Users Restricted Rights - Use, duplication or       */
/* disclosure restricted by GSA ADP Schedule Contract with           */
/* IBM Corp.                                                         */
/*                                                                   */
/*********************************************************************/



/*	Notes Query On-Disk Structure Definitions
	Record format used in saved queries and actions. */


#ifndef QUERYODS_DEFS
#define QUERYODS_DEFS

#ifndef ODS_DEFS
#include "ods.h"
#endif

/*	Query header structure. The on-disk format for a query consists of
	a query header structures followed by a number of query term
	structures. */

#define QUERY_FLAG_INCLUDEDESCENDANTS	0x00000001	/*	Include all children */

typedef struct
	{
	BSIG Header;
	DWORD dwFlags;						/*	Flags for query */
	} CDQUERYHEADER;

/*	Query Text Term structure. This term represents a simple string
	in the Notes Full Text Search Query Syntax */

#define TEXTTERM_FLAG_RAW		0x00000001	/*	String is a Notes Full Text Search Query String */
#define TEXTTERM_FLAG_VERITY	0x00000002	/*	String is in Verity Syntax */
#define TEXTTERM_FLAG_AND		0x00000004	/*	String is comma-separated list of words; AND assumed */
#define TEXTTERM_FLAG_ACCRUE	0x00000008	/*	String is comma-separated list of words; ACCRUE assumed */
#define TEXTTERM_FLAG_NEAR		0x00000010	/*	String is comma-separated list of words; NEAR assumed */
#define TEXTTERM_FLAG_PLAINTEXT	0x00000020	/*	This object is displayed as plain text */

#define MAXTEXTTERMCOUNT		10

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;						/*	flags for this string */
	DWORD dwLength[MAXTEXTTERMCOUNT];	/*	length of strings */
										/*	strings follow */
	} CDQUERYTEXTTERM;

/*	Query by Field structure. */

#define QUERYBYFIELD_FLAG_BYDATE	0x00000001	/*	Search on modified and created date */
#define QUERYBYFIELD_FLAG_BYAUTHOR	0x00000002	/*	Search by author */

#define QUERYBYFIELD_OP_GREATER			1	/*	Greater than value */
#define QUERYBYFIELD_OP_LESS			2	/*	Less than value */
#define QUERYBYFIELD_OP_NOTEQUAL		3	/*	Not equal to value */
#define QUERYBYFIELD_OP_BETWEEN			4	/*	Between Date1 and Date2 */
#define QUERYBYFIELD_OP_NOTWITHIN		5	/*	Not between Date1 and Date2 */
#define QUERYBYFIELD_OP_EQUAL			6	/*	Equal to value */
#define QUERYBYFIELD_OP_CONTAINS		7	/*	Contains value */
#define QUERYBYFIELD_OP_INTHELAST		8	/*	In the last n days */
#define QUERYBYFIELD_OP_INTHENEXT		9	/*	In the next n days */
#define QUERYBYFIELD_OP_OLDERTHAN		10	/*	Older than n days */
#define QUERYBYFIELD_OP_DUEIN			11	/*	Due more than n days from now */
#define QUERYBYFIELD_OP_DOESNOTCONTAIN	12	/*	Does not contain */

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;				/*	QUERYBYFIELD_FLAG_XXX */
	WORD wDataType;				/*	data type of field to search */
	WORD wOperator;				/*	operation QUERYBYFIELD_OP_???? */
	TIMEDATE Date1;				/*	first operand */
	TIMEDATE Date2;				/*	second operand */
	ALIGNED_NUMBER Number1;			/*	first operand */
	ALIGNED_NUMBER Number2;			/*	second operand */
	WORD wFieldNameLen;			/*	length of field name */
	WORD wValueLen;				/*	length of value */
								/*	field name follows */
								/*	value follows */
	} CDQUERYBYFIELD;

/*	Formula query */

#define QUERYFORMULA_FLAG_PLAINTEXT	0x00000001	/*	Show formula as plain text */

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;				/*	flags */
	WORD wFormulaLen;			/*	Length of formula */
	} CDQUERYFORMULA;


/*	Query by Form */
	
typedef struct
	{
	WSIG Header;
	DWORD dwFlags;
	WORD wFieldCount;			/*	Number of fields that follow */
	WORD wFormNameLen;			/*	Length of form name */

								/*	ODS_ASSISTFIELDSTRUCTs follow */
								/*	Form name follows */
	} CDQUERYBYFORM;

/*	Query by Folder */

#define QUERYBYFOLDER_FLAG_PRIVATE		0x00000001	/*	Folder is private */

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;				/*	Flags */
	WORD wFolderNameLen;		/*	Length of folder name */

								/*	Folder name follows */
	} CDQUERYBYFOLDER;

/*	Query using form */

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;				/*	Flags */

								/*	LIST structure follows */
	} CDQUERYUSESFORM;

/*	Query by Verity Topic */

typedef struct
	{
	WSIG Header;

	DWORD dwFlags;				/*	Flags */
	WORD wTopicQueryLen;		/*	Length of topic query */
	WORD wDataLen;				/*	Length of data */
								/*	Topic query follows */
								/*	Data follows */
	} CDQUERYTOPIC;

/*	Action header structure. The on-disk format for actions consist of
	an action header structure followed by a number of action term
	structures. */

typedef struct
	{
	BSIG Header;
	} CDACTIONHEADER;

/*	Modify Field Action. This action type modifies a single field. */

#define MODIFYFIELD_FLAG_REPLACE	0x00000001	/*	Replace field value */
#define MODIFYFIELD_FLAG_APPEND		0x00000002	/*	Append field value */

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;				/*	flags MODIFYFIELD_FLAG_??? */
	WORD wFieldNameLen;			/*	Length of field name to modify */
	WORD wValueLen;				/*	Length of new value */

								/*	Field name follows */
								/*	Value follows */
	} CDACTIONMODIFYFIELD;

/*	Reply Action. */

#define ACTIONREPLY_FLAG_REPLYTOALL		0x00000001	/*	Reply to all (otherwise, just to sender) */
#define ACTIONREPLY_FLAG_INCLUDEDOC		0x00000002	/*	Include copy of document */
#define ACTIONREPLY_FLAG_SAVEMAIL		0x00000004	/*	Save copy */
#define ACTIONREPLY_FLAG_NOAGENTREPLY	0x00000008	/*	Do not reply to agent-generated mail */
#define ACTIONREPLY_FLAG_REPLYONCE		0x00000010	/*	Only reply once per sender */

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;
	WORD wBodyLen;				/*	Length of body text */

								/*	Body text follows */
	} CDACTIONREPLY;

/*	Formula Action. */

#define ACTIONFORMULA_FLAG_SELECTDOCS	0x00000001	/*	Select documents */
#define ACTIONFORMULA_FLAG_NEWCOPY		0x00000002	/*	Create a new copy before modifying */

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;
	WORD wFormulaLen;			/*	Length of formula */
								/*	Formula follows */
	} CDACTIONFORMULA;

/*	LotusScript */

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;
	DWORD dwScriptLen;			/*	Length of script */
								/*	Script follows */
	} CDACTIONLOTUSSCRIPT;

/*	Send mail */

#define ACTIONSENDMAIL_FIELDCOUNT			5
#define ACTIONSENDMAIL_TOFIELD				0
#define ACTIONSENDMAIL_CCFIELD				1
#define ACTIONSENDMAIL_BCCFIELD				2
#define ACTIONSENDMAIL_SUBJECTFIELD			3
#define ACTIONSENDMAIL_BODYFIELD			4

#define ACTIONSENDMAIL_FLAG_INCLUDEDOC		0x00000001	/*	Include matching document */
#define ACTIONSENDMAIL_FLAG_INCLUDELINK		0x00000002	/*	Include doclink to document */
#define ACTIONSENDMAIL_FLAG_SAVEMAIL		0x00000004	/*	save copy */
#define ACTIONSENDMAIL_FLAG_TOFORMULA		0x00000008	/*	To field is a formula */
#define ACTIONSENDMAIL_FLAG_CCFORMULA		0x00000010	/*	cc field is a formula */
#define ACTIONSENDMAIL_FLAG_BCCFORMULA		0x00000020	/*	bcc field is a formula */
#define ACTIONSENDMAIL_FLAG_SUBJECTFORMULA	0x00000040	/*	Subject field is a formula */

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;				/*	flags */

	/*	Lengths for each of the fields */

	WORD wFieldLen[ACTIONSENDMAIL_FIELDCOUNT];

								/*	To field follows */
								/*	cc field follows */
								/*	bcc field follows */
								/*	Subject field follows */
	} CDACTIONSENDMAIL;

/*	copy */

#define ACTIONDBCOPY_FLAG_MOVE				0x00000001	/*	Remove document from original database */

typedef struct
	{
	WSIG Header;
	DWORD dwFlags;				/*	flags */
	WORD wServerLen;			/*	length of server name */
	WORD wDatabaseLen;			/*	length of database filespec */

								/*	server name follows */
								/*	database filespec follows */
	} CDACTIONDBCOPY;

/*	delete */

typedef struct
	{
	BSIG Header;
	DWORD dwFlags;				/*	flags */
	} CDACTIONDELETE;

/*	Read Marks */