Class: TDocumentStationery

Declaration: BasicDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractDocumentStationery

Inherited By:

None.

Purpose:

The TDocumentStationery class is a partial implementation of a stationery that creates basic documents.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derived classes must override the pure virtual function CreateDocumentState to provide the state for the document.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDocumentStationery::~TDocumentStationery

virtual ~ TDocumentStationery ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentStationery::TDocumentStationery

TDocumentStationery ()
TDocumentStationery ( const TDocumentStationery& );

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called only by derived classes.

Parameters:

Takes no parameters.
const TDocumentStationery & -The stationery to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

TDocumentStationery is an abstract base class--all the constructors are protected. Do not instantiate this class.

Member Function: TDocumentStationery::CreateDocumentState

virtual TDocumentState* CreateDocumentState () =0 ;

Interface Category:

API.

Purpose:

Creates an instance of a document state to be used as the state for documents created by this stationery.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the state to be used for the document.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

This function is pure virtual and must be overridden by derived classes to create the appropriate derived class of TDocumentState for this stationery. This function is protected.

Member Function: TDocumentStationery::CreateDocument

virtual TDocumentReference CreateDocument (const TMultiBinStorageMechanism & theStoreMechanism)
virtual TDocumentReference CreateDocument (TDocumentStore & theStore, TDocument & theDocument)

Interface Category:

API.

Purpose:

Creates a persistent document using the specified storage mechanism.
Creates a persistent document using the store and document object.

Calling Context:

Call this function directly.
Called by CreateDocument(const TMultiBinStorageMechanism&).

Parameters:

const TMultiBinStorageMechanism & theStoreMechanism -The mechanism used to store the document persistently.
TDocumentStore & theStore -The document store used to store the document persistently.
TDocument & theDocument -The document to be stored.

Return Value:

TDocumentReference -A reference to the created document.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.