TeamShare API

TeamShare API

Reference Guide

Last updated: 02 May 2001

Dear Customer,

This document describes TeamShare’s database schema and Application Programming Interface (API) for TeamTrack.

With TeamTrack 4.0, we have opened our API to our customers to be used to safely modify TeamTrack databases. Through the database you can extend TeamTrack functionality to meet your company needs. Using the schema is a great means to read and report on information collected through TeamTrack that is not readily available through standard reporting. While this document is available upon customer request, we recommend using the schema only to report on data that is not easily accessible via TeamTrack. Modifications to the database should only be performed using the TeamTrack administrator or our Application Programming Interface (API).

Database

The TeamTrack database is stored in an underlying relational database. This document describes the tables, columns, and relationships of the database. This information should be used cautiously. Please note, TeamShare Customer Support does not support backend modifications. Additionally, changes, deletions and modifications performed directly to the database are not recommended as TeamShare reserves the right to modify the schema when necessary to implement new features. Hence changes made directly to the database may not be upward compatible. If a new table or column is added in a future version, any code written to a prior version will not have knowledge of the new tables or columns, and thus may not perform correctly.

Through TeamTrack, important information is captured in the database. Companies may have unique needs to gather, organize and analyze this data. While keeping in mind the schema may change with new releases of the product, it is safe to use this information to read and display data from the database. For example, you may wish to write a custom report that processes issues in a special way or you may want to capture time metrics (historical data) using the TS_CHANGES table. This document will aid you in creating reports of this nature and more.

Application Programming Interface (API)

TeamShare recommends performing database modifications through the Administrator or by creating an application which uses the API. Alterations that can not be done through the Administrator should be performed through the API. TeamShare makes best efforts to ensure upward compatibility should database changes be performed in this manner. The API is available to all TeamTrack customers.

The TeamShare API is written in C++. Using the API, modification to the database can now be done safely. Applications can be written to this API, which import and export data between TeamShare applications and other application programs. C++ programming experience is required to create an application using this class library. Please note, TeamShare does not support the API through its standard Customer Support contract. API support will be available in time-blocks through our Professional Services Group (PSG). PSG staffs expert C++ developers who are available to support and/or develop these applications to meet your needs. Should assistance be required in creating or understanding API classes, please contact your sales executive.

For more information about securing PSG services to support and/or develop API applications to meet your needs, contact your TeamShare account manager.

Thank you,

TeamShare, Inc.

TeamShare API
Overview

The TeamShare API is a collection of C++ source files that can be used to build a Windows DLL or a Linux library file. This library allows a client program to connect to the teamtrack server and query or update data in the database. The client program can run on the same computer as the teamtrack server or on any computer that has network access to the server.

Getting Started

Using the TeamShare API consists of the following steps.

With the API source code and a C++ compiler, build the library — TSApiWin32.dll, TSApi.dll or TSApi.lib.
Build the Sample API programs to test the API and verify its operation
Using the API’s C++ header files and the class descriptions in the remainder of this document, build a C++ program that connects to the teamtrack engine to query or update the database according to your needs.

The API and sample programs should compile on Windows 95, 98, NT, 2000 and Linux. For Windows platforms, we supply workspace and project files for MS Developers Studio. For Linux, we supply a basic makefile.

All the following directions are written for users of MSVC++ 6.0. If you are using some other development environment, you will need to use the menu commands appropriate for that tool.

Building the API and Sample Programs

The easiest way to do this is to load the workspace file samples.dsw and rebuild all. Use Build->Batch Build->Rebuild All from the menu. This will build the debug and release versions of the sample programs and the API DLLs. These binaries will all be put in the directories …\Build\Debug and …\Build\Release.

Now you can run each of the samples and get a feeling for how they operate. It may be a good idea to run against a sample database rather than your production system until you are accustomed to how the API operates. You can choose which server the sample programs connect to when you run them.

Note Concerning Developer Studio 97: In order to build the sample programs under Dev Studio 97, the preprocessor definition _DEV_STUDIO_5 will need to be added to each sample program's project settings as well. In addition, you should expect compiler warnings in Debug mode using Dev Studio 97.

Note Concerning User Privileges: The ability to connect to the server via the API is controlled on a per-user basis. By default, users do not have the privilege to connect using the API turned on. You will need to use ttAdmin to set this privilege for the appropriate users.

Building Your Own Custom Program Using the TeamShare API

This task requires significant skill in C++ programming and it is far beyond the scope of this document to provide detailed instructions. The following instructions will help get you started.

Preprocessor Symbols

_DEV_STUDIO_5
If using Microsoft Dev Studio 97 (Visual C++ 5.0), you will need to add this preprocessor definition to your project.
TS_USE_MFC
The API assumes no dependencies on the MFC CSocket class. In order to use MFC, define a preprocessor directive in the Project Settings called TS_USE_MFC. This definition directs the API to use the MFC CSocket class. If there is no definition, a generic CSocket class will be used. If using Linux or Unix, there is no definition necessary.

If you are developing on Windows but not using MFC, it is not necessary to define any preprocessor directives. In this case, TS_USE_WINSOCK is defined and Windows Sockets is used. (Refer to TSSocket.h for the source code.)

Reference Guide

The TeamShare Application Programming Interface (hereafter API) can be used as an alternative means of manipulating data found in the TeamTrack database. It can be used to import or export data between TeamTrack and other application API programs, to add issues, incidents, users, groups, companies, contacts, projects, folders, and fields, or simply to move folders and projects around in the hierarchy. It can also be used to verify and establish privileges, mass transition issues or incidents, to verify data or develop custom reporting. In addition, the API provides a means to communicate or share data between applications. The API can be used to create an application that updates TeamTrack data with data from other applications.

The API is a C++ class library. C++ programming knowledge is required to create an application using this library. Note: TeamShare does not support the API through the standard Technical Support contract. Should assistance be required in creating or understanding API classes, please contact your sales representative.

Class synopsis
Classes the API Programmer will use on a regular basis:

TSServer	Representation of the TeamTrack server in the API program
TSRecord	A generic representation of a single record from any table in the TeamTrack database
TSRecordList	List of TSRecord objects.
TSTreeList	List of TSRecord objects in hierarchical order.
TSField	Represents a single field of a record. This generic field object will contain either a text string, an integer or a double depending on the datatype of the field.
TSFieldList	List of TSField objects.
TSPosition	Pointer to a position in a list. Used for iterating through a list of records or fields.
TSString	Class to manage a text string, perform comparisons, concatenations etc.
TSSchema	Schema for record.
TSRecordRef	Class can be instantiated directly or through derived classes in order to retrieve the name of an item.
TSProject	Class to provide sFullProjectName which contains a tab-delimited ( ^i ) string representing the full project hierarchy.
TSTransition	Class describes a transition.
TSItem	Class defines the base interface for both primary and auxiliary items.
TSAuxiliaryItem	Class defines the interface for an item that has variable fields and is not a Primary Item.
TSPrimaryItem	Class defines a primary item.
TSDisplayField	Class describes fields as they are displayed.
TSItemLink	Class describes item links.
TSAttachment	Class describes a file, URL, or a note attachment.
TSChangeHistory	Class describes the change history for a record.

Additional classes the typical API Programmer shouldn’t ever need to use:

TSObject	Abstract base class for any object to be put on a TSList
TSList	Base class for all list classes.
TSSocket	Object to send a receive data on a TCP/IP socket.
CSocket	Base class for the TSSocket class. Depending on whether you are writing your API program on UNIX or Windows this will either be the MFC CSocket class or TeamShare’s own CSocket class.
TSIntObject	Class to manage integers.
TSIntList	List of integer objects.

TSServer is the main interface used to communicate with a webserver hosting a TeamTrack database. It is the primary entry class to TeamTrack. Methods called in TSServer build a string with the name of the method and any parameters needed for that method. This string is then sent across the socket to the web server. The API application then issues a Receive and waits for data to come back. The web server parses the string and calls the appropriate method in TeamTrack’s source code. Once the request has been processed, data is sent back across the socket. The data is received and processed on the API side.

The other exposed classes are supporting classes. This document outlines all available classes, member functions and variables. Sample programs can be found in the TeamShare directory under API/samples. Individual or all the sample applications can be built using the Samples.dsw project workspace.

The sample programs are:

ConsolidateFields
Syntax: ConsolidateFields

This is a windows application which uses MFC classes. This program is used to combine two fields of the same type into one of the fields. For example, if there are two numeric fields, one that is used often and one that is rarely used, this program can be used to move the data from the field that is rarely used into the other field. The first field could then be used for something else. This program demonstrates the use of a dialog box for authenticating the user and obtaining input. The user will be prompted to select the appropriate table which has fields defined which the user wishes to consolidate. The user will also be prompted to select which field is the destination and which field is the source for the consolidation.

DeletedItemsReport
Syntax: DeletedItemsReport

Lists the issues or incidents that have been deleted, when, and by which user. Demonstrates the use of command prompts to obtain authentication for running the program.

GetTableId
Syntax: GetTableId

Prompts the user to enter the database name of a table and returns the numeric Id of the table.

ListGroupMembers
Syntax: ListGroupMembers

Lists the names of all the members of a specific group. Demonstrates use of command prompts to obtain the parameters for the program.

ListGroups
Syntax: ListGroups

Lists all group names defined in the database. Demonstrates using command prompts to obtain authentication for running the program.

ListPrivs
Syntax: ListPrivs

Lists the privileges for either a user or a group. Demonstrates using command prompts to obtain the parameters for the program. Privileges are not broken down by project.

ReadListWithWhere
Syntax: ReadListWithWhere <server_name><login_id> <password> <table_id> "where clause" (w/o the word "where")

Reads all the records from a specified table based on the WHERE clause passed. The user does not need to type the word "WHERE".

ReadRecord
Syntax: ReadRecord <server_name> <login_id> <password> <table_id> <record_id> <optional_field_type>

Reads a particular record from a table for a specified ID and displays the data on the screen.

