Show / Hide Table of Contents

Class AppointmentCollection

Appointments, documents (document_id != 0).

Collection of Appointment. Each element of the collection represents one entity based on Appointment.
Inheritance
object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
EntityCollectionBase
AppointmentCollection
Implements
INestedPersist
IEnumerable<INestedPersist>
INotifyCollectionChanged
IBindingList
IList
ICollection
IEnumerable
Inherited Members
EntityCollectionBase._innerList
EntityCollectionBase.DeleteAsync()
EntityCollectionBase.GetEnumerator()
EntityCollectionBase.Add(EntityBase)
EntityCollectionBase.Remove(EntityBase)
EntityCollectionBase.CopyTo(Array, int)
EntityCollectionBase.IndexOf(object)
EntityCollectionBase.Contains(object)
EntityCollectionBase.AddIndex(PropertyDescriptor)
EntityCollectionBase.ApplySort(PropertyDescriptor, ListSortDirection)
EntityCollectionBase.Find(PropertyDescriptor, object)
EntityCollectionBase.RemoveIndex(PropertyDescriptor)
EntityCollectionBase.RemoveSort()
EntityCollectionBase.IsDirty
EntityCollectionBase.Count
EntityCollectionBase.IsFixedSize
EntityCollectionBase.IsReadOnly
EntityCollectionBase.AllowEdit
EntityCollectionBase.AllowNew
EntityCollectionBase.AllowRemove
EntityCollectionBase.IsSorted
EntityCollectionBase.SortDirection
EntityCollectionBase.SortProperty
EntityCollectionBase.SupportsChangeNotification
EntityCollectionBase.SupportsSearching
EntityCollectionBase.SupportsSorting
EntityCollectionBase.CollectionChanged
EntityCollectionBase.ListChanged
NestedCollectionPersist.GetFacadingItems()
NestedCollectionPersist.IsDeleted
NestedPersistFacade.OnPreIdUpdateAsync()
NestedPersistFacade.OnPrimaryKeyRequestAsync(PKContainer)
NestedPersistFacade.OnPrimaryKeyUpdateAsync(PKContainer)
NestedPersistFacade.OnIdUpdateAsync()
NestedPersistFacade.OnSaveAsync(BatchSave)
NestedPersistFacade.OnSavedAsync(bool)
NestedPersist._saveOwner
NestedPersist._isSaving
NestedPersist.SetSaveOwner(INestedPersist)
NestedPersist.SaveAsync()
NestedPersist.IsSaving
NestedPersist.IsMarkedForDelete
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 AppointmentCollection : EntityCollectionBase, INestedPersist, IEnumerable<INestedPersist>, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

Constructors

AppointmentCollection(AppointmentCollectionIdx)

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

Declaration
protected AppointmentCollection(AppointmentCollection.AppointmentCollectionIdx idx)
Parameters
Type Name Description
AppointmentCollection.AppointmentCollectionIdx idx
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

Fields

_idx

Fetcher class the collection is based on

Declaration
protected AppointmentCollection.AppointmentCollectionIdx _idx
Field Value
Type Description
AppointmentCollection.AppointmentCollectionIdx
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

_rows

Row objects that the collection is based on.

Declaration
protected AppointmentRows _rows
Field Value
Type Description
AppointmentRows
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

Properties

Index

Retrieve the index for AppointmentCollection

Declaration
public AppointmentCollection.AppointmentCollectionIdx Index { get; }
Property Value
Type Description
AppointmentCollection.AppointmentCollectionIdx
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

this[int]

Get a Appointment from the collection from its zero-based index.

Declaration
public Appointment this[int index] { get; }
Parameters
Type Name Description
int index

Zero-based index in the collection.

Property Value
Type Description
Appointment
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

Rows

The ecapsulated object AppointmentRows.

Declaration
public AppointmentRows Rows { get; }
Property Value
Type Description
AppointmentRows
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

Sentries

The collection of sentries that are guarding this collection of rows. This collection is used by RDB entities which return HDB collections.

