lnsactio.hpp

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

//===========================================================================
//
//		Class definition for LNSimpleRunFormulaAction
//
//===========================================================================

class LNIMPEXPCL LNSimpleRunFormulaAction : public LNSimpleAction
{
	friend class LNSimpleActions;
	friend class LNSimpleActionsBody;

	public:
		LNSimpleRunFormulaAction (void);
		LNSimpleRunFormulaAction (const LNSimpleRunFormulaAction & other);
		LNSimpleRunFormulaAction (const LNSimpleAction & other);

		~LNSimpleRunFormulaAction (void);

		LNSimpleRunFormulaAction & operator= (const LNSimpleRunFormulaAction & other);

		LNCLASSID		GetClassID (void) const
							{ return (LNCLASSID_LNSIMPLERUNFORMULAACTION); }

		LNBOOL			GetCopyToNewDocument (void) const;

		LNSTATUS		GetFormula (LNFormula * pFormula) const;

		LNBOOL			GetSelectDocuments (void) const;

		LNSTATUS		SetCopyToNewDocument (LNBOOL newFlag);

		LNSTATUS		SetFormula (const LNFormula & newFormula);

		LNSTATUS		SetSelectDocuments (LNBOOL newFlag);

	protected:
		LNSimpleRunFormulaAction (LNSimpleRunFormulaActionBody * pBody);
		virtual LNINT		GetSize (void) const;
		virtual	LNSTATUS	Update (void * pStartPtr, void * * ppEndPtr) const;

	private:
		LNSimpleRunFormulaAction (LNSIMPLEACTIONTYPE type);	// disabled

		void		CreateBody (LNSimpleRunFormulaActionBody * pBody);
		LNSimpleRunFormulaActionBody * GetSimpleRunFormulaActionBody (void) const;
};


//===========================================================================
//
//		Class definition for LNSimpleRunAgentAction
//
//===========================================================================

class LNIMPEXPCL LNSimpleRunAgentAction : public LNSimpleAction
{
	friend class LNSimpleActions;
	friend class LNSimpleActionsBody;

	public:
		LNSimpleRunAgentAction (void);
		LNSimpleRunAgentAction (const LNSimpleRunAgentAction & other);
		LNSimpleRunAgentAction (const LNSimpleAction & other);

		~LNSimpleRunAgentAction (void);

		LNSimpleRunAgentAction & operator= (const LNSimpleRunAgentAction & other);

		LNCLASSID	GetClassID (void) const
							{ return (LNCLASSID_LNSIMPLERUNAGENTACTION); }

		LNString	GetAgentName (void) const;

		LNSTATUS	SetAgentName (const LNString & newAgent);

	protected:
		LNSimpleRunAgentAction (LNSimpleRunAgentActionBody * pBody);
		virtual LNINT		GetSize (void) const;
		virtual	LNSTATUS	Update (void * pStartPtr, void * * ppEndPtr) const;

	private:
		LNSimpleRunAgentAction (LNSIMPLEACTIONTYPE type);	// disabled

		void		CreateBody (LNSimpleRunAgentActionBody * pBody);
		LNSimpleRunAgentActionBody * GetSimpleRunAgentActionBody (void) const;
};


//===========================================================================
//
//		Class definition for LNSimpleSendMailAction
//
//===========================================================================

class LNIMPEXPCL LNSimpleSendMailAction : public LNSimpleAction
{
	friend class LNSimpleActions;
	friend class LNSimpleActionsBody;

	public:
		LNSimpleSendMailAction (void);
		LNSimpleSendMailAction (const LNSimpleSendMailAction & other);
		LNSimpleSendMailAction (const LNSimpleAction & other);

		~LNSimpleSendMailAction (void);

		LNSimpleSendMailAction & operator= (const LNSimpleSendMailAction & other);

		LNCLASSID	GetClassID (void) const
							{ return (LNCLASSID_LNSIMPLESENDMAILACTION); }

		LNSTATUS	GetBCCFormula (LNFormula * pFormula) const;
		LNString	GetBCCString (void) const;

