stdnames.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. 1989, 2005  All Rights Reserved           */
/*                                                                   */
/* US Government Users Restricted Rights - Use, duplication or       */
/* disclosure restricted by GSA ADP Schedule Contract with           */
/* IBM Corp.                                                         */
/*                                                                   */
/*********************************************************************/


#ifndef STD_NAME_DEFS
#define STD_NAME_DEFS

#ifdef __cplusplus
extern "C" {
#endif

/*	Standard NSF Field Name/Value Definitions for the Notes product */

/* Very global field names */

#define	FIELD_TITLE "$TITLE"
#define	FIELD_FORM	"Form"
#define FIELD_TYPE_TYPE	"Type"
#define	FIELD_LINK	"$REF"
#define	FIELD_UPDATED_BY "$UpdatedBy"
#define FIELD_NAMELIST "$NameList"
#define FIELD_NAMED 	"$Name"
#define	FIELD_URL		"URL"				/* used when copying link to clipboard */
#define	FIELD_UNAME		"$UName"			/* Universal UNID/Name */
#define	FIELD_CREATED	"$Created"			/* Created date, if specified overrides UNID created date for @Created */
#define FIELD_NAVIGATE_URL	"$NavigateToURL"/* used to pass a URL to an embedded web browser control */ 
#define FIELD_RELOAD_REFRESH "$ReloadRefresh"/* used to pass reload/refresh info to embedded web browser control */ 
#define	DESIGN_CLASS "$Class"
#define	DESIGN_MODIFIED "$Modified"
#define	DESIGN_COMMENT FILTER_COMMENT_ITEM
#define	DESIGN_READERS "$Readers"			/* Text list of users allowed to read note */
#define FIELD_ANONYMOUS "$Anonymous"		/* Indicates an anonymous document. */
#define	DESIGN_UPDATERS "$Updaters"			/* Text list of users allowed to update the folder note */
#define FIELD_NOPURGE 	"$NoPurge"			/* Note should never be purged. */
#define	DESIGN_RETAIN_FIELDS "$RetainFields"	/* Text list of fields to retain in a
													design refresh */
#define FIELD_ORIG_SIZE	"$OrigSize"			/* Size of entire note.  Set for
												abstracted note to give user
												info on whether they want to
												download the whole message or
												not. */
#define	FIELD_LANGUAGE "$LANGUAGE"			/* Used to specify the language of the note */
#define FIELD_VIEWLOCALE "$VIEWCOLLATION"
#define FIELD_BASE_TEMPLATE_VERSION "$TemplateBuild"
#define FIELD_BASE_TEMPLATE_NAME "$TemplateBuildName"
#define FIELD_BASE_TEMPLATE_DATE "$TemplateBuildDate"
#define FIELD_NO_SOFT_DELETE "$NoSoftDelete" /* Override soft delete on a per-note basis */
#define FIELD_HIDEINFO "$HideInfo" /* If present in design element, its design is hidden and this item contains the mod time before hiding. */

/* Public Access definitions */
#define FIELD_PUBLICROLE 	"$P"			/* Reader List role name for public users */
#define FIELD_PUBLICACCESS 	"$PublicAccess"	/* Note has public access if ACL_FLAG_PUBLICREADER is set. */
#define FORM_FIELD_PUBLICACCESS 	"$FormPublicAccess"	/* Form Note has public access if ACL_FLAG_PUBLICREADER is set. */
#define	FIELD_PUBLICACCESS_ENABLED	'1'

#define FIELD_LOGVIEWUPDATES 	"$LogViewUpdates"	/* NIF will log all incremental view updates */
#define	FIELD_LOGVIEWUPDATES_ENABLED	'1'

/* Pseudo item names (don't exist in Notes) recognized by NAMELookup */

#define ITEM_NOTEID			"$$NoteID"			/* a NAMELookup item to be returned */
#define ITEM_DBNAME			"$$DBName"			/* address book this entry was found in */
#define ITEM_DBINDEX		"$$DBIndex"			/* 1-based db index upon primary NAB and ABs listed in MAB */
#define ITEM_MODIFIEDTIME	"$$ModifiedTime"	/* TIMEDATE this entry was last modified */
#define ITEM_DOMAINTYPE		"$$DomainType"		/* either NOTES or LDAP */
#define ITEM_UNID			"$$UNID"			/* a NAMELookup item to be returned */
#define ITEM_READERLIST		"$$Readers"			/* Return the readers list */
#define ITEM_NOTESDN		"$$NotesDN"			/* A notes style distinquished name,
												   only returned from LDAP address books */
#define ITEM_ORIGINAL_LDAP_DN "$$OriginalLDAPDN" /* Original LDAP DN (non-normalized) */

#define ITEM_LTPAUSERNAME	"$$LTPAUsername"	/* The name that should be used (in preference
													to the DN) to build an LTPA token for 
													single sign on support.	*/

						