ReadRecordMFC
Syntax: ReadRecordMFC /h | <server_name> <login_id> <password> <table_id> <record_id>

Reads a particular record from a table for a specified ID and displays the data on the screen. Demonstrates how to use the MFC CSocket class to connect to the webserver.

ReadUser
Syntax: ReadUser <server_name> <login_id> <password> <user_name>

Reads a record from the TS_USERS table and displays the data to the screen. This user is required to type all parameters after the program name.

ReadWithWhere

Syntax: ReadWithWhere

Reads the records from the specified table based on the WHERE clause passed. The user does not need to type the word "WHERE". This sample demonstrates the use of command prompts to obtain the parameters for the program.

ShowAvailableTables

This is a windows program that lists the names of the tables defined in the database. All tableids are defined in TSDef.h using the naming convention: TS_TBLID_tablename. "Tablename" would be capitalized. For example, to reference the tableid for the TS_CONTACTS table, use TS_TBLID_CONTACTS. This sample demonstrates the use of dialog to obtain authentication for running the program and displaying information.

SubmitIssue
Syntax: SubmitIssue

Submits either an Issue or an Incident. This sample demonstrates the use of command prompts to obtain the parameters for the program. It is important to note that any fields can be skipped if the user does not wish to enter a value. If the field is required, the user will be re-prompted for the value. Multi-select fields are listed as data type "string" and need to be entered with the appropriate corresponding selection ids strung together. For example: 98, 99, 101.

TransitionIssue
Syntax: TransitionIssue

Transitions an Issue or an Incident record. This sample demonstrates the use of command prompts to obtain the parameters for the program. Note: The Transition Name parameter is case-sensitive.

Update
Syntax: Update

Updates an item in the database. Demonstrates the use of command prompts to obtain authentication for running the program and for indicating which table record to update and the record’s new field values.

Getting Started

A TeamTrack login id and password are required to establish a connection with the TeamTrack database across a socket. In order to run API programs on a machine other than the webserver, the login id and password must correspond to a user who has also been granted the privilege to "Connect using the API". This is a new system privilege in version 4.0 of TeamTrack.

Steps to Building a Simple API Application Program

Create a connection to the TeamTrack web server using the TSServer class

TSServer teamtrack;

teamtrack.Connect("admin","password","teamtrack_host");

Create a record or record list that will be used to send or receive data from TeamTrack.

TSRecordList statesList;

If sending a record to TeamTrack using a function such as AddRecord, fill in the data values

Use the SetString(), SetInt() and SetDouble() methods of the TSRecord class to set the values of the fields that aren’t going to be empty in the record.
Refer to the TeamTrack database schema to determine whether a field is an integer or a string.
The datatype of each field in the record is stored within the record so it is possible to retrieve it to verify the correct datatype before calling SetString(), SetInt() or SetDouble().

TSRecord user(TS_TBLID_USERS, &teamtrack);

Teamtrack.ReadRecord(&user, 5);

user.SetString("email","chris_tester@teamshare.com");

Call a method of the TSServer object to perform the desired action, such as ReadRecord() or AddRecord(). Check it’s return value to determine success or failure of the operation.

All of the methods of the TSServer class return TS_OK when successful or, some error code such as TS_CONNECT_ERROR when the TSServer was unable to connect to the TeamTrack web server. (Refer to TSDef.h for error codes)

if(teamtrack.ReadAllRecords(&statesList, TS_TBLID_STATES) != TS_OK)

{

printf("Error reading from states table\n");

return 1;

}

Platform Dependencies
TS_USE_MFC

The API assumes no dependencies on the MFC CSocket class. In order to use MFC, define a preprocessor directive in the Project Settings called TS_USE_MFC. This definition directs the API to use the MFC CSocket class. If there is no definition, a generic CSocket class will be used. If using Linux or Unix, there is no definition necessary.

If the user is on Windows but not using MFC, it is not necessary to define any preprocessor directives. In this case, TS_USE_WINSOCK is defined and Windows Sockets is used. (Refer to TSSocket.h for the source code.)

Table Dependencies

To enforce the referential integrity between tables in the database, it is helpful to be knowledgeable about the relationships.

TS_TABLES — This table holds the last id value that was used for every table in the database. Any time a record is added to a table, the TS_LASTID column corresponding to that table needs to get incremented. The id values for every table are defined as constants in TSDef.h.

Reading data from tables

The majority of tables can be read using a generic read function, such as ReadAllRecords. This function has the added overhead of carrying any supporting lists of data that relate to the record being read. For example, if reading the list of Users, the supporting Membership and Privilege information is also read and added to the returning recordlist.

The Cases and Incidents tables are special.

Both TS_CASES and TS_INCIDENTS have only a few true fields (for example, id, parentid, tempid, etc.). Reading data from these tables requires thought. Fields are defined for a Workflow and the Workflow is associated with a Project. In addition, each project can override the field definition of the workflow. To read or write Issues or Incidents requires determining what project that issue belongs to, then which fields are valid for that project by which workflow is associated to it, then determining how fields have been affected by overrides.

The TSTreeList class is provided to facilitate reading data from tables that are recursive, for example, Projects, Workflows, Incidents, Folders, etc. It inherits from TSRecordList and should be used instead of TSRecordList when reading from these tables. To know which field is the sublist of a tree item, use the schema type called TS_SCHEMATYPE_TREELIST. It’s like a TS_SCHEMATYPE_LIST in every way except the field that has this schematype is the field that contains the sublist.

Table Schemas

There are certain tables that contain a few non-database columns in addition to their physical database columns. These non-database columns are built programmatically to prevent the user from have to issue a separate read for the information. They are helpful for coding purposed because they contain information related to the records in the table. For example, the schema for the Groups table contains database columns of ID, NAME, STATUS, ACCESSTYPE, and TYPE. It also contains non-database columns of MEMBERLIST and PRIVILEGES, which are lists of the members belonging to the group and the privileges attributed, respectively.

Helpful schema information (the fieldname is in bold):

Folders table

TREELIST(CFolder, 0, subfolders, DATATYPE_OBLISTEX)

Groups table

LIST(CGroup, 0, memberList, DATATYPE_OBLISTEX)

LIST(CGroup, 0, privileges, DATATYPE_OBLISTEX)

Notifications table

LIST(CNotification, 0, subscribers, DATATYPE_OBLISTEX)

Projects table

TREELIST(CProject, 0, subprojects, DATATYPE_OBLISTEX)

Selections table

LIST(CSelection, 0, projSelections, DATATYPE_OBLISTEX)

States table

LIST(CState, 0, transtriggerstates, DATATYPE_OBLISTEX)

Transitions table

LIST(CTransition, 0, properties, DATATYPE_OBLISTEX)

LIST(CTransition, 0, issueTypes, DATATYPE_OBLISTEX)

LIST(CTransition, 0, projectTransitions, DATATYPE_OBLISTEX)

LIST(CTransition, 0, transtriggers, DATATYPE_OBLISTEX)

Users table

LIST(CUser, 0, memberList, DATATYPE_OBLISTEX)

LIST(CUser, 0, privileges, DATATYPE_OBLISTEX)

Workflows table

TREELIST(CWorkflow, 0, subworkflows, DATATYPE_OBLISTEX)

How can the API be used?

The TeamShare API can be used for a variety of tasks. The following list of tasks corresponds directly to the individual methods defined in the TSServer class. Any of the methods can be used in combination to accomplish larger tasks.

Method	Description