		LNSTATUS	GetCCFormula (LNFormula * pFormula) const;
		LNString	GetCCString (void) const;

		LNBOOL		GetIncludeDoclink (void) const;
		LNBOOL		GetIncludeDocument (void) const;

		LNString	GetMessageBody (void) const;

		LNBOOL		GetSaveMessage (void) const;

		LNSTATUS	GetSubjectFormula (LNFormula * pFormula) const;
		LNString	GetSubjectString (void) const;

		LNSTATUS	GetToFormula (LNFormula * pFormula) const;
		LNString	GetToString (void) const;

		LNBOOL		HasBCCField (void) const;
		LNBOOL		HasCCField (void) const;
		LNBOOL		HasMessageBody (void) const;
		LNBOOL		HasSubjectField (void) const;
		LNBOOL		HasToField (void) const;

		LNBOOL		IsBCCFormula (void) const;
		LNBOOL		IsCCFormula (void) const;
		LNBOOL		IsSubjectFormula (void) const;
		LNBOOL		IsToFormula (void) const;

		LNSTATUS	SetBCCFormula (const LNFormula & newAddress);
		LNSTATUS	SetBCCString (const LNString & newAddress);

		LNSTATUS	SetCCFormula (const LNFormula & newAddress);
		LNSTATUS	SetCCString (const LNString & newAddress);

		LNSTATUS	SetIncludeDoclink (LNBOOL newFlag);
		LNSTATUS	SetIncludeDocument (LNBOOL newFlag);

		LNSTATUS	SetMessageBody (const LNString & newText);

		LNSTATUS	SetSaveMessage (LNBOOL newFlag);

		LNSTATUS	SetSubjectFormula (const LNFormula & newAddress);
		LNSTATUS	SetSubjectString (const LNString & newAddress);

		LNSTATUS	SetToFormula (const LNFormula & newAddress);
		LNSTATUS	SetToString (const LNString & newAddress);

	protected:
		LNSimpleSendMailAction (LNSimpleSendMailActionBody * pBody);
		virtual LNINT		GetSize (void) const;
		virtual	LNSTATUS	Update (void * pStartPtr, void * * ppEndPtr) const;

	private:
		LNSimpleSendMailAction (LNSIMPLEACTIONTYPE type);	// disabled

		void		CreateBody (LNSimpleSendMailActionBody * pBody);
		LNSimpleSendMailActionBody * GetSimpleSendMailActionBody (void) const;
};


//===========================================================================
//
//		Class definition for LNSimpleSendNewsletterAction
//
//===========================================================================

class LNIMPEXPCL LNSimpleSendNewsletterAction : public LNSimpleAction
{
	friend class LNSimpleActions;
	friend class LNSimpleActionsBody;

	public:
		LNSimpleSendNewsletterAction (void);
		LNSimpleSendNewsletterAction (const LNSimpleSendNewsletterAction & other);
		LNSimpleSendNewsletterAction (const LNSimpleAction & other);

		~LNSimpleSendNewsletterAction (void);

		LNSimpleSendNewsletterAction & operator= (const LNSimpleSendNewsletterAction & other);

		LNCLASSID	GetClassID (void) const
							{ return (LNCLASSID_LNSIMPLESENDNEWSLETTERACTION); }

		LNSTATUS	GetBCCFormula (LNFormula * pFormula) const;
		LNString	GetBCCString (void) const;

		LNSTATUS	GetCCFormula (LNFormula * pFormula) const;
		LNString	GetCCString (void) const;

		LNINT		GetGatherCount (void) const;

		LNBOOL		GetIncludeSummary () const;

		LNString	GetMessageBody (void) const;

		LNSTATUS	GetSubjectFormula (LNFormula * pFormula) const;
		LNString	GetSubjectString (void) const;

		LNSTATUS	GetToFormula (LNFormula * pFormula) const;
		LNString	GetToString (void) const;

		LNString	GetViewName (void) const;

