Click or drag to resize

DatabaseClass Methods

The DatabaseClass type exposes the following members.

Methods
  NameDescription
Public methodAddDocument
Add an existing file to the document archive, returning a new document object for the file.
Public methodAddDocumentForAssociate
Add an existing file to the document archive on behalf of some associate, returning a new document object for the file.
Public methodCreateAppointment
Returns a blank Appointment. Use SetDefaults on the returned object to fill it with sensible data.
Public methodCreateAppointmentSentry
Public methodCreateAssociate
method CreateAssociate
Public methodCreateContact
Returns a blank Contact object. Use SetDefaults on the contact object to fill it with sensible data.
Public methodCreateContactSentry
Public methodCreateDocument
Creates a blank document object. Use SetDefaults on the returned object to fill it with sensible data.
Public methodCreatePerson
Return a blank Person object. Use SetDefaults on the returned object to fill it with sensible data.
Public methodCreatePersonSentry
Public methodCreateProject
Create a blank Project object. Use SetDefaults on the returned object to fill it with sensible data.
Public methodCreateProjectMember
Create a new ProjectMember object.
Public methodCreateProjectSentry
Public methodCreateRelation
Create a blank Relation object. Use the Save() method to persist the object to the database.
Public methodCreateRelationSentry
Public methodCreateSale
Create a blank Sale object. Returns an error if you are not allowed to create sales.
Public methodCreateSaleSentry
Public methodCreateSaleStakeholder
Create a new SaleStakeholder object.
Public methodCreateSelection
Create a blank Selection, Returns an error if the user us not allowed to create selections.
Public methodCreateSelectionSentry
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExportBlobToFile
Copy a blob to a file
Public methodGetADOConnection
Returns an ADO Connection object for the current database. Returns an error if this is the Application.Database object.
Public methodGetADOConnectionString
Returns an ADO connection string corresponding to the current database
Public methodGetAppointment
Get an Appointment object by id. Returns an error if the appointment is hidden by sentry rules.
Public methodGetAssociate
Returns an Associate object with a given associate id.
Public methodGetAssociateList
Returns a list of associates (internal employees, associate.type=0)
Public methodGetChecklist
Public methodGetContact
Returns a Contact object with a given ID. Returns an error if the contact is not readable.
Public methodGetDocument
Get an existing document object. Returns an error if the document is hidden.
Public methodGetDocumentFromPath
Find out if a given document is archived in SuperOffice. Returns the corresponding document object or NULL if no docplugin can recognize the path.
Public methodGetExternalPersonList
Returns a list of all external users (associate.type=4)
Public methodGetFavouriteItems
Returns a collection of list items in the user's favourites for the given table.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetHeadings
Returns a collection of Headings for a given list.
Public methodGetHistoryItems
Returns a collection of list items in the user's history for the given table.
Public methodGetHistoryItemsByTableNameAndExtraId
Returns a collection of list items in the user's history for the given table name and extra id.
Public methodGetInvitations
Get a collection with all invitations for the logged in user
Public methodGetList
Returns a collection of list items for a given list item table.
Public methodGetListItem
Return a given List Item in a given list table.
Public methodGetListItemByName
Return a given List Item in a given list table based on the text of the item rather than the id.
Public methodGetLocationList
Returns a list of resources that are locations
Public methodGetPerson
Get a Person object by person_id. Returns an error if the person is hidden by sentry rules.
Public methodGetProject
Get an existing project from the database. Returns an error if the project is hidden.
Public methodGetProjectMember
Get an existing ProjectMember by its projectmember_id
Public methodGetQuote
Get an existing Quote by its quote_id
Public methodGetQuoteAlternative
Get an existing QuoteAlternative by its quotealternative_id
Public methodGetQuoteLine
Get an existing QuoteLine by its quoteline_id
Public methodGetQuoteVersion
Get an existing QuoteVersion by its quoteversion_id
Public methodGetRelation
Get a Relation object. Return an error if the relation is hidden.
Public methodGetResourceList
Returns a list of resources (associate.type = 1)
Public methodGetSale
Get an existing Sale object by sale_id. Returns an error if the sale is hidden.
Public methodGetSaleStakeholder
Get an existing SaleStakeholder by its salestakeholder_id
Public methodGetSelection
Get an existing Selection. Returns an error if the selection is not visible for the user.
Public methodGetStagesForSaleType
Returns the valid salestages for the given saletype
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodImport
Perform unattended Import using an import description file created earlier. Returns true if the import succeeded.
Public methodImportBlobFromFile
Copy a file into the database. Returns the blob record id.
Public methodIsAnsiBase
Returns TRUE if database uses ANSI text, FALSE if it uses Unicode text
Public methodLogin
Log in to the database with the given user and password. Returns true if the login succeeded.
Public methodRefresh
Reloads all the internal caches (lists, roles, users, etc).
Public methodSubstituteTemplateVars
Substitutes template variables in the source string, returning the result. Assumes the current user.
Public methodSubstituteTemplateVarsEx
Substitute template variables based on an associateid, returning the result.
Public methodSubstituteTemplateVarsUrlEncoding
Substitute template variables based on an associateid, with the selected url encoding, returning the result.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also