Class Appointment

Appointments, documents (document_id != 0).

Entity Object for table 'appointment'. Entity objects represent full entities with both the base table object and all related objects, such as udef, publish, visiblefor, and things like owner associate and whatever else is logically related to the base object.

Inheritance

object

NestedPersist

EntityBase

Appointment

Implements

INestedPersist

ISoItem

ITableRowLoadHandler

IEntityUdefHelperContainer

Inherited Members

EntityBase._onGetRelatedObjects

EntityBase.GetAdditionalRelatedNestedPersistViaBaseClass(List<INestedPersist>, bool)

EntityBase.OnPrimaryKeyRequest(PKContainer)

EntityBase.OnPrimaryKeyUpdate(PKContainer)

EntityBase.OnSave(BatchSave)

EntityBase.OnSaved(bool)

EntityBase.SetMarkedForDeleteOnRelatedObjects(bool)

EntityBase.OnPreIdUpdateImplementation()

EntityBase.OnIdUpdateImplementation()

EntityBase.UpdateSentryRelatedTableInfoInstance<MainTableInfoType>(SentryCollection, TableInfo)

EntityBase.IsDirty

EntityBase.OnGetRelatedObjects

NestedPersist._saveOwner

NestedPersist._isSaving

NestedPersist.SetSaveOwner(INestedPersist)

NestedPersist.Save()

NestedPersist.IsSaving

NestedPersist.OnElementSaved

NestedPersist.OnElementIdUpdate

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Entities

Assembly: SoDataBase.dll

Syntax

public class Appointment : EntityBase, INestedPersist, ISoItem, ITableRowLoadHandler, IEntityUdefHelperContainer

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

Constructors

Appointment(AppointmentIdxBase)

Constructor for class Appointment.
This object represents a row in table 'appointment'. Table contact: "Tasks, appointments, followups, phone calls; and documents"

Declaration

protected Appointment(Appointment.AppointmentIdxBase idx)

Parameters

Type	Name	Description
Appointment.AppointmentIdxBase	idx	ContactRowAppointmentRow.AppointmentRowIdx object that the Contact encapsulates.

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

Appointment(AppointmentRow, AppointmentIdxBase)

Appointments, documents (document_id != 0).

Entity Object for table 'appointment'. Entity objects represent full entities with both the base table object and all related objects, such as udef, publish, visiblefor, and things like owner associate and whatever else is logically related to the base object.

Declaration

protected Appointment(AppointmentRow row, Appointment.AppointmentIdxBase idx)

Parameters

Type	Name	Description
AppointmentRow	row
Appointment.AppointmentIdxBase	idx

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

Fields

_agenda

Related HDB object(s).

Declaration

protected TextRow _agenda

Field Value

Type	Description
TextRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_appointmentText

Related HDB object(s).

Declaration

protected TextRow _appointmentText

Field Value

Type	Description
TextRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_assignedBy

Related HDB object(s).

Declaration

protected AssociateRow _assignedBy

Field Value

Type	Description
AssociateRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_associate

Related HDB object(s).

Declaration

protected AssociateRow _associate

Field Value

Type	Description
AssociateRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_bookingMaster

Related HDB object(s).

Declaration

protected AppointmentCollection _bookingMaster

Field Value

Type	Description
AppointmentCollection

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_contact

Related HDB object(s).

Declaration

protected Contact _contact

Field Value

Type	Description
Contact

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_createdAssociate

Related HDB object(s).

Declaration

protected AssociateRow _createdAssociate

Field Value

Type	Description
AssociateRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_docTmpl

Related HDB object(s).

Declaration

protected DocTmplRow _docTmpl

Field Value

Type	Description
DocTmplRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_internalNotes

Related HDB object(s).

Declaration

protected TextRow _internalNotes

Field Value

Type	Description
TextRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_invitedPerson

Related HDB object(s).

Declaration

protected Person _invitedPerson

Field Value

Type	Description
Person

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_person

Related HDB object(s).

Declaration

protected Person _person

Field Value

Type	Description
Person

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_priority

Related HDB object(s).

Declaration

protected PriorityRow _priority

Field Value

Type	Description
PriorityRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_project

Related HDB object(s).

Declaration

protected Project _project