For example, the contact.Faxes returns a PhoneRows collection in which each row will need to check the contact's sentry for permission to read/write their field

Declaration
public override SentryCollection Sentries { get; }
Property Value
Type Description
SentryCollection
Overrides
EntityCollectionBase.Sentries
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

Methods

Add(Appointment)

Add one Appointment to the collection.

Declaration
public int Add(Appointment appointment)
Parameters
Type Name Description
Appointment appointment

An instance of Appointment to be added to the collection.

Returns
Type Description
int

The index of the added Appointment.

Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

AddNew()

Get a new instance of Appointment added to the collection.

Declaration
public Appointment AddNew()
Returns
Type Description
Appointment

A new instance of Appointment added to the collection.

Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

CreateChild()

Create a new instance of Appointment

Declaration
protected override EntityBase CreateChild()
Returns
Type Description
EntityBase

New instance of Appointment

Overrides
EntityCollectionBase.CreateChild()
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

CreateNew()

Create a new instance of the AppointmentCollection.

Declaration
public static AppointmentCollection CreateNew()
Returns
Type Description
AppointmentCollection

A new instance of the AppointmentCollection.

Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

Create a new instance of the AppointmentCollection object, and populate it with data from a custom search. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of AppointmentRow objects representing each row will be returned.

Declaration
public static Task<AppointmentCollection> GetFromCustomSearchAsync(AppointmentCollection.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
Type Name Description
AppointmentCollection.CustomSearch query

The custom search to execute against the database

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

A new instance of the AppointmentCollection object, reflecting the result of the query.

Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

GetFromIdxActiveDate(DateTime, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxActiveDate(DateTime activeDate, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime activeDate

The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntActiveDate. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime, int, int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxActiveDateMotherIdRecurrenceRuleId(DateTime activeDate, int motherId, int recurrenceRuleId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime activeDate

The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status

int motherId

ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment

int recurrenceRuleId

Pointer to recurrence rule, for recurring appointments, otherwise 0

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IRecurrenceRuleIdActiveDateMother_id. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxActiveDateStatusTypeAssociateIdAsync(DateTime, AppointmentStatus, AppointmentType, int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxActiveDateStatusTypeAssociateIdAsync(DateTime activeDate, AppointmentStatus status, AppointmentType type, int associateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime activeDate

The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status

AppointmentStatus status

See note.

AppointmentType type

See note.

int associateId

ID of associate whose diary the appointment is in, REQUIRED

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IAssoc_idTypeStatusActiveDate. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxAssociateIdDoByStatusType(int, DateTime, AppointmentStatus, AppointmentType, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxAssociateIdDoByStatusType(int associateId, DateTime doBy, AppointmentStatus status, AppointmentType type, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int associateId

ID of associate whose diary the appointment is in, REQUIRED

DateTime doBy

Date + start time planned

AppointmentStatus status

See note.

AppointmentType type

See note.

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IAssoc_idTypeStatusDo_by. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int, int, DateTime, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxAssociateIdRecurrenceRuleIdActiveDate(int associateId, int recurrenceRuleId, DateTime activeDate, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int associateId

ID of associate whose diary the appointment is in, REQUIRED

int recurrenceRuleId

Pointer to recurrence rule, for recurring appointments, otherwise 0

DateTime activeDate

The date to be used for searching & showing, is either the same as the done or do_by dates depending on type and status

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IRecurrenceRuleIdActiveDateAssoc_id. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxAssociateIdStatusDoneType(int, AppointmentStatus, DateTime, AppointmentType, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxAssociateIdStatusDoneType(int associateId, AppointmentStatus status, DateTime done, AppointmentType type, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int associateId

ID of associate whose diary the appointment is in, REQUIRED

AppointmentStatus status

See note.

DateTime done

Date + start time this task was actually performed

AppointmentType type

See note.

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IAssoc_idTypeStatusDone. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxContactId(int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxContactId(int contactId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int contactId

Contact ID of owning contact, may be 0

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntCont_id. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxContactIdTypeAsync(int, AppointmentType, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxContactIdTypeAsync(int contactId, AppointmentType type, CancellationToken cancellationToken)
Parameters
Type Name Description
int contactId

Contact ID of owning contact, may be 0

AppointmentType type

See note.

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index ICont_idType. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxDoBy(DateTime, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxDoBy(DateTime doBy, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime doBy

Date + start time planned

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntDo_by. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxDoByTypeEndDateAssociateIdAsync(DateTime, AppointmentType, DateTime, int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxDoByTypeEndDateAssociateIdAsync(DateTime doBy, AppointmentType type, DateTime endDate, int associateId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime doBy

Date + start time planned

AppointmentType type

See note.

DateTime endDate

Date + end time planned

int associateId

ID of associate whose diary the appointment is in, REQUIRED

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IAssoc_idTypeEndDateDo_by. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxDocumentId(int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxDocumentId(int documentId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int documentId

Points to document record; 0 for non-document appointments!

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntDoc_id. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxDone(DateTime, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxDone(DateTime done, CancellationToken cancellationToken = default)
Parameters
Type Name Description
DateTime done

Date + start time this task was actually performed

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntDone. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxGroupIdx(int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxGroupIdx(int groupIdx, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int groupIdx

Group of owning associate at the time the appnt was created

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntGrp_idx. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxMotherIdAsync(int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxMotherIdAsync(int motherId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int motherId

ID of mother appointment; self if booking master, master ID if booking slave, 0 if normal appointment

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntMother_id. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxPersonId(int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxPersonId(int personId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int 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).

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntPers_id. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxProjectId(int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxProjectId(int projectId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int projectId

ID of project referred to, may be 0

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntProj_id. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxProjectIdTypeAsync(int, AppointmentType, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxProjectIdTypeAsync(int projectId, AppointmentType type, CancellationToken cancellationToken)
Parameters
Type Name Description
int projectId

ID of project referred to, may be 0

AppointmentType type

See note.

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IProj_idType. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxSource(short, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxSource(short source, CancellationToken cancellationToken = default)
Parameters
Type Name Description
short source

For future integration use; source of record

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntSource. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxTextId(int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxTextId(int textId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int textId

ID of record containing appointment text, may be 0 for no text; note that bookings share a common text record

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntText_id. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxUserdef2Id(int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxUserdef2Id(int userdef2Id, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int userdef2Id

User-defined table record 2 (for future use)

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntUdef2_id. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

GetFromIdxUserdefId(int, CancellationToken)

Create a new instance of the AppointmentRows object, and populate it with AppointmentRow objects based on the result of a query on the table Appointment. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<AppointmentCollection> GetFromIdxUserdefId(int userdefId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int userdefId

User-defined table record 1 (for future use)

CancellationToken cancellationToken
Returns
Type Description
Task<AppointmentCollection>

New AppointmentRows collection containing the result of the index query. If no rows matched, the collection will be empty.

Remarks

The query matches the fields on the non-unique index IDXAppntUdef_id. Unique indexes have corresponding Create methods directly on the AppointmentRow object, since such indexes always return zero or one rows.

Remove(Appointment)

Removes the given Appointment from the collection

Declaration
public void Remove(Appointment appointment)
Parameters
Type Name Description
Appointment appointment

the Appointment to be removed

Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

ToArray()

Appointments, documents (document_id != 0).

Collection of Appointment. Each element of the collection represents one entity based on Appointment.
Declaration
public Appointment[] ToArray()
Returns
Type Description
Appointment[]
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()
Remarks

Entity collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Appointment to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) AppointmentCollection AppointmentCollection.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 method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the Appointment object directly, which has nested classes and GetFromIdx methods for each unique index.

Unique indexes on table Appointment are:
Index fieldsNested index class name
AppointmentIdAppointmentId:

Primary key

Nested index class: Appointment.IdxAppointmentId

Static Get method: GetFromIdxAppointmentIdAsync(int, CancellationToken)
ActiveDate, MotherId, Type, DocumentId, AppointmentId, AssignedBy, AssociateId, ProjectId, GroupIdx, Registered, RegisteredAssociateIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateMotherIdTypeDocumentIdAppointmentIdAssignedByAssociateIdProjectIdGroupIdxRegisteredRegisteredAssociateId
ActiveDate, AssociateId, AppointmentId, MotherIdActiveDate:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxActiveDateAssociateIdAppointmentIdMotherId
AssociateId, GroupIdx, ActiveDate, Type, Registered, MotherId, AppointmentId, AssignedBy, Status, RegisteredAssociateIdAssociateId:

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: SuperOffice.CRM.Entities.Appointment.GetFromIdxAssociateIdGroupIdxActiveDateTypeRegisteredMotherIdAppointmentIdAssignedByStatusRegisteredAssociateId
Non-unique indexes on table Appointment are:
Index fieldsNested index class name
ActiveDate, Status, Type, AssociateIdActiveDate:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxActiveDateStatusTypeAssociateId
ContactId, TypeContactId:

Contact ID of owning contact, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxContactIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxContactIdType
ProjectId, TypeProjectId:

ID of project referred to, may be 0

Type:

See note.

Nested index class: AppointmentCollection.IdxProjectIdType

Static Get method: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxProjectIdType
MotherIdMotherId:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxMotherId
DoBy, Type, EndDate, AssociateIdDoBy:

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: SuperOffice.CRM.Entities.AppointmentCollection.GetFromIdxDoByTypeEndDateAssociateId
ActiveDateActiveDate:

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, CancellationToken)
AssociateId, DoBy, Status, TypeAssociateId:

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, CancellationToken)
ActiveDate, MotherId, RecurrenceRuleIdActiveDate:

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, CancellationToken)
SourceSource:

For future integration use; source of record

Nested index class: AppointmentCollection.IdxSource

Static Get method: GetFromIdxSource(short, CancellationToken)
ContactIdContactId:

Contact ID of owning contact, may be 0

Nested index class: AppointmentCollection.IdxContactId

Static Get method: GetFromIdxContactId(int, CancellationToken)
ProjectIdProjectId:

ID of project referred to, may be 0

Nested index class: AppointmentCollection.IdxProjectId

Static Get method: GetFromIdxProjectId(int, CancellationToken)
DocumentIdDocumentId:

Points to document record; 0 for non-document appointments!

Nested index class: AppointmentCollection.IdxDocumentId

Static Get method: GetFromIdxDocumentId(int, CancellationToken)
AssociateId, Status, Done, TypeAssociateId:

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, CancellationToken)
PersonIdPersonId:

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, CancellationToken)
AssociateId, RecurrenceRuleId, ActiveDateAssociateId:

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, CancellationToken)
GroupIdxGroupIdx:

Group of owning associate at the time the appnt was created

Nested index class: AppointmentCollection.IdxGroupIdx

Static Get method: GetFromIdxGroupIdx(int, CancellationToken)
UserdefIdUserdefId:

User-defined table record 1 (for future use)

Nested index class: AppointmentCollection.IdxUserdefId

Static Get method: GetFromIdxUserdefId(int, CancellationToken)
DoByDoBy:

Date + start time planned

Nested index class: AppointmentCollection.IdxDoBy

Static Get method: GetFromIdxDoBy(DateTime, CancellationToken)
TextIdTextId:

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, CancellationToken)
Userdef2IdUserdef2Id:

User-defined table record 2 (for future use)

Nested index class: AppointmentCollection.IdxUserdef2Id

Static Get method: GetFromIdxUserdef2Id(int, CancellationToken)
DoneDone:

Date + start time this task was actually performed

Nested index class: AppointmentCollection.IdxDone

Static Get method: GetFromIdxDone(DateTime, CancellationToken)

Implements

INestedPersist
IEnumerable<T>
INotifyCollectionChanged
IBindingList
IList
ICollection
IEnumerable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top