IDatabase Interface |
Namespace: SuperOffice.COM.Application
The IDatabase type exposes the following members.
Name | Description | |
---|---|---|
![]() | ActualDSN | Actual DSN logged in, depends on superoffice.ini and travel status |
![]() | ActualPrefix | Actual Prefix of logged-in connection, depends on superoffice.ini and travel status |
![]() | Admin | Admin api. Must be logged in with user level 0 to access |
![]() | Database | Returns the Database object. |
![]() | DataSourceType | Data source type - c-tree or ODBC type |
![]() | DataSourceVariant | Data source variant - central, travel, satellite db |
![]() | Dictionary | Return a data dictionary object. |
![]() | Find | Returns a Find object - has search functions that return collections |
![]() | NotepadPage | |
![]() | NotepadPages | Number of notepad pages for the current user |
![]() | Numbers | Returns an object for controlling the Number allocation system. |
![]() | OwnerContactId | Returns the id of the owner contact |
![]() | OwnerCountryId | Returns the id of the owner country |
![]() | Password | Obsolete. Use SafeCredentials instead. Always returns blank now. |
![]() | Preferences | Preference settings object |
![]() | Revision | Returns the Revision number (e.g release 5.6.30 returns 30) |
![]() | SafeCredentials | A security token that can be used instead of username+password to log in |
![]() | Settings | Get the database settings object - does not require login to use. |
![]() | StringResources | Returns a string resource manager. |
![]() | SystemOwnerContactId | Get the system owner contact id |
![]() | TimeZones | Returns a TimeZone manager object with functions for converting and listing time zone information. |
![]() | TravelInterface | Returns an object with Travel functions. |
![]() | UserAssociateId | Returns the associate id of the logged in user |
![]() | Username | The associate name of the current user. |
![]() | Utils | Returns a Utility interface. This interface may have reduced functionality in a release build |
![]() | Version | Returns the Version as a decimal (e.g. 5.6 or 6.0) |
Name | Description | |
---|---|---|
![]() | AddDocument | Add an existing file to the document archive, returning a new document object for the file. |
![]() | AddDocumentForAssociate | Add an existing file to the document archive on behalf of some associate, returning a new document object for the file. |
![]() | CreateAppointment | Returns a blank Appointment. Use SetDefaults on the returned object to fill it with sensible data. |
![]() | CreateAppointmentSentry | |
![]() | CreateAssociate | method CreateAssociate |
![]() | CreateContact | Returns a blank Contact object. Use SetDefaults on the contact object to fill it with sensible data. |
![]() | CreateContactSentry | |
![]() | CreateDocument | Creates a blank document object. Use SetDefaults on the returned object to fill it with sensible data. |
![]() | CreatePerson | Return a blank Person object. Use SetDefaults on the returned object to fill it with sensible data. |
![]() | CreatePersonSentry | |
![]() | CreateProject | Create a blank Project object. Use SetDefaults on the returned object to fill it with sensible data. |
![]() | CreateProjectMember | Create a new ProjectMember object. |
![]() | CreateProjectSentry | |
![]() | CreateRelation | Create a blank Relation object. Use the Save() method to persist the object to the database. |
![]() | CreateRelationSentry | |
![]() | CreateSale | Create a blank Sale object. Returns an error if you are not allowed to create sales. |
![]() | CreateSaleSentry | |
![]() | CreateSaleStakeholder | Create a new SaleStakeholder object. |
![]() | CreateSelection | Create a blank Selection, Returns an error if the user us not allowed to create selections. |
![]() | CreateSelectionSentry | |
![]() | ExportBlobToFile | Copy a blob to a file |
![]() | GetADOConnection | Returns an ADO Connection object for the current database. Returns an error if this is the Application.Database object. |
![]() | GetADOConnectionString | Returns an ADO connection string corresponding to the current database |
![]() | GetAppointment | Get an Appointment object by id. Returns an error if the appointment is hidden by sentry rules. |
![]() | GetAssociate | Returns an Associate object with a given associate id. |
![]() | GetAssociateList | Returns a list of associates (internal employees, associate.type=0) |
![]() | GetChecklist | |
![]() | GetContact | Returns a Contact object with a given ID. Returns an error if the contact is not readable. |
![]() | GetDocument | Get an existing document object. Returns an error if the document is hidden. |
![]() | GetDocumentFromPath | Find out if a given document is archived in SuperOffice. Returns the corresponding document object or NULL if no docplugin can recognize the path. |
![]() | GetExternalPersonList | Returns a list of all external users (associate.type=4) |
![]() | GetFavouriteItems | Returns a collection of list items in the user's favourites for the given table. |
![]() | GetHeadings | Returns a collection of Headings for a given list. |
![]() | GetHistoryItems | Returns a collection of list items in the user's history for the given table. |
![]() | GetHistoryItemsByTableNameAndExtraId | Returns a collection of list items in the user's history for the given table name and extra id. |
![]() | GetInvitations | Get a collection with all invitations for the logged in user |
![]() | GetList | Returns a collection of list items for a given list item table. |
![]() | GetListItem | Return a given List Item in a given list table. |
![]() | GetListItemByName | Return a given List Item in a given list table based on the text of the item rather than the id. |
![]() | GetLocationList | Returns a list of resources that are locations |
![]() | GetPerson | Get a Person object by person_id. Returns an error if the person is hidden by sentry rules. |
![]() | GetProject | Get an existing project from the database. Returns an error if the project is hidden. |
![]() | GetProjectMember | Get an existing ProjectMember by its projectmember_id |
![]() | GetQuote | Get an existing Quote by its quote_id |
![]() | GetQuoteAlternative | Get an existing QuoteAlternative by its quotealternative_id |
![]() | GetQuoteLine | Get an existing QuoteLine by its quoteline_id |
![]() | GetQuoteVersion | Get an existing QuoteVersion by its quoteversion_id |
![]() | GetRelation | Get a Relation object. Return an error if the relation is hidden. |
![]() | GetResourceList | Returns a list of resources (associate.type = 1) |
![]() | GetSale | Get an existing Sale object by sale_id. Returns an error if the sale is hidden. |
![]() | GetSaleStakeholder | Get an existing SaleStakeholder by its salestakeholder_id |
![]() | GetSelection | Get an existing Selection. Returns an error if the selection is not visible for the user. |
![]() | GetStagesForSaleType | Returns the valid salestages for the given saletype |
![]() | Import | Perform unattended Import using an import description file created earlier. Returns true if the import succeeded. |
![]() | ImportBlobFromFile | Copy a file into the database. Returns the blob record id. |
![]() | IsAnsiBase | Returns TRUE if database uses ANSI text, FALSE if it uses Unicode text |
![]() | Login | Log in to the database with the given user and password. Returns true if the login succeeded. |
![]() | Refresh | Reloads all the internal caches (lists, roles, users, etc). |
![]() | SubstituteTemplateVars | Substitutes template variables in the source string, returning the result. Assumes the current user. |
![]() | SubstituteTemplateVarsEx | Substitute template variables based on an associateid, returning the result. |
![]() | SubstituteTemplateVarsUrlEncoding | Substitute template variables based on an associateid, with the selected url encoding, returning the result. |