IPerson Interface |
Namespace: SuperOffice.COM.SuperOfficeDB
The IPerson type exposes the following members.
Name | Description | |
---|---|---|
![]() | ActiveLinks | ActiveLinks - Number of active links to documents, projects, Urls, appointments, sales, contacts, persons, selections |
![]() | ActivityLinks | The ActivityLinks attached to this person. Add or remove links on this object. |
![]() ![]() | Address | Personal Address - the person will use the contact's address unless the UseAsMailingAddress flag is also set.
Returns the contact person’s address object |
![]() ![]() | Associate | The owning associate for the person. Not currently used. Should be id = 0. |
![]() ![]() | AutoSaveOnChangeIdentity | Should the model save on IdentityChanged? |
![]() ![]() | AutoSaveOnFlush | Should the model save on flush cache? |
![]() | AvailableConsents | Get collection of available ConsentPersons. Those that are not yet stored will have a ConsetPurpose id only |
![]() ![]() | Business | The person business - not currently used. |
![]() ![]() | Category | The persons category - not currently used. |
![]() ![]() | Changed | has record been changed since read?
If the person has been modified since it was loaded, this will return false |
![]() | ChatAddresses | Chat address object collection |
![]() ![]() | Contact | Contact that this person belongs to.
The contact the contact person is registered on. This is required |
![]() ![]() | CorrespondingAssociate | IAssociate object if the Person is an associate, else empty Associate object (id=0) |
![]() ![]() | Country | The person's country - a list item - table enTableCntry=19
The country this contact person is located in |
![]() ![]() | CreatedAssociate | The user that created the object
The associate that first created the contact person |
![]() ![]() | CreatedDate | The date the object was saved to the database.
The date and time the contact person was first created |
![]() ![]() | DayOfBirth | Day Of Birth (1-31)
The person object’s day of birth |
![]() ![]() | Department | The persons Department |
![]() ![]() | Emails | Email object collection
Returns a collection of email objects |
![]() | ExternalFieldChanged | have external fields been changed? |
![]() ![]() | FirstName | FirstName
The person object’s first name |
![]() ![]() | ForeignKey | ForeignKey object
Get the foreign key values for this person. May be used to connect a person to an external application where you need more settings |
![]() ![]() | FormattedAddress | FormattedAddress
Returns the mailing address (No contact person information) of the contact person formatted according to the national rules. Useful when generating address labels. Does not include the contact name. Uses the contact address if the person has no address. |
![]() ![]() | FormattedLabel | FormattedLabel = name + formatted address
Returns the name and mailing address of the contact person formatted according to the national rules. Useful when generating address labels. Uses the contact address if the person has no address |
![]() | FullName | |
![]() ![]() | Group | Primary User Group of owning associate. Set implicitly by AssociateId. Not currently used. |
![]() ![]() | HasPicture | Returns true if the person has a picture |
![]() ![]() | Identity | The primary key on the primary table. Is zero for new objects. Is set when an object is saved.
This is the internal ID of the contact person |
![]() ![]() | Information | Information text
Contact person information is the textbox used to add more information about a contact person. Open up a contact person card, and “Information” is the last archive card |
![]() ![]() | Interests | Interest object collection
Returns a collection of SOInterests objects |
![]() ![]() | IsAssociate | Return true if the person represents an internal user
Checks if the person object is an associate |
![]() ![]() | IsAvailable | is record available in db?
Checks if the record is available in the database. It’s useful to check if a person actually exists before adding new properties to it |
![]() ![]() | IsExternalPerson | returns true if this person has a login of type 4 |
![]() | IsFavourite | Add/Remove this person from my favourites |
![]() ![]() | IsRequiredFilled | Are all the required fields filled out? Can we save the record?
Checks if all properties that are required in this model is filled |
![]() ![]() | IsValid | does the record exist?
To save time, we don’t load a record into buffer before one of its properties is asked for. This checks if the requested record is available in buffer |
![]() ![]() | LastName | LastName
The person object’s surname |
![]() ![]() | MiddleName | MiddleName
From CRM 5 Release 5.5 you may enable the use of middle name. This field is not visible in the person dialog before you enable this preference, but you may set the middle name property and see it in the person archive |
![]() ![]() | MonthOfBirth | Month Of Birth (1-12) e.g. 6
The person object’s month of birth |
![]() ![]() | MrMrs | Mr or Mrs prefix. May be blank.
The contact person’s salutation |
![]() ![]() | NoDM | No Direct Mail - no spam to this person
Is the person marked with “No mailings”? |
![]() ![]() | Number | Number
Returns the number field on the person |
![]() ![]() | Phones | Phone object collection
Returns a collection of phone numbers that belong to the contact person |
![]() ![]() | Picture | Returns the person picture as an ISOPicture object. |
![]() ![]() | Position | Position in organization - list item - table enTablePersPos=76
The person’s position. This is a list defined by the database administrator |
![]() ![]() | Retired | Retired checkbox
Retired is used to hide contact persons that no longer work for the contact, they may be hidden so you only see the currently employed contact persons in the company. |
![]() ![]() | Salutation | Salutation for the person |
![]() ![]() | Sentry | Sentry settings for this object. Lets you find out your read/write access to the object. |
![]() | StoredConsents | Get collection of stored ConsentPersons. |
![]() | StoredShipmentTypeReservations | Get collection of stored ShipmentTypeReservations. |
![]() ![]() | Title | Job description
The Contact person dialog has a title field that may be used to register the person’s professional title. |
![]() ![]() | UDef | User-defined fields object
A collection of the Persons user defined fields |
![]() ![]() | UpdatedAssociate | The last user to modify the object
The last associate that updated this contact person. If the contact person has never been updated, this will return 0 |
![]() ![]() | UpdatedDate | The date of the most recent update.
The date and time the contact person was last edited. If the contact person never has been updated, this will return 0, formatted as a SuperOffice date (see the database manual), this will return 01.01.1970 |
![]() | Urls | Web addresses |
![]() ![]() | UseAsMailingAddress | Use person address instead of contact address?
Is the Use as mailing address marked so the person address should be used in stead of the company address? |
![]() | ValidationMessage | get validation message, if empty model will think it is ok to save |
![]() | VoIPAddresses | VoIP address object collection |
![]() ![]() | YearOfBirth | Year Of Birth e.g. 1969
The person object’s year of birth |
Name | Description | |
---|---|---|
![]() | AddConsentByIds | Add ConsentPerson by ConsentPurpose Id, LegalBase Id, ConsentSource Id, Comment. All parameters will be verified! |
![]() | AddConsentByNames | Add ConsentPerson by ConsentPurpose Name, LegalBase Name, ConsentSource Name, Comment. All parameters will be verified! |
![]() | AddConsentByRecord | Add ConsentPerson by ConsentPerson. All identy parameters will be verified! |
![]() ![]() | CancelChanges | Undo any changes made since the object was loaded.
If you made changes to the model that you don’t want to be saved to the database, call the CancelChanges method |
![]() ![]() | ChangeIdentity | Loads a different record into the object. Causes changes to the existing object to be saved first.
Saves the changes made to the person model to the database, and retrieves the new data from the database again. The last thing you do to an object if you want the changes you made to be saved. The ChangeIdentity method calls the save method first |
![]() ![]() | Delete | Delete the object from the database. May throw an error if you are not allowed to delete the object. |
![]() | GetConsentById | Get ConsentPerson for given ConsentPurpose Id |
![]() | GetConsentByName | Get ConsentPerson for given ConsentPurpose unique key name |
![]() | GetRelations | Get all relations with connection to this person |
![]() | IsShipmentTypeReserved | Is ShipmentType reserved? |
![]() | MergeTo | Merges this person into the other person, optionally together with his appointments |
![]() | MoveTo | Moves a person to a new contact, optionally together with his appointments |
![]() | RemoveConsentById | Remove ConsentPerson by ConsentPurpose Id |
![]() | RemoveConsentByName | Remove ConsentPerson by ConsentPurpose Name |
![]() ![]() | Save | Persist the object to the database. May throw an error if you are not allowed to save changes to the object. |
![]() ![]() | SetDefaults | Populate the object with default values, such as setting the owner to the current user.
Uses the UserPreferences table to set the predefined default settings for a person. The SetDefaults method is only available for current in this version of SuperOfficeDB Type Library |
![]() | SetShipmentTypeReserved | Set ShipmentType reserved |