lndb.hpp

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

	LNSTATUS GetPage( NOTEHANDLE handle, LNPage *Page )
		{ return GetNote(handle, (LNNote *) Page); }
	
	LNSTATUS GetPages( LNPageArray *pages );

	//profiles
	LNSTATUS DeleteProfileDocument(const LNString &name, const LNString &owner="");
	LNSTATUS DeleteCalendarProfileDocument(const LNString &owner );
	LNSTATUS GetProfileDocuments(const LNString &name, LNProfileDocumentArray *docs);
	LNSTATUS OpenCalendarProfileDocument(const LNString &owner, LNCalendarProfileDocument *profile);
	LNSTATUS OpenProfileDocument (const LNString &name, const LNString &owner, LNProfileDocument *profile);


	LNBOOL ScriptLibraryExists( const LNString &ScriptLibraryname, 
		const LNSCRIPTLIBRARYTYPE scriptlibrarytype = LNSCRIPTLIBRARYTYPE_UNKNOWN ) const;

	LNSTATUS CreateScriptLibrary( const LNString &ScriptLibraryname, 
		const LNSCRIPTLIBRARYTYPE scriptlibrarytype, 
		LNScriptLibrary *newScriptLibrary = 0);
	LNSTATUS CreateScriptLibrary( LNScriptLibrary &ScriptLibrary, LNScriptLibrary *newScriptLibrary = 0);

	LNSTATUS DeleteScriptLibrary( const LNString &ScriptLibraryname, 
		const LNSCRIPTLIBRARYTYPE scriptlibrarytype );
	LNSTATUS DeleteScriptLibrary( LNScriptLibrary *ScriptLibrary );

	LNSTATUS GetScriptLibrary( const LNString &ScriptLibraryname, 
		const LNSCRIPTLIBRARYTYPE scriptlibrarytype,
		LNScriptLibrary *ScriptLibrary );
	LNSTATUS GetScriptLibrary( const char *ScriptLibraryname, 
		const LNSCRIPTLIBRARYTYPE ScriptLibraryType,
		LNScriptLibrary *ScriptLibrary )
		{ return GetScriptLibrary(LNString(ScriptLibraryname), 
											ScriptLibraryType, 
											ScriptLibrary); }
	LNSTATUS GetScriptLibrary( const NOTEID idnote, LNScriptLibrary *ScriptLibrary );
	LNSTATUS GetScriptLibrary( const UNID *unidnote, LNScriptLibrary *ScriptLibrary );
	LNSTATUS GetScriptLibrary( NOTEHANDLE handle, LNScriptLibrary *ScriptLibrary )
		{ return GetNote(handle, (LNNote *) ScriptLibrary); }
	
	LNSTATUS GetScriptLibraries( LNScriptLibraryArray *ScriptLibraries, 
		const LNSCRIPTLIBRARYTYPE scriptlibrarytype = LNSCRIPTLIBRARYTYPE_UNKNOWN);

#if defined XML_TOOLKIT	|| defined IRIS_BUILD
	LNBOOL SharedActionsExist() const;