/* field definitions for Data Connection Resources */
	
#define FIELD_DCR_CLASS			"$DCRClass"		/* e.g. RDBMS, ERP */
#define FIELD_DCR_GEN_PROPS	"$DCRGenProps"	/* generic connector properties */
#define FIELD_DCR_CUS_PROPS	"$DCRCusProps" /* custom connector properties  */
#define FIELD_DCR_CUS_DESCS	"$DCRCusDescs" /* descriptors for custom props */
#define DCR_METADATA_RECORD	"$DCRMetadata" /* NSFSearch item id for summary buffer */
#define DCR_METADATA_SEARCH	"$DCRCatalog"	/* Special id used as NSFSearch trigger */	

/* define order of generic properties in FIELD_DCR_GEN_PROPS */
#define DCR_GPROP_TYPE			0
#define DCR_GPROP_SERVER		1
#define DCR_GPROP_DATABASE		2
#define DCR_GPROP_USERNAME		3
#define DCR_GPROP_PASSWORD		4
#define DCR_GPROP_MD_OWNER		5 
#define DCR_GPROP_MD_NAME		6
#define DCR_GPROP_CONNECTIONS	7
#define DCR_GPROP_FLAGS			8
#define DCR_GPROP_OPEN_PROC	9
#define DCR_GPROP_UPDATE_PROC	10
#define DCR_GPROP_CREATE_PROC	11
#define DCR_GPROP_DELETE_PROC	12
#define DCR_GPROP_LAST DCR_GPROP_DELETE_PROC

/* Flag definitions for Data Connection Resources: misc properties */
#define DCR_FLAG_TABLE		'T'
#define DCR_FLAG_VIEW		'V'
#define DCR_FLAG_PROC		'P'
#define DCR_FLAG_UPDATE_CHANGED_FIELDS    'u'
#define DCR_FLAG_BLOCK_KEY_FIELD_UPDATES  'b'	
#define DCR_FLAG_CONFLICT_DETECTION       'c'
#define DCR_FLAG_FIELD_DECS_ERRORS        'e'
#define DCR_FLAG_DISABLE_HTTP_CACHING     'h'
#define DCR_FLAG_IGNORE_MISSING_RECORD    'i'	/* On missing record */
#define DCR_FLAG_CREATE_EXTERNAL_RECORD   'x'
#define DCR_FLAG_TRUNCATE_PRECISION       'p'	/* On data conflict */
#define DCR_FLAG_TRUNCATE_DATA            'd'
#define DCR_FLAG_TRIM_ALL_FIELDS          'a'	/* Space trimming */
#define DCR_FLAG_TRIM_NON_KEY_FIELDS      'k'

	
/*	Define Private note field name, and define the known types */

#define FIELD_PRIVATE_TYPE 	"$Private"

#define	FIELD_PRIVATE_TYPE_QUERY	'q'
#define	FIELD_PRIVATE_TYPE_AGENT	'a'
#define	FIELD_PRIVATE_TYPE_VIEW		'v'
#define	FIELD_PRIVATE_TYPE_FOLDER	'f'

/*	The following items are inserted into a note which cannot be saved to its
	Some special named notes. These values are stored in the FIELD_NAMED item to
	identify a named note. */

#define NAMEDNOTE_PRIVATEDESIGN		"$PrivateDesign"
#define NAMEDNOTE_PROFILE			"$Profile"
#define NAMEDNOTE_IMAP_DELETED_ENTRY "$IMAPResyncDE"
#define NAMEDNOTE_POP_DELETED_ENTRY "$PopDE"