		LNBOOL		HasBCCField (void) const;
		LNBOOL		HasCCField (void) const;
		LNBOOL		HasGatherCount (void) const;
		LNBOOL		HasMessageBody (void) const;
		LNBOOL		HasSubjectField (void) const;
		LNBOOL		HasToField (void) const;

		LNBOOL		IsBCCFormula (void) const;
		LNBOOL		IsCCFormula (void) const;
		LNBOOL		IsSubjectFormula (void) const;
		LNBOOL		IsToFormula (void) const;

		LNSTATUS	SetBCCFormula (const LNFormula & newAddress);
		LNSTATUS	SetBCCString (const LNString & newAddress);

		LNSTATUS	SetCCFormula (const LNFormula & newAddress);
		LNSTATUS	SetCCString (const LNString & newAddress);

		LNSTATUS	SetGatherCount (LNINT newCount);

		LNSTATUS	SetIncludeSummary (LNBOOL newFlag);

		LNSTATUS	SetMessageBody (const LNString & newText);

		LNSTATUS	SetSubjectFormula (const LNFormula & newAddress);
		LNSTATUS	SetSubjectString (const LNString & newAddress);

		LNSTATUS	SetToFormula (const LNFormula & newAddress);
		LNSTATUS	SetToString (const LNString & newAddress);

		LNSTATUS	SetViewName (const LNString & newView);

	protected:
		LNSimpleSendNewsletterAction (LNSimpleSendNewsletterActionBody * pBody);
		virtual LNINT		GetSize (void) const;
		virtual	LNSTATUS	Update (void * pStartPtr, void * * ppEndPtr) const;

	private:
		LNSimpleSendNewsletterAction (LNSIMPLEACTIONTYPE type);	// disabled

		void		CreateBody (LNSimpleSendNewsletterActionBody * pBody);
		LNSimpleSendNewsletterActionBody * GetSimpleSendNewsletterActionBody (void) const;
};


//===========================================================================
//
//		Class definition for LNSimpleSendReplyAction
//
//===========================================================================

class LNIMPEXPCL LNSimpleSendReplyAction : public LNSimpleAction
{
	friend class LNSimpleActions;
	friend class LNSimpleActionsBody;

	public:
		LNSimpleSendReplyAction (void);
		LNSimpleSendReplyAction (const LNSimpleSendReplyAction & other);
		LNSimpleSendReplyAction (const LNSimpleAction & other);

		~LNSimpleSendReplyAction (void);

		LNSimpleSendReplyAction & operator= (const LNSimpleSendReplyAction & other);

		LNCLASSID	GetClassID (void) const
							{ return (LNCLASSID_LNSIMPLESENDREPLYACTION); }

		LNString	GetMessageBody (void) const;
		
		LNBOOL		GetIncludeDocument (void) const;
		LNBOOL		GetReplyOnce (void) const;
		LNBOOL		GetReplyToAgents (void) const;
		LNBOOL		GetReplyToAll (void) const;
		LNBOOL		GetSaveMessage (void) const;

		LNBOOL		HasMessageBody (void) const;

		LNSTATUS	SetIncludeDocument (LNBOOL newFlag);
		LNSTATUS	SetReplyOnce (LNBOOL newFlag);
		LNSTATUS	SetReplyToAgents (LNBOOL newFlag);
		LNSTATUS	SetReplyToAll (LNBOOL newFlag);
		LNSTATUS	SetSaveMessage (LNBOOL newFlag);

		LNSTATUS	SetMessageBody (const LNString & newText);

	protected:
		LNSimpleSendReplyAction (LNSimpleSendReplyActionBody * pBody);
		virtual LNINT		GetSize (void) const;
		virtual	LNSTATUS	Update (void * pStartPtr, void * * ppEndPtr) const;

	private:
		LNSimpleSendReplyAction (LNSIMPLEACTIONTYPE type);	// disabled

		void		CreateBody (LNSimpleSendReplyActionBody * pBody);
		LNSimpleSendReplyActionBody * GetSimpleSendReplyActionBody (void) const;
};


#endif