Field Value

Type	Description
Project

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_recurrenceRule

Related HDB object(s).

Declaration

protected RecurrenceRuleRow _recurrenceRule

Field Value

Type	Description
RecurrenceRuleRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_row

HDB object this entity is a facade for.

Declaration

protected AppointmentRow _row

Field Value

Type	Description
AppointmentRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_rowIdx

Appointments, documents (document_id != 0).

Entity Object for table 'appointment'. Entity objects represent full entities with both the base table object and all related objects, such as udef, publish, visiblefor, and things like owner associate and whatever else is logically related to the base object.

Declaration

protected Appointment.AppointmentIdxBase _rowIdx

Field Value

Type	Description
Appointment.AppointmentIdxBase

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_task

Related HDB object(s).

Declaration

protected TaskRow _task

Field Value

Type	Description
TaskRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_udefLarge

Related HDB object(s).

Declaration

protected UDAppntLargeRow _udefLarge

Field Value

Type	Description
UDAppntLargeRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_udefSmall

Related HDB object(s).

Declaration

protected UDAppntSmallRow _udefSmall

Field Value

Type	Description
UDAppntSmallRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_updatedAssociate

Related HDB object(s).

Declaration

protected AssociateRow _updatedAssociate

Field Value

Type	Description
AssociateRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

_userGroup

Related HDB object(s).

Declaration

protected UserGroupRow _userGroup

Field Value

Type	Description
UserGroupRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

Properties

ActiveDate

The date to be used for searching & showing

Declaration

public DateTime ActiveDate { get; set; }

Property Value

Type	Description
DateTime

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

ActiveLinks

Number of active links to documents, other appointments, and such

Declaration

public uint ActiveLinks { get; set; }

Property Value

Type	Description
uint

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

Agenda

Related object TextRow: Agenda text

Declaration

public TextRow Agenda { get; set; }

Property Value

Type	Description
TextRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

Alarm

Alarm leadtime, the alarm flag has moved to hasAlarm

Declaration

public short Alarm { get; set; }

Property Value

Type	Description
short

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

AlldayEvent

Is this an all day event: 0 = No, 1 = Yes

Declaration

public AllDayEvent AlldayEvent { get; set; }

Property Value

Type	Description
AllDayEvent

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

AppointmentId

Primary key

Declaration

public int AppointmentId { get; }

Property Value

Type	Description
int

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

AppointmentText

Related object TextRow: Long text fields from all over the system

Declaration

public TextRow AppointmentText { get; set; }

Property Value

Type	Description
TextRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

AssignedBy

Related object AssociateRow: Employees, resources and other users - except for External persons

Declaration

public AssociateRow AssignedBy { get; set; }

Property Value

Type	Description
AssociateRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

Associate

Related object AssociateRow: Employees, resources and other users - except for External persons

Declaration

public AssociateRow Associate { get; set; }

Property Value

Type	Description
AssociateRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

BookingMaster

Related object AppointmentCollection: "Tasks, appointments, followups, phone calls; and documents"

Declaration

public AppointmentCollection BookingMaster { get; }

Property Value

Type	Description
AppointmentCollection

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

BookingType

Appointments, documents (document_id != 0).

Entity Object for table 'appointment'. Entity objects represent full entities with both the base table object and all related objects, such as udef, publish, visiblefor, and things like owner associate and whatever else is logically related to the base object.

Declaration

public BookingType BookingType { get; }

Property Value

Type	Description
BookingType

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

ColorIndex

Appointment colour, used only in Japanese versions. Western versions take colour from Task

Declaration

public short ColorIndex { get; set; }

Property Value

Type	Description
short

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

Contact

Related object Contact: Companies and Organisations

Declaration

public Contact Contact { get; set; }

Property Value

Type	Description
Contact

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

CreatedAssociate

Related object AssociateRow: Employees, resources and other users - except for External persons

Declaration

public AssociateRow CreatedAssociate { get; set; }

Property Value

Type	Description
AssociateRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

CustomFields

Appointments, documents (document_id != 0).

Entity Object for table 'appointment'. Entity objects represent full entities with both the base table object and all related objects, such as udef, publish, visiblefor, and things like owner associate and whatever else is logically related to the base object.