AddField	Use to add a custom field to the following tables: Cases, Companies, Contacts, Incidents, Merchandise, Problems, Products, Resolutions, and Service Agreements
AddRecord	Add a new record to any table (i.e. new issues, incidents, users, groups, projects, folders, companies, contacts, establish privileges, create reports, etc.
BuildFieldList	Obtain a list of fields defined for any given table.
DeleteRecord	Delete any record from any table
GetConnectionInfo	Obtain information about the database connection
GetDbInfo	Obtain information about the database (i.e. version number, etc.)
GetInt	Obtain the numeric value of a column in any table
GetLastErrorMessage	Obtain the last error that occurred
GetSchema	Obtain the table schema for any table
GetString	Obtain the string value of any column in any table
GetSubmitTransition	Obtain the id value for the submit transition
HasPrivilege	Verify a user’s privileges
MoveFolder	Move a folder to a new place in the hierarchy
MoveProject	Move a project to a new place in the hierarchy
ReadAllRecords	Obtain all the records from any table
ReadAttachmentList	Obtain a list of the attachments to a given item
ReadChangeList	Obtain a list of changes made to any issue or incident. It’s possible to order the changes from newest to oldest. The default order is oldest to newest.
ReadFolderItems	Obtain a list of the items currently in a given folder
ReadFolderList	Obtain a list of folders defined for a given user
ReadProjectSelectionList	Obtain a list of selections for a given project
ReadProjectTransitionList	Obtain a list of transitions available for a given project
ReadPropertyList	Obtain a list of property records for a given transition
ReadRecord	Obtain one record from any table
ReadRecordForId	Obtain a record based on a given id value
ReadRecordListWithWhere	Obtain a list of records from a given table based on a set of conditions
ReadRecordWithWhere	Obtain one record from a given table based on a set of conditions
ReadReport	Obtain a report based on the name
ReadReportList	Obtain a list of reports available to a given user based on their privileges
ReadSelectionList	Obtain a list of selection values defined for a given field and that are available to a given project
ReadStateList	Obtain a list of states that are available to a given project
ReadTransitionList	Obtain a list of transitions and the fields they use / that are available
ReadUserDefinedFields	Obtain a list of the user-defined fields for a given table
ReadUserListForPrivilege	Obtain privilege information for a given user
ReadUserSelectionList	Obtain a list of selection field values available to a given user for a given project

Method	Description

ReadVCActions	Obtain a list of Version Control activity for a given issue
ReadVCActionsForModule	Obtain a list of Version Control activity for a given user
SetExitUrl	Sets the exit URL string stored in the SystemInfo table
Submit	Submit a new Issue or Incident to the database
Transition	Transition an existing Issue or Incident
UpdateList	Update a list of records for a given table; could be used to mass transition issues or incidents, or for importing a list of users instead of individually creating them
UpdateRecord	Update a single record in a table.
ValidateUser	Validate the login id for a given user, returns TRUE if the login id and password are valid
ValidateVersion	Validate the version of API against the version of TeamTrack installed on the webserver for compatibility

TSAPI objects / classes —
API Object Hierarchy ~

TSObject

|_____ TSField

|_____ TSRecord

|_____ TSSchema

|_____ TSString

|_____ TSIntObject

TSList

|_____ TSFieldList

|_____ TSRecordList

|_____ TSTreeList

|_____ TSIntList

TSPosition

TSServer

CSocket (MFC)

|_____ TSSocket

TSRecordRef

|_____ TSProject

|_____ TSTransition

|_____ TSItem

|_____ TSAuxiliaryItem

|_____ TSPrimaryItem

|_____ TSDisplayField

|_____ TSItemLink

|_____ TSAttachment

|_____ TSChangeHistory

TSAPI Object Definition
TSAuxiliaryItem

This class is a derivative of TSItem and defines the interface for an object that has variable fields and is not a primary item.

Methods

TSAuxiliaryItem( TSServer& server, int nTableId = 0, int nItemId = 0 )

Constructor method; initializes the auxiliary item.

TSAuxiliaryItem( const TSAuxiliaryItem& that )

Copy constructor method.

TSAuxiliaryItem& operator = ( const TSAuxiliaryItem& that )

Assignment operator.

virtual ~TSAuxiliaryItem()

Destructor method; destroys the object.

virtual int StartUpdate( bool bLockFlag = true )

The StartUpdate method should be used to fill in this item as appropriate for an update. Populates the item and orders fields, as they would be for an update, including filling out field selection lists. The three other member lists of a TSItem, changeList, attachmentList and linkList, will not be updated. The bLockFlag is defaulted to lock this record. Note that while the record is locked, any other user (via API or browser interface) will receive an error (TS_LOCK_UNAVAILABLE for API) if they attempt to update the same record. The time a lock is held is set by the TeamTrack administrator. The table id and item id must be preset. This requires a roundtrip to the server.

virtual int FinishUpdate()

The FinishUpdate method is used to update the item in the database after field values in the field list (obtained from StartUpdate) have been set. This method will only send fields that have been modified back to the server. After a successful database update, the lock (if it exists) will be removed. This method can return TS_LOCK_UNAVAILABLE if the lock has expired and another user has taken the lock. Requires a roundtrip to the server.

virtual int CancelUpdate()

The CancelUpdate method clears the lock on this record. It is for use after a call to StartUpdate, but when FinishUpdate will not be called. This requires a roundtrip to the server.

TSString StringDump( TSString sIndentation )

Method used for debugging.

Member Variables

None

TSAttachment

This class is a derivative of TSRecordRef and describes a file, URL, or a note attachment.

Methods

TSAttachment( TSServer& server, int nItemId = 0 )

Constructor method; initializes the attachment object and automatically sets the table id.

TSAttachment( const TSAttachment& that )

Copy constructor method.

TSAttachment& operator = ( const TSAttachment& that )

Assignment operator method.

virtual ~TSAttachment()

Destructor method; destroys the object.

int GetType() const

Gets the attachment type.

const TSString& GetText() const

Gets the content of the attachment.

const TSString& GetDateTimeCreated() const

Gets the date and time the attachment was created

const TSString& GetAuthor() const

Gets the user name of the author of the attachment.

int GetFileLength() const

Gets the length of the attached file

const char* GetFileData() const

Gets a pointer to the contents of the file if the attachment is a file and the contents were requested.

TSString StringDump( TSString sIndentation )

Method used for debugging.

int Receive( TSSocket* socket )

Protected method, only intended to be called by member methods of TSServer.

virtual int Read()

Inherited method; private, not intended to be used.

int ReadById( int nItemId )

Inherited method; private, not intended to be used.

Member Variables

int m_nType

TSString m_sText

TSString m_sDateTimeCreated

TSString m_sAuthor

char* m_pFileData

int m_nFileLength

TSChangeHistory

This class is a derivative of TSRecordRef and describes the change history for an item.

Methods

TSChangeHistory( TSServer& server, int nItemId = 0 )

- Constructor method; initializes the object and automatically sets table id member.

TSChangeHistory( const TSChangeHistory& that )

Copy constructor method.

TSChangeHistory& operator = ( const TSChangeHistory& that )

Assignment operator.

virtual ~TSChangeHistory()

Destructor method; destroys the object.

int GetFieldId() const

Gets the field id this change record refers.

int GetFieldType() const

- Gets the field type, e.g. user, of the field being modified

int GetFieldAttribute() const

Gets the field attribute, e.g. date only.

const TSString& GetFieldName() const

Gets the name of the field being modified.

int GetActionType() const

Gets the action type indicating whether the record was created during a submit, update, delete, or attachment add, update or delete.

const TSString& GetDateTime() const

Gets the date and time of the change.

const TSString& GetAuthor() const

Gets the name of the author that made the change.

const TSString& GetPriorDisplayValue() const

Gets the value the field held prior to the change.

int GetPriorInt() const

Gets the value the field held prior to the change when the m_nFieldType is not a text, a memo, or a floating-point type.

const TSString& GetNewDisplayValue() const

Gets the new value for the field.

int GetNewInt() const

Gets the new value for the field when the m_nFieldType is not a text, a memo, or a floating-point type.

int GetType() const

Gets the raw storage type (integer, real or character) of field being modified.

TSString StringDump( TSString sIndentation )

Method used for debugging.

int Receive( TSSocket* socket )

Protected method, only intended to be called by member methods of TSServer.

virtual int Read()

Inherited method; private and not intended to be used.

int ReadById( int nItemId )

Protected method, only intended to be called by member methods of TSServer.

Member Variables

int m_nFieldId

int m_nFieldType

int m_nFieldAttribute

TSString m_sFieldName

int m_nActionType

int m_nType

TSString m_sDateTime

TSString m_sAuthor

TSString m_sPriorDisplayValue

int m_nPriorInt

TSString m_sNewDisplayValue

int m_nNewInt

TSDisplayField

This class is a derivative of TSRecordRef and describes the fields in the display form for an item.

Methods

TSDisplayField( TSServer& server, int nItemId = 0 )

Constructor method; initializes the object and automatically sets the table id member.

TSDisplayField( const TSDisplayField& that )

Copy constructor method.

TSDisplayField& operator = ( const TSDisplayField& that )

Assignment operator.

virtual ~TSDisplayField()

Destructor method; destroys the object.

const TSString& GetDisplayValue() const

Gets the display value of the field.

void SetDisplayValue( const TSString& sNewDisplayValue )

Sets the display value of the field and sets bModifiedFlag to true.

void SetDisplayValue( const TSRecordRef* sNewSelection )

Sets the display value of the field and sets the bModifiedFlag to true.

int GetType() const

Gets the type of the field.

const TSString& GetPrefix() const

Gets the prefix for the field.

int GetAttribute() const

Gets the field attributes.

int GetProperty() const

Gets the field properties.

int GetRequired() const

Determines whether or not the field is required.

const TSString& GetSuffix() const

Gets the suffix for the field.

int GetSection() const

Gets the section the field is within.

bool IsModified() const

Determines whether or not the field has been modified.

bool IsUpdateable() const

Determines whether or not the field can be updated.

const TSRecordRefList& GetSelections() const

Gets a list of TSRecordRefs representing all valid selections if the m_nType is selection or binary.

TSString StringDump( TSString sIndentation )

Method used for debugging.

int Receive( TSSocket* socket )

Protected method, only intended to be called by member methods of TSServer.

virtual int Read()

Inherited method; private and not intended to be used.

int ReadById( int nItemId )

Protected method, only intended to be called by member methods of TSServer.

Member Variables

TSString m_sDisplayValue

int m_nType

int m_nAttribute

int m_nProperty

int m_nRequired

int m_nSection

bool m_bModifiedFlag

TSRecordRefList m_selections

bool m_bCanUpdate

TSString m_sPrefix

TSString m_sSuffix

TSField

This class represents a single field of a record. This generic field object will contain either a text string, an integer, or a double, depending on the datatype of the field.

Methods

void Copy (TSObject *newObjsourceField)

Creates a copy of the sourceField in the current TSField object.

TSString DumpSchema (TSString indentation)

Strings together the field name, datatype, schematype, and field type values. For debugging purposes.

TSObject * Duplicate()

Creates a new instance of the TSField object and copies TSField (this) into the new instance

TSString FieldTypeToName (int fieldType)

Obtains the string equivalent of the integer value for field type

TSObject * NewObject()

Creates a new instance of TSField object and returns a pointer to the new instance

int Receive(TSSocket *socket, TSServer *server)

Receives the incoming data off the socket; different handling based on data type. The method is not intended to be called directly; it should always be called from the TSServer class.

int ReceiveSchema (TSSocket *socket)

Gets the schematype, datatype, field type, and field name off the socket. The method is not intended to be called directly; it should be called from the TSServer class.

int SocketString (TSString &str)

Converts variables of different datatypes to string values.

TSString StringDump(int recursive, TSString indentation)

Dump the values of the field into a string

TSField()

Constructor method; initializes the variables of the TSField object.

TSField (const TSField &/*field*/)

Overloaded constructor method to pass in a TSField object

~ TSField()

Destructor method. Calls the appropriate methods to destroy the list objects that were created to support this class.

Member Variables

Int schemaType

Char fieldName[64]

Int dataType

Int fieldType (For use if this is a field of the Fields table)

Field data. One of these variables will contain data. The others will be 0 or NULL.

Char *charValue

Int charValueMax

Int intValue

Double doubleValue

TSRecordList *recordList

FieldType will be populated with the TS_FLDTYPE_X values defined in TSDef.h, if reading from the TS_FIELDS table. If reading from any other table, fieldType will be null and dataType will be populated with the TS_DATATYPE_X values defined in TSDef.h. The values indicate the type of data the field contains, for example, integer value, string value, boolean value, etc.

Use the TS_AUTO_X values defined in TSDef.h to have TeamTrack automatically set the field’s value. See the sample program Update for example code.

TSFieldList

This class is a descendant of the TSList class. It is used to contain a list of TSField objects.

Methods

TSString DumpSchema (TSString indentation)

Dumps the contents of the field list object into a string; for debugging purposes

TSField * FindFieldByName(const char *fieldName, int fieldType)

Obtains the field (TSField) from the list based on the name and field type that are passed.

TSField * GetAt (TSPosition *pos)

Obtains the field from the list at the position passed.

Member Variables

None

TSIntList

This class is a derivative of TSList. It is used to maintain a list of TSIntObject objects, used with binary and selection type fields.

Methods

TSIntList()

Constructor function;

~TSIntList()

Destructor function;

int Receive( TSServer* server, TSSocket* socket )

Receives data off the socket

TSIntObject* GetAt()

Obtains the TSintObject from the list at the position passed

TSString CommaSeparatedList()

Creates a comma separated string of the TSIntObjects on the TSIntList

void PopulateByCommaSeparatedList( TSString* sList )

Populates the TSIntList from a string of comma separated TSIntObjects

Member Variables

None

TSIntObject

This class is a derivative of TSObject. It provides the means to make a TSList of integers for use with binary and selection type fields.

Methods

TSIntObject()

Constructor function;

TSIntObject( int newIntValue )

Constructor function;

TSIntObject( const TSIntObject& intObject )

Copy constructor;

~TSIntObject()

Destructor function;

int Receive( TSSocket* socket, TSServer* server )

Receives data off the socket

TSObject* NewObject()

Returns a new instance of a TSIntObject

TSObject* Duplicate()

Creates a new TSIntObject and calls the Copy method

void Copy( TSObject* sourceIntObject )

Copies the sourceIntObject to the "this" TSIntObject

TSString StringDump( int recursive, TSString indentation )

Builds a string from intValue; used mainly for debugging purposes

int SocketString( TSString& out )

Converts intValue to a string value for sending across the socket

Member Variables

int intValue

TSItem

This class is derived from a TSRecordRef and defines the base interface for both primary and auxiliary items. These items have several shared characteristics, so a base class makes sense. This class should not be instantiated directly, so the constructor is protected. Please see the TSAuxiliaryItem and TSPrimaryItem derived classes.
Methods

TSItem( TSServer& server, int nTableId = 0, int nItemId = 0 )

- Constructor method; protected, not to be accessed directly.

TSItem( const TSItem& that )

Copy constructor method; protected, not to be accessed directly.

TSItem& operator = ( const TSItem& that )

Assignment operator; protected not to be accessed directly.

virtual ~TSItem()

Destructor method.

virtual bool IsValid() const

The IsValid method is called from the server and in Read to make sure that table id and item id have been set.

TSDisplayFieldList& GetFieldList()

Gets a non-constant list of objects of type TSDisplayField.

const TSDisplayFieldList& GetFieldList() const

Gets a list of objects of type TSDisplayField.

const TSChangeList& GetChangeList() const

Gets a list of objects of type TSChangeList, ordered by user preference.

TSAttachmentList& GetAttachmentList()

Gets a non-constant list of objects of type TSAttachment.

const TSAttachmentList& GetAttachmentList() const

Gets a list of objects of type TSAttachmentList.

TSItemLinkList& GetLinkList()

Gets a non-constant list of objects of type TSItemLink.

const TSItemLinkList& GetLinkList() const

Gets a list of objects of type TSItemLink.

/* -------------------------------------------------------------------------------------------------

The bit masks describing the sections that will be obtained when this call is made are:

TS_SECTMASK_STANDARD Standard Fields

TS_SECTMASK_USER User Fields

TS_SECTMASK_ADVANCED Advanced Fields

TS_SECTMASK_MANAGER Manager Fields

TS_SECTMASK_SYSTEM System Fields

TS_SECTMASK_NOTES Notes

TS_SECTMASK_FILES File Attachments

TS_SECTMASK_URLS URL Attachments

TS_SECTMASK_LINKS Item Links

TS_SECTMASK_CHANGES Change History

TS_SECTMASK_NOTE_CONTENTS Include contents of notes with notes

TS_SECTMASK_FILE_CONTENTS Include contents of files with files

TS_SECTMASK_ALL_EXCEPT_FILE_CONTENTS Include everything except contents of files.

The constructors will set all bit masks, except TS_SECTMASK_FILE_CONTENTS.

------------------------------------------------------------------------------------------------- */

int GetSectionMask() const

Gets the section mask.

void SetSectionMask( int nNewSectionMask )

Sets the section mask.

void SetSectionMaskBits( int nBitsToSet )

Sets specified bits in existing mask.

void ClearSectionMaskBits( int nBitsToClear )

Clears specified bits in existing mask.

virtual int Read()

Inherited method; private, not intended for use.

virtual int StartSubmit()

The StartSubmit method should be used to fill in this item as appropriate for a submit. Populates the item with defaults and orders fields as they would be for a submit, including filling out field selection lists. The three other member lists of a TSItem, changeList, attachmentList and linkList, will be emptied. The table id must be preset. This requires a roundtrip to the server.

virtual int FinishSubmit()

The FinishSubmit method is used to add the item to the database after field values in the field list (obtained from StartSubmit) have been set. This method will only send fields that have been modified back to the server. Requires a roundtrip to the server.

int AddAttachment( int nType, const TSString& sLabel, const TSString& sText )

Adds an attachment (TS_ATTACHATTRIB_NOTE - Note, TS_ATTACHATTRIB_URL - URLs, or TS_ATTACHATTRIB_FILE - Files) to this item. Either the table and item id or the project id, item number should be set before using. The sText argument should be the full path to the file that will be read for files, the note content for notes, or the complete URL for URLs. Requires a roundtrip to the server.

int AddItemLinkByNumber( int nDestProjectId, int nDestItemNumber, int nLinkType )

Adds a link to this item. Either the table and item id or the project id and item number should be set before using. The nLinkType argument is a bit flag argument with bit values defined as:

TS_STORE_ACTION_TWOWAYLINK = 0x0100

TS_STORE_ACTION_SOURCETRIGGER = 0x0200

TS_STORE_ACTION_DESTTRIGGER = 0x0400

A bitwise OR operation has to performed on the above bit flags to obtain certain types of links.
One Way, No Triggers — 0 ( Just Zero).

One Way, Current item triggers linked item — 0x0200

Two Way, No triggers — 0x0100

Two Way, Current item triggers linked item — 0x0100 | 0x0200

Two Way, Linked item triggers current item — 0x0100 | 0x0400

Two Way, Both items trigger each other — 0x0100 | 0x0200 | 0x0400

Requires a roundtrip to the server.

int AddItemLinkById( int nDestTableId, int nDestItemId, int nLinkType )

Adds a link to this item. Either the table and item id or the project id and item number should be set before using. The nLinkType argument is a bit flag argument with bit values defined as:

TS_STORE_ACTION_TWOWAYLINK = 0x0100

TS_STORE_ACTION_SOURCETRIGGER = 0x0200

TS_STORE_ACTION_DESTTRIGGER = 0x0400.

Requires a roundtrip to the server.

int DeleteAttachment( TSAttachmentList::iterator it )

- Deletes the attachment from this item and the attachment list. Requires a roundtrip to the server.

int DeleteItemLink(TSItemLinkList::iterator it, bool bDeleteBothSides = true )

- Deletes the item link from this item and the link list. The bDeleteBothSides argument specifies

whether to also delete a link back to this item if it exists. Requires a roundtrip to the server.
Member Variables

TSDisplayFieldList m_fieldList

TSChangeList m_changeList

TSAttachmentList m_attachmentList

TSItemLinkList m_linkList

int m_nSectionMask

int m_nMode
TSItemLink

This class describes item links.
Methods

TSItemLink( TSServer& server, int nItemId = 0 )

- Constructor method; initializes object and automatically sets the table id member.

TSItemLink( const TSItemLink& that )

Copy constructor.

TSItemLink& operator = ( const TSItemLink& that )

Assignment operator.

virtual ~TSItemLink()

Destructor method; destroys the object.

int GetLinkType() const

Gets the link type.

const TSString& GetCreator() const

Gets the creator of the link.

const TSString& GetDateTimeCreated() const

Gets the date/time the link was created.

int GetDestProjectId() const

Gets the project id of the item associated with the link.

int GetDestItemNumber() const

Gets the item number of the item associated with the link.

int GetDestTableId() const

- Gets the table id of the item associated with the link.

int GetDestItemId() const

Gets the item id of the item associated with the link.

TSString StringDump( TSString sIndentation )

Method to help when debugging.

int Receive(TSSocket* socket)

Protected method, only intended to be called by member methods of TSServer.

virtual int Read()

Inherited method; private method no longer in use.

int ReadById( int nItemId )

Inherited method; private method no longer in use.

Member Variables

int m_nLinkType

TSString m_sCreator

TSString m_sDateTimeCreated

int m_nDestProjectId

int m_nDestItemNumber

int m_nDestTableId

int m_nDestItemId

TSList

This class is the base class from which all types of lists inherit.

Methods

int AddHead(TSObject *object)

Adds an element to the beginning of the list

int AddTail(TSObject *object)

Adds an element to the end of the list

int Copy(TSList *newListsourceList)

Copies the contents of sourceList into "this" list. Note: use EmptyList() rather than EmptyAndDestroyList() when getting sourceList after a copy.Copies the contents this list into newList

int Duplicate(TSList *newList)

Duplicate the contents of this list into the new list

void EmptyAndDestroyList()

Delete the list object

void EmptyList()

Iterates through the list (array) to remove each item

TSPosition * Get(int index)

Moves to the next item in the list

TSObject * GetAt(TSPosition *pos)

Obtains the item in the list at the index passed

TSPosition * GetFirst()

Obtains the first item in the list

TSPosition * GetLast()

Obtains the last item in the list

TSPosition * GetNext(TSPosition *pos)

Obtains the next item in the list

TSPosition * GetPrev(TSPosition *pos)

Obtains the previous item in the list

int InsertAfter(TSPosition *pos, TSObject *object)

Adds an item to the list after the position passed

int InsertBefore(TSPosition *pos, TSObject *object)

Adds an item to the list before the position passed

int Length()

Obtains the length of the list

TSObject* RemoveObject(TSObject *pObject)

Removes the actual object instance

TSObject * RemoveObject(TSPosition *pos)

Removes an item from the list at the position passed

TSObject * RemoveObject(int index)

Removes an item from the list at the index passed

int SocketString(TSString &str)

Convert the item in the list to a string value

TSString StringDump(int recursive, TSString indentation)

Builds a string of the list’s contents; mainly for debugging purposes
TSList()

Constructor method; initialize the list object

~TSList()

Destructor method; destroys the list object

Member Variables

TSPosition *first

TSPosition *last

int length

TSObject

This class is an abstract base class for any object to be put on a TSList. Most API classes inherit from this class.
Methods

virtual void Copy(TSObject *) = 0

Virtual function at this level; overridden at the descendant level to copy the object and to perform any additional functionality specific to the descendant type.

virtual *Duplicate() = 0

Virtual function at this level; overridden at the descendant level to replicate the object and to perform any additional functionality specific to the descendant type.

virtual *NewObject() = 0

Virtual function at this level; overridden at the descendant level to allocate memory for a new instance of the object and to perform any additional functionality specific to the descendant type.

virtual int SocketString(TSString &str) = 0

Virtual function at this level; overridden at the descendant level to convert an object’s values to strings and to perform any additional functionality specific to the descendant type.

virtual TSString StringDump(int recursive, TSString indentation) = 0

Virtual function at this level; overridden at the descendant level to string together an object’s variables for debugging purposes and to perform any additional functionality specific to the descendant type.

virtual ~TSObject()

Virtual function at this level; overridden at the descendant level to destroy the object and to perform any additional functionality specific to the descendant type.

Member Variables

None

TSPosition

This class is used to iterate through a list of records or fields. It is a pointer to a position in a list.

Methods

TSPosition()

Constructor method; initializes the position object

TSPosition(TSPosition *nextPos, TSPosition *prevPos, TSObject *thisObj)

Value the next, previous and object member variables with the values passed

Member Variables

TSPosition *next

TSObject *object

TSPosition *prev

TSPrimaryItem

This class is derived from TSItem and defines a primary item.
Methods

TSPrimaryItem( TSServer& server, int nTableId = 0, int nItemId = 0 )

Constructor method; initializes the object.

TSPrimaryItem( TSServer& server, const TSProject& project, int nItemNumber = 0 )

Constructor method; initializes the object.

TSPrimaryItem( const TSPrimaryItem& that )

Copy constructor method.

TSPrimaryItem& operator = ( const TSPrimaryItem& that )

Assignment operator.

virtual ~TSPrimaryItem()

Destructor method; destroys the object.

virtual void SetItemId( int nNewItemId )

Sets the item id and clears the item number.

int GetProjectId() const

Gets the unique project ID associated with the primary item.

void SetProjectId( int nNewProjectId )

Sets the unique project ID associated with the primary item.

int GetItemNumber() const

Gets the primary item number.

void SetItemNumber( int nNewItem )

Sets the primary items number.

int GetStateId() const

Gets the state id.

const TSString& GetItemType() const

Gets the item type.

virtual int Read()

Works like the TSItem’s Read, but also populates the m_nProjectId, m_nItemNumber, m_nStateId, and m_sItemType members. The Read method in this class will either read by table id and item id or if either are 0 and the project id and item number are set, it will read by project id and item number. Requires a roundtrip to the server.

int ReadByNumber( int nProjectId, int nItemNumber )

Populates the project id and item number members and clears item id before calling Read.

virtual int StartSubmit()

Same functionality as TSItem’s StartSubmit, except a project id must be specified for a submit of a primary item. Requires a roundtrip to the server.

int StartSubmitIntoProject( int nProjectId )

Sets the project id member before calling StartSubmit.

int StartSubmitIntoProject( TSProject& project )

Sets the project id member before calling StartSubmit.

virtual int GetTransitionList( TSTransitionList& results )

The GetTransitionList method returns a list of TSTransition records in the results list that indicate which transitions are valid for this item. Either the table id and item id or the project id and item number must be preset. This requires a roundtrip to the server.

virtual int StartTransition( int nTransitionId )

The StartTransition method should be used to fill in this item as appropriate for a transition. The transition ID indicates which transition to use. Populates the item and orders fields as they would be for the transition, including filling out field selection lists. The three other member lists of a TSItem: changeList, attachmentList and linkList, will not be updated. This method locks this record. Note that while the record is locked, any other user (via API or browser interface) will receive an error (TS_LOCK_UNAVAILABLE for API) if they attempt to transition the same record. The time a lock is held is set by the TeamTrack administrator. Either the table id and item id or the project id and item number must be preset. Requires a roundtrip to the server.

virtual int StartTransition( TSString sTransitionName )

The StartTransition method should be used to fill in this item as appropriate for a transition. The transition name indicates which transition to use. Populates the item and orders fields, as they would be for the transition, including filling out field selection lists. The three other member lists of a TSItem: changeList, attachmentList and linkList, will not be updated. This method locks this record. Note that while the record is locked, any other user (via API or browser interface) will receive an error (TS_LOCK_UNAVAILABLE for API) if they attempt to transition the same record. The time a lock is held is set by the TeamTrack administrator. Either the table id and item id or the project id and item number must be preset. Requires a roundtrip to the server.

virtual int StartTransition( const TSTransition& transitionItem )

The StartTransition method should be used to fill in this item as appropriate for a transition. The transition item indicates which transition to use. Populates the item and orders fields, as they would be for the transition, including filling out field selection lists. The three other member lists of a TSItem: changeList, attachmentList and linkList, will not be updated. This method locks this record. Note that while the record is locked, any other user (via API or browser interface) will receive an error (TS_LOCK_UNAVAILABLE for API) if they attempt to transition the same record. The time a lock is held is set by the TeamTrack administrator. Either the table id and item id or the project id and item number must be preset. Requires a roundtrip to the server.

virtual int FinishTransition()

The FinishTransition method is used to transition the item in the database after field values in the field list (obtained from StartTransition) have been set. This method will only send fields that have been modified back to the server. After a successful database update, the lock (if it exists) will be removed. This method can return TS_LOCK_UNAVAILABLE if the lock has expired and another user has taken the lock. Requires a roundtrip to the server.

virtual int CancelTransition()

The CancelTransition method clears the lock on this record. It is for use after a call to StartTransition, when FinishTransition will not be called. This requires a roundtrip to the server.

int Receive( TSSocket* socket )

Protected, only intended to be called by member methods of TSServer.

virtual bool IsValid() const

Protected method called from TSServer and in Read to make sure that table id and item id or project id and item number have been set.

TSString StringDump( TSString sIndentation )

Method used for debugging.

Member Variables

int m_nProjectId

int m_nItemNumber

int m_nStateId

TSString m_sItemType

int m_nTransitionId

TSProject

The TSProject class is a descendant of the TSRecordRef class. It is used to provide the sFullProjectName in a tab-delimited ( ^i ) string representing the full project hierarchy, for example: TeamShare Projects^iEngineering^iProducts^itSupport.
Methods

TSProject(TSServer& server, TSString sFullProjectName)

Constructor method; initializes the project object and automatically sets the table id member.

TSProject(TSServer& server, int nItemId = 0)

Constructor method; initializes the project object and automatically sets the table id member

TSProject(const TSProject& that)

Copy constructor method.

TSProject& operator = ( const TSProject& that )

Assignment operator.

virtual ~TSProject()

Destructor method; destroys the project object

TSString GetFullProjectName() const

Gets the full project name.

int GetPrimaryTableId() const

Gets the primary table id.

int GetProjectId() const

Calls GetItemId.

virtual void SetItemId( int nNewItemId )

Sets the item id and clears the full project name.

void SetProjectId( int nNewProjectId )

Sets the project id.

void SetFullProjectName( const TSString& sNewFullProjectName )

Sets the full project name and clears the item id.

virtual int Read()

The Read method in this class will either read by table id and project id (m_nItemId in base class) or if the project id is 0 and the full project name is not empty, it will read by full project name. The name, and either the project id or full project name, will then be populated. This requires a roundtrip to the server.

int ReadByFullProjectName( TSString sFullProjectName )

This method will set the m_sFullProjectName member and clear the project id member before calling Read.

TSString StringDump( TSString sIndentation )

Method used for debugging.

virtual bool IsValid() const

The IsValid method is called from TSServer and in Read to make sure that table id and item id or the full project name are set.

int Receive( TSSocket* socket )

Protected method, only intended to be called by member methods of TSServer.

void SetTableId( int nNewTableId )

Inherited method; private, not intended to be used.

Member Variables

TSString m_sFullProjectName

int m_nPrimaryTableId

TSRecord

The TSRecord class contains the data for a particular record in the database. The constructor asks for the list of fields for a record of its type from the server. The API programmer can fill in fields for performing an AddRecord or use it to perform a ReadRecord or any other method that returns a record.

Methods

void ClearDeletedRecord()

Reverses the value of the RecordDeleted variable and assigns it to recordState

void ClearNewRecord()

Reverses the value of the RecordNew variable and assigns it to recordState

void ClearNewRecordWithID()

Reverses the value of the RecordNewWithID variable and assigns it to recordState

void ClearUpdatedRecord()

Reverses the value of the RecordUpdated variable and assigns it to recordState

void Copy(TSObject *objsourceRecord)

Creates a copy of the sourceRecord in the current TSRecord object.Copy the object passed onto the TSRecord object.

void CopyUserDefFieldsFrom()

- Copies the data from the fields list into the user DefinedFields record list. Note: private, not intended to be called directly.

void CopyUserDefFieldsTo()

Copy the data from the userDefinedFields record list into the fields list Copies the values from the user defined records to the regular field list. To the user, it will look like a single list of fields from the database. Note: private, not intended to be called directly.

TSObject * Duplicate()

Duplicate the contents of TSRecord onto a new TSRecord

double GetDouble(const char *fieldName)

Finds the field (of type ‘double’) in the list and returns its doubleValue variable

int GetDouble(const char *fieldName, double *value)

Finds the field (of type ‘double’) in the list and assigns ‘value’ its doubleValue variable

int GetInt(const char *fieldName)

Finds the field (of type ‘int’) in the list and returns its intValue variable. Note: column name must be lower case without the TS_. The only columns available are the ones not found in the FIELDS table, unless calling the method against the FIELDS table.

int GetInt(const char *fieldName, int *value)

Finds the field (of type ‘int’) in the list and assigns ‘value’ its intValue variable

int GetRecordList(const char *fieldName, TSRecordList **value)

For fields that are lists in the table schema, this method gets the list from the record object based on the fieldName passed and assigns it to the ‘value’ variable

TSRecordList * GetRecordList(const char *fieldName)

For fields that are lists in the table schema (memberlist in Groups table), this method gets the list from the record object.

int GetString( const char* fieldName, char** value )

Finds the field stored as a type of string, from the record’s ‘fieldList’, whose title is ‘fieldName’. This method allocates a buffer for the method parameter ‘value’ using a call to new then copies the field’s ‘charValue’ to ‘value’. The caller is responsible for destroying ‘value’ using a call to delete. Note: column name must be lower case without the TS_. The only columns available are the ones not found in the FIELDS table, unless calling the method against the FIELDS table.

int GetString(const char *fieldName, char **value)

Finds the field (of type ‘String’) in the list and allocates a new buffer for the strcpy of the charValue variable to ‘value’

char* GetString( const char* fieldName )

Finds the field stored as a type of string, from the record’s ‘fieldList’, whose title is ‘fieldName’. This method returns a pointer to the field’s ‘charValue’ variable, which is internally allocated data and should NOT be freed by the caller. Note: column name must be lower case without the TS_. The only columns available are the ones not found in the FIELDS table, unless calling the method against the FIELDS table.

char * GetString(const char *fieldName)

Finds the field (of type ‘String’) in the list and returns a pointer to its charValue variable

int GetString( const char* fieldName, char* value, int bufferSize )

Finds the field stored as a type of string, from the record’s ‘fieldList’, whose title is ‘fieldName’. This method copies the field’s ‘charValue’ to the method parameter ‘value’ of length ‘bufferSize’. If the length of the field’s ‘charValue’ is of size ‘bufferSize’ or greater, ‘value’ will NOT be NULL terminated. Note: column name must be lower case without the TS_. The only columns available are the ones not found in the FIELDS table, unless calling the method against the FIELDS table.

int GetString(const char *fieldName, char *value, int bufferSize)

Finds the field (of type ‘String) in the list and copies it into ‘value’

int GetString( const char* fieldName, TSString* value )

Finds the field stored as a type of string, from the record’s ‘fieldList’, whose title is ‘fieldName’. This method assigns the field’s ‘charValue’ to the method parameter ‘value’. Note: column name must be lower case without the TS_. The only columns available are the ones not found in the FIELDS table, unless calling the method against the FIELDS table.

int GetString(const char *fieldName, TSString *value)

Finds the field (of type ‘String’) in the list and assigns ‘value’ its charValue variable

TSTreeList * GetSubTreeList()

Obtains the tree list for a particular item. The tree list would be all Project, Workflows, Folders, etc. that are children of the item.

void Initialize(int tableId, TSServer *server)

Values the member variables with initial data; obtains the schema of the table and the table name then duplicates the schema.fieldlist attribute

int MembersToStringBySchemaType(TSString &out, int schemaType)

Iterate through the field list to encode the member variables as strings (typo in the comment documentation)

TSObject * NewObject()

Creates a new instance of TSRecord

int Receive(TSSocket *socket)

Receive data off the socket

int ReceiveFieldsBySchemaType(TSSocket *socket, int schemaType)

Receive the record data off the socket by comparing field types

int ReceiveUserDefinedFields(TSSocket *socket)

Receive the user defined fields off the socket

void SetDeletedRecord() { recordState |= RecordDeleted; }

Assigns the RecordDeleted value to recordState

int SetDouble(const char *fieldName, double value)

Finds the field (of type ‘double’) in the field list and assigns the value of ‘value’ to the field’s doubleValue attribute; then sets the recordState to "updated" and returns a status value.

int SetInt(const char *fieldName, int value)

Finds the field (of type ‘int) in the field list and assigns the value of ‘value’ to the field’s intValue attribute; then sets the recordState to "updated" and returns a status value.

void SetNewRecord() { recordState |= RecordNew; }

Assigns the RecordNew value to recordState

void SetNewRecordWithID() { recordState |= RecordNewWithID; }

Assigns the RecordNewWithID value to recordState

int SetString(const char *fieldName, const char *value)

Finds the field (of type String) in the field list then replaces its charValue attribute with the value of ‘value’, recordState is set to RecordUpdated.

void SetUpdatedRecord() { recordState |= RecordUpdated; }

Assigns the value of RecordUpdated to recordState.

int SocketString(TSString &str)

Converts the entire record to a string so that it can be sent across the socket to the server

TSString StringDump(int recursive, TSString indentation)

String together the contents of the TSRecord object; for debugging purposes

TSRecord()

Constructor method; Initialize the TSRecord object with tableid = 0 and NULL server value

TSRecord(int tableId, TSServer *server, int fieldType = 0)

Constructor method; Initialize the TSRecord object with the tableid and server object passed in order to create a record object for the appropriate table. FieldType defaults to 0 because it is only used when reading from the TS_FIELDS table.

~TSRecord()

Destructor method; also empties and destroys the field list

int UserDefinedFieldsToSocketString(TSString &out)

Obtains the list of user defined fields from the actual field list and coverts them into a string to be sent across the socket

Member Variables

TSFieldList fieldLlist (The field list will be public)

Int fieldType

BOOL fromPos

Static const int RecordDeleted

Static const int RecordNew

Static const int RecordNewWithId

BOOL recordState

Static const int RecordUpdated

TSServer serverRef

Int sqlDataType

Int tableId

TSString tableName

TSRecordList userDefinedFields

TSRecordRef

This class is the base class for several other class objects. It can also be instantiated stand-alone, when only the name of an item needs retrieved.
Methods

TSRecordRef( TSServer& server, int nTableId = 0, int nItemId = 0 )

Constructor method; initializes the TSRecordRef object.

TSRecordRef( const TSRecordRef& that )

Copy constructor method.

virtual ~TSRecordRef()

Destructor method; destroys the object

TSRecordRef& operator =( const TSRecordRef& that )

Assignment operator.

int GetTableId() const

Gets the table id.

virtual bool IsValid() const

The IsValid method is called from the server and in Read to make sure that table id and item id have been set.

TSString StringDump( TSString sIndentation )

Method used for debugging.

void SetTableId(int nNewTableId )

Sets the table id.

int GetItemId() const

Gets the item id.

void SetItemId( int nNewItemId )

Sets the item id.

const TSString& GetItemName() const

Gets the item name.

virtual int Read()

The Read method will cause a roundtrip to the server and all appropriate data members will be filled. The table id and item id must be set prior to using this method. The base class method will only populate the item name.

int ReadById( int nItemId )

The ReadById method will set the m_nItemId variable and then call the virtual Read method.

int Receive( TSSocket* socket)

Only intended to be called by member methods of TSServer or TSDisplayField to receive its m_selection member.

Member Variables

int m_nTableId

int m_nItemId

TSString m_sItemName

TSServer& m_server

TSRecordList

The TSRecordList class is a child of TSList. It is used to maintain a list of TSRecord objects that are returned from one of the Read methods.

Methods

TSRecord * FindRecord(const char *fieldName, int searchValue)

Finds a record in the list based on the search value passed; used for fields of type int

TSRecord * FindRecord(int recId)

Finds a record in the list based on the search id passed

TSRecord * FindRecord(const char *fieldName, const char *searchValue)

Find a record in the list based on the search value passed; used for fields of type char

TSRecord * FindRecord(const char *fieldName, double searchValue)

Finds a record in the list based on the search value passed; used for fields of type double

TSRecord* FindRecord(const char *fieldName, int nTableId, int nFieldType, int nSqlDataType)

Finds a record in the list based on structure, not data

TSRecord * GetAt(TSPosition *pos)

Returns the record in the list at the position passed

int Receive(TSServer *server, TSSocket *socket)

Receives the record data off the socket

void SetIsFieldList( BOOL bIsFields ) { m_bIsFieldList = bIsFields; }

Used to set the value of the member variable m_bIsFieldList.

int SocketString(TSString &str)

Converts the entire record to a string to be passed on the socket

Member Variables

BOOL m_bIsFieldList (For internal use. This flags the list of user-defined fields).

TSSchema

This class provides a means for obtaining a given table’s field list.

Methods

void Copy(TSObject *objsourceSchema)

Copy the contents of obj sourceSchema(passing a TSSchema object) into the current TSSchema object.

TSObject * Duplicate()

Creates a new TSSchema object and copies the current values for name, tableid, and fieldlist to it.

TSObject * NewObject()

Returns a new instance of the TSSchema object

int SocketString(TSString &/*str*/)

This function is not needed for a schema object since it’s a client side only object

TSString StringDump(int /*recursive*/, TSString indentation)

Builds a string of tableid and name; used mainly for debugging purposes

~TSSchema()

Destructor function; also empties and destroys the field list

Member Variables

TSFieldList fieldList

TSString name

int tableId

int userDefinedFields

TSServer

TSServer is the main class used to communicate with TeamTrack systems. TSServer will encode data in a string to be sent through the web server to TeamTrack. TSServer knows how to connect to the web server, check permissions for the actions being performed and maintain lists of fields for each record type.

The first time a TSRecord is instantiated for a particular record type, the TSServer will retrieve a list of the fields for that record type from TeamTrack and cache that list of fields. Each subsequent time a TSRecord of that type is created, its field information will be filled in from the cache.

TSServer will connect to the web server using either the server name (machine name) or the server’s IP address. If it fails to connect, the constructor will throw an exception. If the username doesn’t exist or the password is invalid, the constructor will also throw an exception.

The Send() method of the TSServer class is what the other methods use to talk to the server. It sends the string across the socket to the server, it receives the resulting string, and loads it into a TSRecord class for the API programmer to use.

Methods

int AddField(TSRecord *field, int tableid, int fieldType)

Use to add a field to a given table. Calling this function will perform the AddRecord() on the Fields table and then uses that information to add the field to the appropriate table. Fields can only be added to the following tables: Cases, Incidents, Companies, Contacts, Merchandise, Products, Problems, Resolutions, and Service Agreements.

Use to add a field to a given table. Calling this function will perform the AddRecord() on the Fields table and then uses that information to add the field to the appropriate table. Fields can be added to any primary or auxiliary table. The tableId parameter will be used to set the TS_TABLEID field in the new record. There is no need to set this value before passing it into this function. The return value is a TS_xxx error code. NOTE: A return of TS_OK does not necessarily indicate success ALWAYS check the fieldId. The fieldId will be 0 on failure; otherwise it's the TS_ID for the new FIELDS table record.

int AddRecord(TSRecord *rec, TSRecord *newRecord /*=NULL*/)

Use for adding a singular record (row) to a table

int BuildFieldList(int tableId, TSFieldList &fieldList)

Builds the list of fields forom GetSchema for the table passed into the method. Deprecated method, use the GetSchema method.

int Connect(const char *userName, const char *password, const char *serverAddress)

Connects the user to a webserver running TeamTrack

int DeleteRecord(int tableId, int id)

Use for deleting a singular record (row) from a Table

TSString EncodePassword(const char *password)

Encrypts the user’s password; called from Connect()

int GetConnectionInfo(char *dsn, char *databaseName, char *serverName)

Use to obtain information about db connectivity

int GetConnectionInfo(char **dsn, char **databaseName, char **serverName)

Use to obtain information about db connectivity

int GetDbInfo(int infoType, void * out)

Use to obtain database information

int GetInt(int tableId, const char *columnName, int recId, int *result)

Use to obtain the value of a numeric column from a table. Note: column name must be lower case without the TS_. The only columns available are the ones not found in the FIELDS table, unless calling the method against the FIELDS table.

int GetProjectList( int nTableId, int nProjectsMask, TSList* results )

Gets a list of objects of type TSProject the logged-in user has privileges to. nProjectMask determines on which privileges to filter, e.g. return only the projects the user can view. Possible values for nProjectMask are: TS_PROJ_VIEW = 0x0001, TS_PROJ_UPDATE = 0x0002,

TS_PROJ_SUBMIT = 0x0004, and TS_PROJ_TRANSITION = 0x0008.

Requires a round trip to the server.

const char *GetLastErrorMessage()

Displays the error message for the last operation that failed

TSSchema * GetSchema(int tableId)

Use to get the fields for a given table.

int GetString(int tableId, const char *columnName, int recId, char **result)

Use to obtain the value of a char/string column from a table. Note: column name must be lower case without the TS_. The only columns available are the ones not found in the FIELDS table, unless calling the method against the FIELDS table.

Use to obtain the value of a char/string column from a table

int GetString(int tableId, const char *columnName, int recId, char *result, int size)

Use to obtain the value of a char/string column from a table. Note: column name must be lower case without the TS_. The only columns available are the ones not found in the FIELDS table, unless calling the method against the FIELDS table.

Use to obtain the value of a char/string column from a table

int GetSubmitTransition(int projectId, int *id)

Use to obtain the id value for the submit transition

int HasGroupPrivilege( int groupId, int itemId, enum privId_e privId )

Determines if the Group has the specified privilege.

int HasPrivilege(int userId, int projectId, int maskNumber, int mask)

Determine a user’s privileges within a Project. The userid parameter is the TS_ID value for the user record from the TS_USERS table. Note: method is only supported for backward compatibility. Use HasGroupPrivilege or HasProjectPrivilege methods.

int HasUserPrivilege( int userId, int itemId, enum privId_e privId )

Determines if the User has the specified privilege.

int HasRecordPrivilege( enum recPriv_e recPriv, int userId, int tableId, int recId )

Determines if the User has the specified privilege for the requested record.

int MoveFolder(int folderId, int newParentId, int position)

Use to move a folder to a different place in the hierarchy. Valid values for the position parameter are: TS_CHILD, TS_PRIOR_SIBLING and TS_NEXT_SIBLING.

int MoveProject(int projectId, int newParentId, int position)

Use to move a project to a different place in the hierarchy. Valid values for the position parameter are: TS_CHILD, TS_PRIOR_SIBLING and TS_NEXT_SIBLING.

TSSocket *OpenSocket()

Allocate memory for a new TSSocket object and return a pointer to it

int ReadAllRecords(TSRecordList *list, int tableId)

Read all the records for the requested table into a list object

int ReadAttachmentList(TSRecordList *list, int tableId, int recId)

Use to obtain a list of attachments for a given record (can be an Issue, an Incident, etc.)

int ReadAvailableTransitionList( TSRecordList* list, int tableId, int recId )

Use to obtain a list of available transitions for a given record.

int ReadChangeList(TSRecordList *list, int caseId, BOOL newFirst /*=FALSE*/)

Use to read all the change history for an issue or incident

int ReadFolderItems(TSRecordList *list, int folderId)

Use to obtain a list of links in a given folder

int ReadFolderList(TSRecordList *list, int owner, int parentId)

Use to obtain a list of folders given the "owner" or user id and the parent folderid.

int ReadProjectSelectionList(TSRecordList *list, int selectid)

Use to obtain a list of which projects use a given selection. Obtains records from the TS_ProjectSelections table for the passed selectid value.

int ReadProjectTransitionList(TSRecordList *list, int transId)

Use to obtain a list of which projects use a given transition. Obtains records from the TS_ProjectTransitions table for the passed transid value. The transid parameter is the TS_ID value for the transition record from the TS_TRANSITIONS table.

int ReadPropertyList(TSRecordList *list, int transId)

Use to obtain a list of field properties that have been defined for a given transition. Obtains records from the TS_Properties table for the passed transid value.

int ReadRecord(TSRecord *rec, int id)

Use to obtain a specific record from a table. The record object should be instantiated using the constructor method which initializes the object for a specific table, in order to build the TSRecord with the appropriate fields for that table:

TSRecord::TSRecord(int tableId, TSServer *server, int fieldtype /*=0*/)

int ReadRecordForId(TSRecord *record, const char *searchId)

Use to search for a given record by its id value. The TSRecord object argument should be instantiated using the TSRecord constructor method which initializes the object for a specific table, in order to build the TSRecord with the appropriate fields for that table:

TSRecord::TSRecord(int tableId, TSServer *server, int fieldtype /*=0*/)

int ReadRecordListWithWhere(TSRecordList *list, int tableId, const char *whereClause )

Use to filter a list of records based on the conditions passed; note that the whereClause does not need the word "WHERE". For example: ‘TS_COMPANYID = 5’. The table and column names are case-sensitive and must match exactly what is in the database. TeamTrack tables and columns are always UPPERCASE.

int ReadRecordListWithWhere( TSRecordList* recordList, int tableId, const char* whereClause,

const std::vector< int >& fields )

Similar to the other ReadRecordListWithWhere. Reads a record list, filtering by the where clause, returning only the desired fields. The vector is populated with the TS_ID numbers of the desired fields in the TSFIELDS table.

int ReadRecordWithWhere(TSRecord *record, const char *whereClause)

Reads a record, filtering by the where clause and returning only the desired fieldsUse to filter the selection of one record based on the conditions passed; note that the whereClause does not need the word "WHERE". For example: ‘TS_ID = 5’. The table and column names are case-sensitive and must match exactly what is in the database. TeamTrack tables and columns are always UPPERCASE.

ReadRecordWithWhere( TSRecord* record, const char* whereClause, const std::vector< int >& fields )

Similar to the other ReadRecordWithWhere. Reads a record, filtering by the where clause, returning only the desired fields. The vector is populated with the TS_ID numbers of the desired fields in the TSFIELDS table.

int ReadReport(TSRecord *report, const char *name)

Use to find a report by name

int ReadReportList(TSRecordList *list, long userId, int perm)

Use to obtain a list of reports available to a given user based on permissions. The userid parameter is the TS_ID value for the user record from the TS_USERS table.

int ReadSelectionList(TSRecordList *list, int fieldId, int projectId)

Use to obtain a list of selections defined for a given field and available for a given project

int ReadStateList(TSRecordList *list, int workflowId, BOOL incParent /*=FALSE*/)

Use to obtain a list of states defined for a given workflow; possible to include the parent workflow’s states

int ReadTransitionList(TSRecordList *list, int projectId)

Use to obtain a list of transitions that are available for a given project

int ReadUserDefinedFields(TSRecordList *list, int tableId)

Use to obtain a list of the user-defined fields in a given table.

int ReadUserListForPrivilege(TSRecordList *list, int userid, TSRecordList *fieldList, int mask)

Use to obtain a list of the privileges defined for a given user. The userid parameter is the TS_ID value for the user record from the TS_USERS table.

int ReadUserSelectionList(TSRecordList *list, int fieldId, int projectId, BOOL incDeleted /* = FALSE */)

Use to obtain a list of selection values (defined for a given field) that are available to a particular user for a given project

The method is obsolete and does not return data.

int ReadVCActions(TSRecordList *list, int caseId)

Use to obtain a list of the version control activity for a given issue. The caseId parameter is the TS_ID value for the issue record from the TS_CASES table.

int ReadVCActionsForModule(TSRecordList *list, const char *filename, int userid, int action2)

Use to obtain a list of Version Control activity for a given user. The filename parameter must include the path of the file. For example:

"D:\Program Files\TeamShare\API\Samples\SubmitIssue\SubmitIssue.cpp"

In addition, the userid parameter is the TS_ID value for the user record from the TS_USERS table, not the loginid for the user. Action2 defaults to 0. This will return a record from the TS_VCACTIONS table if the file in question is still checked out. If subsequent action has been take, i.e. the file has been either checked in or the checkout undone, you will need to pass either 2 or 3, respectively. In order to view file history for multiple users, it would be more effectively to use the ReadAllRecords function call.

int ReleaseRecordLockByNumber( int nProjectId, int nItemNumber )

Unlocks the previously locked record. Use this either after the item has been updated or to cancel out of a change. Requires a round trip to the server.

int ReleaseRecordLockById( int nTableId, int nItemId )

Unlocks the previously locked record. Use this either after the item has been updated or to cancel out of a change. Requires a round trip to the server.

int Send(TSSocket *socket, const char *str)

Use to transmit data across the socket, receive data off the socket and load it into a TSRecord

int SetAlternateUser( TSString sLoginId, TSString sPassword, bool bValidatePwd )

This method sets sLoginId as the alternate user. If bValidatePwd is true, sPassword must contain the password for the alternate user and validation will occur. Requires a round trip to the server.

int SetExitUrl(const char *exiturl)

Use to modify the Exit URL. Note, the complete URL must be passed in, e.g. http://www.teamshare.com

int SetRecordLockByNumber( int nProjectId, int nItemNumber )

Locks the specified record for the time period set by the administrator.

int SetRecordLockById( int nTableId, int nItemId )

Locks the specified record for the time period set by the administrator.

int Submit(int *nIssueId, TSString &sLoginid, TSRecord *pRec, int nTableId, int nProjectId, int nFolderId, int nType )

Used to submit an Issue or an Incident into the database and into the workflow. For submitting other items, Companies, Contacts, etc., use AddRecord, since only Issues and Incidents follow a workflow.

int Transition(TSString &sLoginid, TSRecord *pRec, int nProjectId, int nTableId, int nRecordId, int nTransition)

Used to transition either an Issue or an Incident to another state in the workflow.
TSServer()

Constructor method; creates a TSServer object
~TSServer()

Destructor method; destroys the schema cache

int UpdateList(TSRecordList *list, int tableId, int recid1, int recid2)

Use to update a record in a given table. The values associated with recid1and recid2 are as follows:

RecordType recid1 recid2

Member userid groupid

Privilege userid groupid

Selection fieldid (Not used)

TransIssueType transitionid (Not used)

TransTriggerState stateid (Not used)

TransTriggerTransition transitionid (Not used)

int UpdateList(TSRecordList *list, int tableId, int recid1, int recid2)

Use to update a record in a given table

int UpdateRecord(TSRecord *rec, TSRecord *newRecord /*=NULL*/)

Use to update a single record in a table (as opposed to updating a record in a list).

int ValidateUser(const char * loginid, const char *pwd, BOOL validatePwd/*=TRUE*/, int *userId /*=NULL*/)

Validates the TeamTrack login id and password being used to connect to the webserver; called from Connect().

int ValidateVersion()

Use to validate the version of the API being used against the version of the TeamTrack software installed on the webserver to verify that they are compatible.

Member Variables

TSString authentication

TSString errorMsg

int portNumber

TSString postHeader

TSList schemaCache

TSString webAddress

TSSocket

This class is a child of the MFC CSocket class. Certain methods are overridden for specific use in this API. It is the object used to send and receive data on a TCP/IP socket.
Note: On either the Linux or Unix platforms, a generic, non-MFC, CSocket class is used. The definition for that class can be found in TSSocket.h.

Methods

void ClearBuffer()

Sets the bufferStart and bufferEnd variables to 0

BOOL Connect( const char *hostAddress, unsigned int portNumber )

Calls the ancestor’s Connect method in order to establish a connection to the socket

BOOL Create( unsigned int socketPort, int socketType, char * socketAddress)

called from the ancestor’s constructor; initializes bufferStart and bufferEnd to 0 and calls the Create() method on the MFC object CSocket to create the socket and attach to it by calling the Bind() method, which binds the socket to the specified address.

int FillBuffer()

Receive the contents of the socket into the buffer; read incoming data off the socket.

void Initialize()

Allocates (a 2048 byte block of) memory for the socketBuffer and cast the pointer to it into a char

int IsConnected()

Checks to see if the socket is connected on the host address and port numbers passed. If connected, the connected variable is TRUE.

int Read(char *buffer, int size)

Copies the socketBuffer to buffer for the number of characters specified by size

char ReadChar()

Obtains one character in the socketBuffer array at bufferStart and then increments bufferStart

int ReadLine(char *buffer, int size)

Reads a line of data into the buffer

int ReceiveDouble(double *val)

Receives data of type double into the buffer from the socket

int ReceiveInt(int *val)

Receives data of type integer into the buffer from the socket

int ReceiveString(TSString *str)

Receives a string of data into the buffer from the socket

int ReceiveString(char *str, int size)

Receives a string of data into the buffer from the socket; specifies the number of characters to be copied into the buffer

TSSocket()

Constructor method; establishes the buffer size and calls the Initialize() method; The ancestor, CSocket, constructs a synchronous socket object and calls Create()
~TSSocket()

Destructor method; closes the socket connections and frees up the buffer

Member Variables

int bufferEnd

int bufferStart

int connected

char *socketBuffer

int socketBufferSize

TSString

Objects of this type are used to manage the strings of data transmitted to and from the database across the socket. It can be used to perform comparisons, concatenations, etc.

Methods

int CompareNoCase(const char *str)

Evaluates the contents of the buffer

void Copy(TSObject *newObjsourceString)

Uses the assignment operator to copy the contents of sourceString to the calling string’s buffer.

TSObject *Duplicate()

Allocates memory for a new TSString object; initialized with the current buffer contents

char *GetBuffer()

Obtains the contents of the buffer

char *GetBuffer(size_t minsize)

Obtains the contents of the buffer

int Length()

Obtains the size (length) of the buffer if it exists

TSObject* NewObject()

Creates a new TSString object

TSString operator + (char *str)

Adds the char parameter passed to the existing string

TSString operator + (TSString second)

Adds the string parameter passed to the existing string

TSString& operator += (TSString str)

Adds the string’s buffer onto the existing string

TSString& operator += (char c)

If there is buffer excess, it is incorporated into the buffer

TSString& operator += (char *str)

Allocates more memory to incorporate the character passed into the existing string

TSString& operator = (const char *str)

Allocates more memory to incorporate the character being referenced by the pointer in order to incorporate it into the existing string

TSString& operator = (TSString str)

Assigns the buffer of the string being passed to the existing string object

BOOL operator == (TSString str)

Used to determine if the buffer is empty

BOOL operator == (const char *str)

Used to determine if the buffer is empty

char operator [] (int idx)

Obtains the contents of the buffer at the index being passed

int SocketString(TSString &str)

Assigns the current TSString to the variable passed

TSString StringDump(int /*recursive*/, TSString indentation)

Builds a string for debugging purposes

void TrimLeft ( const char* str=NULL )void TrimLeft( const char c )

Removes spaces or the specified characters from the left side of the string.

void TrimLeft( const char c )

Removes spaces or the specified character from the left side of the string.

void TrimLeft( const TSString str )

Removes spaces or the specified characters from the left side of the of str’string buffer.

void TrimRight( const char* str=NULL )void TrimRight( const TSString str )

Removes spaces or the specified characters from the right side of the string.

void TrimRight( const char c )

Removes spaces or the specified character from the right side of the string.

void TrimRight( const char cTSString str )

Removes spaces or the specified characters from the right side of the string.

TSString(const char * str)

Constructor method; initializes the string with the data being referenced by the variable passed
TSString()

Constructor method; initializes the buffer to null

TSString(const TSString& str)

Constructor method; initializes the buffer with the buffer of the string passed

~TSString()

Destructor method; frees up the buffer then re-initializes it to null

Member Variables

char *buffer

static int BUFFER_EXCESS

unsigned int bufsize

TSTransition

The class inherits from TSRecordRef, and it describes a transition.
Methods

TSTransition( TSServer& server, int nTransitionId = 0 )

Constructor method; initializes the object and automatically sets the table id

TSTransition( const TSTransition& that )

Copy constructor.

TSTransition& operator =( const TSTransition& that )

Assignment operator.

virtual ~TSTransition()

Destructor method; destroys the object

TSString StringDump( TSString sIndentation )

Method used for debugging.

void SetTableId( int nNewTableId )

Private inherited method; not used.

Member Variables

None

TSTreeList

This class inherits from TSRecordList and should be used in place of a TSRecordList when working with tables that are recursive (Projects, Folders, Workflows, etc.) TSTreeList doesn’t have to be used, but it must be used if calling any of the FindRecord() functions on the list. These functions won’t work correctly for these tables unless a TSTreeList is used.

Methods

TSRecord *FindRecord(const char *fieldName, double searchValue)

Finds a record in the list based on the search value passed. Used for fields of type double.

TSRecord *FindRecord(const char *fieldName, int searchValue)

Finds a record in the list based on the search value passed. Used for fields of type int.

TSRecord *FindRecord(const char *fieldName, char *searchValue)

Finds a record in the list based on the search value passed. Used for fields of type char.

TSRecord *FindRecord(int recId)

Finds a record in the list based on the search id passed.

Member Variables

None

Gl