#endif
	LNSTATUS CreateSharedActions( const LNActions &actions, LNNote *newSharedActionsNote = 0);
	LNSTATUS CreateSharedActions( LNNote &sharedActionsNote, LNNote *newsharedActionsNote = 0);
	LNSTATUS GetSharedActions(LNNote *sharedActionsNote);

	LNBOOL SharedFieldExists( const LNString &sharedfieldname ) const;

	LNSTATUS CreateSharedField( const LNFormField &field, LNSharedField *sharedfield = 0);
	LNSTATUS CreateSharedField( const LNString &name, LNRTTYPE fieldtype, LNSharedField *sharedfield = 0);
	LNSTATUS CreateSharedField( LNSharedField &sharedfield, LNSharedField *newsharedfield = 0);

	LNSTATUS GetSharedField( const LNString &sharedfieldname, LNSharedField *sharedfield); 
	LNSTATUS GetSharedFields( LNSharedFieldArray *array );

	LNSTATUS DeleteSharedField( const LNString &sharedfieldname);
	LNSTATUS DeleteSharedField( LNSharedField *sharedfield);

	LNBOOL SubformExists( const LNString &subformname ) const;

	LNSTATUS CreateSubform( const LNString &subformname, LNSubform *subform = 0);
	LNSTATUS CreateSubform( LNSubform &subform, LNSubform *newSubform = 0);

	LNSTATUS GetSubform( const LNString &subformname, LNSubform *subform);
	LNSTATUS GetSubforms( LNSubformArray *array );

	LNSTATUS DeleteSubform( const LNString &subformname);
	LNSTATUS DeleteSubform( LNSubform *subform);
	
	LNSTATUS CreateNote( LNNOTETYPE notetype, LNNote *newnote );
	LNSTATUS CreateNote( LNNote &note, LNNote *newnote = 0 );
	
	LNSTATUS CreateEncryptedNote	// here for backwards compatiblity
		( LNNote &note, LNNote *newnote, LNENCRYPTOPTION option )
		{ return CreateEncryptedNote(note, option, newnote); }	
	LNSTATUS CreateEncryptedNote( LNNote &note, LNNote *newnote = 0 )
		{ return CreateEncryptedNote(note, LNENCRYPTOPTION_PUBLIC, newnote); }	
	LNSTATUS CreateEncryptedNote
		( LNNote &note, LNENCRYPTOPTION option, LNNote *newnote = 0 );
	LNSTATUS CreateEncryptedNote
		( LNNote &note, const LNString &keyname, LNNote *newnote = 0);
	LNSTATUS CreateEncryptedNote
		( LNNote &note, const LNText &keynames, LNNote *newnote = 0);

	LNSTATUS DeleteNote( LNNote *note );
        LNSTATUS DeleteNote( LNNote *note, LNNOTEDELETEFLAGS option );
	LNSTATUS DeleteNote( NOTEID id );
        LNSTATUS DeleteNote( NOTEID id, LNNOTEDELETEFLAGS option  );

	LNSTATUS DeleteNotes( const LNNoteArray &notes );

	LNSTATUS GetNote( const NOTEID idnote, LNNote *note );
	LNSTATUS GetNote( const UNID *unidnote, LNNote *note );
	LNSTATUS GetNote( NOTEHANDLE handle, LNNote *note );

	LNSTATUS GetNotes( LNNoteArray *notes );
	
	LNSTATUS CreateFolder( const LNString &name, LNViewFolder *newfolder = 0 );
	LNSTATUS CreateFolder
		( const LNString &name, LNVFSHARINGOPTION sharing,
		  LNViewFolder *newfolder = 0 );
	LNSTATUS CreateFolder
		( const LNString &name, LNVFSHARINGOPTION sharing,
		  const LNViewFolder &templt, LNViewFolder *newfolder = 0 );

	LNSTATUS CreateView( const LNString &name, LNViewFolder *newview = 0 );
	LNSTATUS CreateView
		( const LNString &name, LNVFSHARINGOPTION sharing,
		  LNViewFolder *newview = 0 );
	LNSTATUS CreateView
		( const LNString &name, LNVFSHARINGOPTION sharing,
		  const LNViewFolder &templt, LNViewFolder *newview = 0 );

	LNSTATUS CreateViewFolder
		( const LNString &name, LNViewFolder &oldviewfolder,
		  LNViewFolder *newviewfolder = 0 );

	LNSTATUS DeleteViewFolder( const LNString &viewname );
	LNSTATUS DeleteViewFolder( LNViewFolder *view );
	
	LNSTATUS GetDefaultViewFolder( LNViewFolder *view ) const;

	LNSTATUS GetViewFolder( const LNString &viewname, LNViewFolder *view );
	LNSTATUS GetViewFolder( const char *viewname, LNViewFolder *view )
		{ return GetViewFolder(LNString(viewname), view); }
	LNSTATUS GetViewFolder( const NOTEID idnote, LNViewFolder *view );
	LNSTATUS GetViewFolder( const UNID *unidnote, LNViewFolder *view );
	LNSTATUS GetViewFolder( NOTEHANDLE handle, LNViewFolder *view )
		{ return GetNote(handle, (LNNote *) view); }
	LNSTATUS GetFolders( LNViewFolderArray *folders, LNBOOL getPrivate = TRUE );
	LNSTATUS GetViews( LNViewFolderArray *views, LNBOOL getPrivate = TRUE );
	LNSTATUS GetViewFolders( LNViewFolderArray *viewfolders, LNBOOL getPrivate = TRUE );
	
	LNSTATUS MoveFolder( const LNString &source, const LNString &dest ) const;
	LNSTATUS MoveFolder
		( const LNViewFolder &source, const LNViewFolder &dest ) const;
	
	LNBOOL ViewFolderExists( const LNString &viewname ) const;
	
	LNSTATUS CreateFTIndex( LNFTINDEXFLAGS options = LNFTINDEXFLAGS_DEFAULT,
		const LNString &stopfile = "", LNFTIndexStatistics *stats = 0 );
		
	LNSTATUS DeleteFTIndex();
	
	LNSTATUS GetFTIndexFlags( LNFTINDEXFLAGS *options );
	
	LNSTATUS GetLastFTIndexed( LNDatetime *lastindex );
	
	LNBOOL IsFTIndexed();
	
	LNSTATUS FTSearch( const LNString &query, LNDocumentArray *results ) const;

	LNSTATUS FTSearch
		( const LNString &query, LNDocumentArray *results,
		  const LNFTSearchOptions &options ) const;

	LNSTATUS FTSearch
		( const LNString &query, LNDocumentArray *results,
		  const LNFTSearchOptions &options, const LNNoteArray &input ) const;
	
	LNSTATUS GetModifiedNotes
		( const LNString &start, LNNoteArray *notes, LNDatetime *end = 0 ) const
		{
			return GetModifiedNotes(LNDatetime(start), notes,
									LNNOTETYPE_DOCUMENT, end);
		}

	LNSTATUS GetModifiedNotes
		( const LNDatetime &start, LNNoteArray *notes, LNDatetime *end = 0 ) const
		{ return GetModifiedNotes(start, notes, LNNOTETYPE_DOCUMENT, end); }

	LNSTATUS GetModifiedNotes
		( const LNString &start, LNNoteArray *notes, LNNOTETYPE type,
		  LNDatetime *end = 0 ) const
		{ return GetModifiedNotes(LNDatetime(start), notes, type, end); }

	LNSTATUS GetModifiedNotes
		( const LNDatetime &start, LNNoteArray *notes, LNNOTETYPE type,
		  LNDatetime *end = 0 ) const;

	LNSTATUS Search( const LNFormula &formula, LNNoteArray *results,
		LNSearchOptions *options=0 );
		
	LNSTATUS UpdateFTIndex( LNFTIndexStatistics *stats = 0 );
	
	LNSTATUS GetUnreadList( LNNoteArray *unread, LNBOOL create = FALSE ) const;
	LNSTATUS GetUnreadList
		( LNNoteArray *unread, const LNString &username,
		  LNBOOL create = FALSE ) const;

	LNSTATUS SetUnreadList
		( LNNoteArray *unread, LNNoteArray *oldunread = 0,
		  LNBOOL flush = FALSE ) const;
	LNSTATUS SetUnreadList
		( LNNoteArray *unread, LNNoteArray *oldunread, const LNString &username,
		  LNBOOL flush = FALSE ) const;
	
	LNSTATUS UpdateUnreadList( LNNoteArray *unread ) const;

	LNSTATUS Close();
	
	LNSTATUS CreateAboutDatabaseDocument( LNDocument *newdoc );
	LNSTATUS CreateAboutDatabaseDocument( LNDocument &policydoc,
		LNDocument *newdoc = 0 );
	
	LNSTATUS CreateIcon( LNNote *newicon );
	LNSTATUS CreateIcon( LNNote &icon, LNNote *newicon = 0 );
	
	LNSTATUS CreateUsingDatabaseDocument( LNDocument *newdoc );
	LNSTATUS CreateUsingDatabaseDocument( LNDocument &helpdoc,
		LNDocument *newdoc = 0 );
	
	LNSTATUS GetAboutDatabaseDocument( LNDocument *policy );

	LNSTATUS GetACL( LNACL *acl );
	
	virtual LNCLASSID GetClassID() const {return LNCLASSID_LNDATABASE;}
	
	LNDatetime GetCreated();

	LNText GetDatabaseCatalogCategories();
	
	DBHANDLE GetDatabaseHandle( LNBOOL keep_object = FALSE );
	
	TIMEDATE * GetDatabaseID();
	
	LNDBOPENFLAGS GetDatabaseOpenFlags() const;
	
	LNDatetime GetDataLastModified();
	
	LNDatetime GetDesignLastModified();
	
	LNBOOL GetDisableBackgroundAgents();
	
	LNBOOL GetDisableReplication();
	
	LNBOOL GetNeverReplicate();

	LNString GetFilename() const;
	
	LNString GetFilepath() const;
	
	LNBOOL GetHideDesign();
	
	LNSTATUS GetIcon( LNNote *icon );
	
	LNString GetInheritsFromTemplateName();
	
	LNDatetime GetLastModified();
	
	LNBOOL GetListInDatabaseCatalog();
	
	LNString GetOwnerName() const;

	LNNUMBER GetPercentageUsed();
	
	LNString GetPort() const;
	
	LNINT GetRemoveOldDocumentsDays();
	
	LNBOOL GetRemoveOldDocuments();
	
	TIMEDATE * GetReplicaID();
	
	LNBOOL GetReplicateReceiveSummaries();
	
	LNBOOL GetReplicateSendDeletions();
	
	LNBOOL GetReplicateSendTitleAndCatalogInfo();

	LNDatetime GetReplicationCutoffDatetime ();

	LNREPLICATIONPRIORITY GetReplicationPriority();
	
	LNString GetServer() const;

	LNBOOL GetShowInOpenDatabaseDialog();
	
	LNINT GetSize();
	
	LNString GetTemplateName();
	
	LNString GetTitle();
	
	LNDBTYPE GetType();
	
	LNSTATUS GetUsingDatabaseDocument( LNDocument *helpdoc );
	
	LNBOOL IsLocal() const { return !IsRemote(); }

	LNBOOL IsOpen() const;
	
	LNBOOL IsRemote() const;

	LNSTATUS Open();
	
	LNSTATUS Open( LNDBOPENFLAGS flags, const LNString &username = "");

	LNSTATUS SetDatabaseCatalogCategories( const LNText &txtcategories );
	
	LNSTATUS SetDisableBackgroundAgents( LNBOOL flag );
	
	LNSTATUS SetDisableReplication( LNBOOL flag );
	
	LNSTATUS SetNeverReplicate( LNBOOL flag );

	LNSTATUS SetHideDesign( LNBOOL flag );
	
	LNSTATUS SetInheritsFromTemplateName( const LNString &name );
	
	LNSTATUS SetListInDatabaseCatalog( LNBOOL flag );
		
	LNSTATUS SetOwnerName(const LNString &name);

	LNSTATUS SetRemoveOldDocumentsDays( LNINT olddocdays );
	
	LNSTATUS SetRemoveOldDocuments( LNBOOL flag );

	LNSTATUS SetReplicaID( const TIMEDATE & newID );
	
	LNSTATUS SetReplicateReceiveSummaries( LNBOOL flag );
	
	LNSTATUS SetReplicateSendDeletions( LNBOOL flag );
	
	LNSTATUS SetReplicateSendTitleAndCatalogInfo( LNBOOL flag );

	LNSTATUS SetReplicationCutoffDatetime ( const LNDatetime & newCutoff );

	LNSTATUS SetReplicationPriority( LNREPLICATIONPRIORITY reppriority );
	
	LNSTATUS SetShowInOpenDatabaseDialog( LNBOOL flag );
	
	LNSTATUS SetTemplateName( const LNString &name );

	LNSTATUS SetTitle( const LNString &title );
	
private:

	LNDatabase & operator=( LNDatabaseBody *datab );

	LNSTATUS CreateDatabaseBody( LNNotesSession *session,
		const LNString &filename, const LNString &server );
	
	LNSTATUS DeleteFormXYZ( const LNString &formname );
	LNSTATUS DeleteFormXYZ( LNForm *form );

	LNDatabaseBody * GetDatabaseBody() const {return (LNDatabaseBody *)Body;}
	
	LNSTATUS GetFormXYZ( const LNString &formname, LNForm *form );
	LNSTATUS GetFormXYZ( const NOTEID idnote, LNForm *form );
	LNSTATUS GetFormXYZ( const UNID *unidnote, LNForm *form );
};	


#ifndef LNNOTE_HPP
#include "lnnote.hpp"
#endif

#ifndef LNPROFILE_HPP
#include "lnprofil.hpp"
#endif

	
#endif	//LNDB_HPP