Declaration

public EntityCustomFieldsHelper CustomFields { get; }

Property Value

Type	Description
EntityCustomFieldsHelper

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

DoBy

date + start time planned

Declaration

public DateTime DoBy { get; set; }

Property Value

Type	Description
DateTime

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

DocTmpl

Related object DocTmplRow: Document template list table, valid where appointment is actually a document

Declaration

public DocTmplRow DocTmpl { get; set; }

Property Value

Type	Description
DocTmplRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

Done

date + start time this task was done

Declaration

public DateTime Done { get; set; }

Property Value

Type	Description
DateTime

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

EndDate

Date + end time planned

Declaration

public DateTime EndDate { get; set; }

Property Value

Type	Description
DateTime

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

ExtraFields

Appointments, documents (document_id != 0).

Entity Object for table 'appointment'. Entity objects represent full entities with both the base table object and all related objects, such as udef, publish, visiblefor, and things like owner associate and whatever else is logically related to the base object.

Declaration

public EntityExtraFieldsHelper ExtraFields { get; }

Property Value

Type	Description
EntityExtraFieldsHelper

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

FreeBusy

What kind of time is this: 0 = Busy, 1 = Free

Declaration

public FreeBusy FreeBusy { get; set; }

Property Value

Type	Description
FreeBusy

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

HasAlarm

Does this appointment have an alarm

Declaration

public short HasAlarm { get; set; }

Property Value

Type	Description
short

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

InternalNotes

Related object TextRow: Agenda text

Declaration

public TextRow InternalNotes { get; set; }

Property Value

Type	Description
TextRow

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the AppointmentCollection collection, which has nested classes and GetFromIdx methods for each non-unique index. There are no 'GetFromReader' methods, since that would be rather complex (multiple TableInfo objects required).

Unique indexes on Appointment are:

Index fields	Nested index class name
AppointmentId	AppointmentId: Primary key Nested index class: Appointment.IdxAppointmentId Static Get method: GetFromIdxAppointmentId(int)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Type: See note. DocumentId: Points to document record; 0 for non-document appointments! AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? AssociateId: ID of associate whose diary the appointment is in, REQUIRED ProjectId: ID of project referred to, may be 0 GroupIdx: Group of owning associate at the time the appnt was created Registered: Registered on RegisteredAssociateId: Registered by Nested index class: Appointment.IdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId Static Get method: GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId(DateTime, int, AppointmentType, int, int, int, int, int, int, DateTime, int)
ActiveDate, AssociateId, AppointmentId, MotherId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status AssociateId: ID of associate whose diary the appointment is in, REQUIRED AppointmentId: Primary key MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: Appointment.IdxActiveDateAssociateIdAppointmentIdMotherId Static Get method: GetFromIdxActiveDateAssociateIdAppointmentIdMotherId(DateTime, int, int, int)
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateId	AssociateId: ID of associate whose diary the appointment is in, REQUIRED GroupIdx: Group of owning associate at the time the appnt was created ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Type: See note. Registered: Registered on MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment AppointmentId: Primary key AssignedBy: Who (last) assigned this appointment to associate_id? Status: See note. RegisteredAssociateId: Registered by Nested index class: Appointment.IdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId Static Get method: GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId(int, int, DateTime, AppointmentType, DateTime, int, int, int, AppointmentStatus, int)

Non-unique indexes on table Appointment are:

