DumontEXE 0.0.1
Public Slots | Public Member Functions
cmcConnectionDef Class Reference

Connection Definition. More...

#include <cmcConnectionDef.h>

Inheritance diagram for cmcConnectionDef:

List of all members.

Public Slots

QString conName ()
 Return the 'Connection Name' of the connection.
QString pairedName ()
 Return the Paired connection Name.
QString toCategory ()
 Return the target Category of this connection.
cmcCategoryDeftoCategoryDef ()
 Return a pointer back to the target Category definition.

Public Member Functions

 cmcConnectionDef (const cmcConnectionDef &copy)
 Copy Constructor.
virtual ~cmcConnectionDef ()
 Primary Destructor.

Detailed Description

Connection Definition.

Definition at line 41 of file cmcConnectionDef.h.


Constructor & Destructor Documentation

Copy Constructor.

Definition at line 37 of file cmcConnectionDef.cpp.

~cmcConnectionDef ( ) [virtual]

Primary Destructor.

This destructor handles cleanup of the object.

Definition at line 76 of file cmcConnectionDef.cpp.


Member Function Documentation

QString conName ( ) [slot]

Return the 'Connection Name' of the connection.

This is an enhanced function that returns the 'connection name' portion of the connection. The Connection Name portion is that first part of the connection name that distinguishes one connection from another. This function is not normally provided by Commence so it is stored locally so as to be available for use in other operations.

vbScript Example:
 Sub Form_onEnterField(FieldName)
   '
   ' This test for the connection name...
   '
   if( dfrm.Connection(FieldName).conName = "pRD" ) then
     msgbox "Read Connection of some sort"
   end if' 

   '
   ' ...is the same as this test.
   '
   if( dfrm.Connection(FieldName).definition.name = "pRD" ) then
     msgbox "Read Connection of some sort"
   end if' 
See also:
name, toCategory

Definition at line 101 of file cmcConnectionDef.cpp.

QString pairedName ( ) [slot]

Return the Paired connection Name.

This handy function requires an entry in the databaseDef.xml to define this reverse connection since is it not available from the API directly. The content is as follows:

Connection Definition Extension (exerpt)
  <connectionDefs>
    <connectionDef name="in->Court">
      <pairedName>for->Matters</pairedName>
      <limit1>0</limit1>
      <comment>This connection designates the court for this matter</comment>
    </connectionDef>
  </connectionDefs>
QString toCategory ( ) [slot]

Return the target Category of this connection.

This is a pass-through function provided natively by Commence. Commence does provide this value, but it is also cached here locally so that the number of requests into the Commence API are reduced.

vbScript Example:
 dim cursor: set cursor = dfrm.DB.GetCursor( 0, oxConn.toCategory, 0 )
See also:
name, conName

Definition at line 96 of file cmcConnectionDef.cpp.

cmcCategoryDef * toCategoryDef ( ) [slot]

Return a pointer back to the target Category definition.

This method returns object of the target category definition of the Connection. If this connection is "Relates to Company" then fetching this object would return the category definition for "Company". From there, all the regular properties of that category definition are available.

Definition at line 91 of file cmcConnectionDef.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties




~ ~ ~ ~ ~ ~
Source Code without Comments is like a Cranberry Garland
without the berries. Comment your Code!
 
Commence Database User Support Group Forum
http://newsgroup.showoff-db.org/
~ ~ ~ ~ ~ ~
Author: Mark Petryk
Lorimark Solutions, LLC
mark@lorimarksolutions.com