/* 	The following definitions of for the public directory profile note */
#define NAMEDNOTE_PUBLICDIRECTORYPROFILE	"directoryprofile"
#define LEDNAME_ITEM						"LedName"
#define TRUST_DIRCAT_ITEM					"TrustDircat"
#define DIRECTORY_DOMAIN_ITEM				"Domain" 
#define SECURE_INETPASSWORDS_ITEM 			"SecureInetPasswords" 
#define ADMIN_LDAPSERVER_ITEM				"AdminLDAPServer"

/*	The following items are inserted into a note which cannot be saved to its
	original database due to network failure.  When the failure can be
	remedied, the note is read back into memory and fixed up to point
	to correct database.  At that point the items are removed. */

#define PENDINGNAME					"NOTEPEND"
#define PENDINGSAVE_LINK_ITEM		"$ORIGLINK"
#define PENDINGSAVE_FILENAME_ITEM	"$ORIGFILE"

/*	Designer minimum version */
/*	"minimum version" means "you need at least this version to safely save 
	this design element." */

#define DESIGNER_VERSION			"$DesignerVersion"

#define DESIGNER_MIN_VERSION_5		"5"
#define DESIGNER_MIN_VERSION_6		"6"
#define DESIGNER_MIN_VERSION_6_5	"6.5"
#define DESIGNER_MIN_VERSION_7		"7"
#define DESIGNER_MIN_VERSION_8		"8"
#define DESIGNER_MIN_VERSION_9		"9"
#define DESIGNER_MIN_VERSION_10		"A"

/*	Design flags */

#define	DESIGN_FLAGS "$Flags"

/*	Please keep these flags in alphabetic order (based on the flag itself) so that
	we can easily tell which flags to use next. Note that some of these flags apply
	to a particular NOTE_CLASS; others apply to all design elements. The comments
	indicate which is which. In theory, flags that apply to two different NOTE_CLASSes
	could overlap, but for now, try to make each flag unique. */

#define DESIGN_FLAG_ADD					'A'	/*	FORM: Indicates that a subform is in the add subform list */
#define DESIGN_FLAG_ANTIFOLDER			'a'	/*	VIEW: Indicates that a view is an antifolder view */
#define	DESIGN_FLAG_BACKGROUND_FILTER 	'B'	/*	FILTER: Indicates FILTER_TYPE_BACKGROUND is asserted */
#define	DESIGN_FLAG_INITBYDESIGNONLY	'b'	/*	VIEW: Indicates view can be initially built only by designer and above */
#define DESIGN_FLAG_NO_COMPOSE 			'C'	/*	FORM: Indicates a form that is used only for */
											/*		query by form (not on compose menu). */
#define DESIGN_FLAG_CALENDAR_VIEW		'c'	/*	VIEW: Indicates a form is a calendar style view. */
#define DESIGN_FLAG_NO_QUERY 			'D'	/* 	FORM: Indicates a form that should not be used in query by form */
#define DESIGN_FLAG_DEFAULT_DESIGN 		'd'	/* 	ALL: Indicates the default design note for it's class (used for VIEW) */
#define	DESIGN_FLAG_MAIL_FILTER 		'E'	/*	FILTER: Indicates FILTER_TYPE_MAIL is asserted */
#define DESIGN_FLAG_PUBLICANTIFOLDER	'e'	/*	VIEW: Indicates that a view is a public antifolder view */
#define DESIGN_FLAG_FOLDER_VIEW			'F'	/*	VIEW: This is a V4 folder view. */
#define DESIGN_FLAG_V4AGENT 			'f'	/*	FILTER: This is a V4 agent */
#define DESIGN_FLAG_VIEWMAP 			'G'	/*	VIEW: This is ViewMap/GraphicView/Navigator */
#define DESIGN_FLAG_FILE				'g'	/*  FORM: file design element */
#define DESIGN_FLAG_OTHER_DLG			'H'	/*	ALL: Indicates a form that is placed in Other... dialog */
#define DESIGN_FLAG_JAVASCRIPT_LIBRARY  'h' /*  Javascript library. */
#define DESIGN_FLAG_V4PASTE_AGENT		'I'	/*	FILTER: This is a V4 paste agent */
#define DESIGN_FLAG_IMAGE_RESOURCE		'i'	/*	FORM: Note is a shared image resource */
#define DESIGN_FLAG_JAVA_AGENT   		'J' /*  FILTER: If its Java */
#define DESIGN_FLAG_JAVA_AGENT_WITH_SOURCE 'j' /* FILTER: If it is a java agent with java source code. */