Index fields	Nested index class name
ActiveDate, Status, Type, AssociateId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Status: See note. Type: See note. AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxActiveDateStatusTypeAssociateId Static Get method: GetFromIdxActiveDateStatusTypeAssociateId(DateTime, AppointmentStatus, AppointmentType, int)
ContactId, Type	ContactId: Contact ID of owning contact, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxContactIdType Static Get method: GetFromIdxContactIdType(int, AppointmentType)
ProjectId, Type	ProjectId: ID of project referred to, may be 0 Type: See note. Nested index class: AppointmentCollection.IdxProjectIdType Static Get method: GetFromIdxProjectIdType(int, AppointmentType)
MotherId	MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment Nested index class: AppointmentCollection.IdxMotherId Static Get method: GetFromIdxMotherId(int)
DoBy, Type, EndDate, AssociateId	DoBy: Date + start time planned Type: See note. EndDate: Date + end time planned AssociateId: ID of associate whose diary the appointment is in, REQUIRED Nested index class: AppointmentCollection.IdxDoByTypeEndDateAssociateId Static Get method: GetFromIdxDoByTypeEndDateAssociateId(DateTime, AppointmentType, DateTime, int)
ActiveDate	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxActiveDate Static Get method: GetFromIdxActiveDate(DateTime)
AssociateId, DoBy, Status, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED DoBy: Date + start time planned Status: See note. Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdDoByStatusType Static Get method: GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType)
ActiveDate, MotherId, RecurrenceRuleId	ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status MotherId: ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 Nested index class: AppointmentCollection.IdxActiveDateMotherIdRecurrenceRuleId Static Get method: GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int)
Source	Source: For future integration use; source of record Nested index class: AppointmentCollection.IdxSource Static Get method: GetFromIdxSource(short)
ContactId	ContactId: Contact ID of owning contact, may be 0 Nested index class: AppointmentCollection.IdxContactId Static Get method: GetFromIdxContactId(int)
ProjectId	ProjectId: ID of project referred to, may be 0 Nested index class: AppointmentCollection.IdxProjectId Static Get method: GetFromIdxProjectId(int)
DocumentId	DocumentId: Points to document record; 0 for non-document appointments! Nested index class: AppointmentCollection.IdxDocumentId Static Get method: GetFromIdxDocumentId(int)
AssociateId, Status, Done, Type	AssociateId: ID of associate whose diary the appointment is in, REQUIRED Status: See note. Done: Date + start time this task was actually performed Type: See note. Nested index class: AppointmentCollection.IdxAssociateIdStatusDoneType Static Get method: GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType)
PersonId	PersonId: Person ID of person the appointment is with, may be 0; if nonzero, must match the contact_id (which must then also be nonzero). Nested index class: AppointmentCollection.IdxPersonId Static Get method: GetFromIdxPersonId(int)
AssociateId, RecurrenceRuleId, ActiveDate	AssociateId: ID of associate whose diary the appointment is in, REQUIRED RecurrenceRuleId: Pointer to recurrence rule, for recurring appointments, otherwise 0 ActiveDate: The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status Nested index class: AppointmentCollection.IdxAssociateIdRecurrenceRuleIdActiveDate Static Get method: GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime)
GroupIdx	GroupIdx: Group of owning associate at the time the appnt was created Nested index class: AppointmentCollection.IdxGroupIdx Static Get method: GetFromIdxGroupIdx(int)
UserdefId	UserdefId: User-defined table record 1 (for future use) Nested index class: AppointmentCollection.IdxUserdefId Static Get method: GetFromIdxUserdefId(int)
DoBy	DoBy: Date + start time planned Nested index class: AppointmentCollection.IdxDoBy Static Get method: GetFromIdxDoBy(DateTime)
TextId	TextId: ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record Nested index class: AppointmentCollection.IdxTextId Static Get method: GetFromIdxTextId(int)
Userdef2Id	Userdef2Id: User-defined table record 2 (for future use) Nested index class: AppointmentCollection.IdxUserdef2Id Static Get method: GetFromIdxUserdef2Id(int)
Done	Done: Date + start time this task was actually performed Nested index class: AppointmentCollection.IdxDone Static Get method: GetFromIdxDone(DateTime)

InvitedPerson

Related object Person: Persons in a company or an organisation

Declaration

public Person InvitedPerson { get; set; }

Property Value

Type	Description
Person

Remarks

Entity objects can be created in several ways.

• Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the SuperOffice.CRM.Data.Appointment.Save method and corresponding row(s) in the database are created, and the objects' primary key field updated. This is the preferred way to insert new entities into the database.
• You can create a (nested) Appointment Appointment.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(CustomSearch) method to apply the query to the database and obtain the result as an Entity object. This is how you select existing entities from the database when you have a query that does not correspond to any of the existing database indexes.
• For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the SuperOffice.CRM.Data.Appointment.IsNew and SuperOffice.CRM.Data.Appointment.IsDirty properties set to true. Such an Entity object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.

Non-unique indexes are handled through the App