Show / Hide Table of Contents

Class LocationListProvider

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Inheritance
Object
MDOProviderBase
LocationListProvider
Implements
IEnumerable<ISoListItem>
IEnumerable
ISoListProvider
ISoList
Inherited Members
MDOProviderBase._historyIds
MDOProviderBase._searchValue
MDOProviderBase._forceFlatList
MDOProviderBase._rootCollection
MDOProviderBase._historyCollection
MDOProviderBase._headingCollection
MDOProviderBase._declaredListName
MDOProviderBase._tableRows
MDOProviderBase._nodeType
MDOProviderBase._listName
MDOProviderBase._tableName
MDOProviderBase._tableListInfo
MDOProviderBase._listInfo
MDOProviderBase.FillList()
MDOProviderBase.GetHistoryCollection()
MDOProviderBase.ReadSimpleList()
MDOProviderBase.ReadItemsAndHeadings()
MDOProviderBase.AddSimpleListOrderBy(ListTableRows.CustomSearch)
MDOProviderBase.GetItemsAndHeadingsQuery()
MDOProviderBase.AddGroupLinkJoin(Int32[], ListTableRows.CustomSearch)
MDOProviderBase.GetItemType(ListTableRow)
MDOProviderBase.GetHeadingType(ListTableRow)
MDOProviderBase.GetItemId(ListTableRow)
MDOProviderBase.AcceptHistoryRow(ListTableRow)
MDOProviderBase.GetHistoryIconHint(ListTableRow)
MDOProviderBase.GetItemRank(ListTableRow)
MDOProviderBase.GetItemDeleted(ListTableRow)
MDOProviderBase.GetItemColor(ListTableRow)
MDOProviderBase.GetItemStyleHint(ListTableRow)
MDOProviderBase.GetGroupingAllowedForList()
MDOProviderBase.OnAddHeadingElementToCollection(SoListHeading)
MDOProviderBase.OnAddHistoryElementToCollection(SoListItem)
MDOProviderBase.GetListLowerLimit()
MDOProviderBase.GetPreferredSortOrder()
MDOProviderBase.BuildMdoCollections()
MDOProviderBase.ResortFlattenedList()
MDOProviderBase.IncludeDeletedItems
MDOProviderBase.InhibitResortOnFlattening
MDOProviderBase.IsFinalListFlat
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("location")]
[MDOAdditionalInfoSeparator(";")]
[MDOAdditionalInfo("ownercontactid", "Mandatory: id of the contact for the owner of the appointment.", 2)]
[MDOAdditionalInfo("currentassociate", "Mandatory: id of the currently logged in associate.", 2)]
[MDOAdditionalInfo("appointmentcontactid", "id of the contact in the appointment.", 2)]
[MDOAdditionalInfo("appointmentpersonid", "id of the person in the appointment.", 2)]
[MDOAdditionalInfo("appointmentid", "id of existing appointment.", 2)]
[MDOAdditionalInfo("startdate", "startdate used for conflict resolution.", 2)]
[MDOAdditionalInfo("enddate", "enddate used for conflict resolution.", 2)]
[MDOAdditionalInfo("participantpersonidlist", "comma separated list of existing participant person ids", "2,34")]
[MDOAdditionalInfo("participantassociateidlist", "comma separated list of existing participant associate ids(resources)", "2")]
[MDOAdditionalInfo("skipresourcelocation", "Skip resource locations", false)]
public class LocationListProvider : MDOProviderBase, IEnumerable<ISoListItem>, IEnumerable, ISoListProvider, ISoList, IPlugin

Constructors

LocationListProvider()

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
public LocationListProvider()

Fields

ProviderName

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
public const string ProviderName = "location"
Field Value
Type Description
String

Properties

HeadingItems

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
public List<ISoListHeading> HeadingItems { get; }
Property Value
Type Description
List<ISoListHeading>

HistoryInfo

History information for the supported list. This list does not have history items.

Declaration
public override HistoryInfo HistoryInfo { get; }
Property Value
Type Description
HistoryInfo
Overrides
MDOProviderBase.HistoryInfo

HistoryItems

History items for the list. Shall return an empty array, since the location mdo provider does not have history

Declaration
public List<ISoListItem> HistoryItems { get; }
Property Value
Type Description
List<ISoListItem>

RootItems

Root items (e.g. items) for the "MDO List".

Declaration
public List<ISoListItem> RootItems { get; }
Property Value
Type Description
List<ISoListItem>

Methods

Construct(String, String, Int32[], Boolean, String, Boolean)

Phase two of two-stage list construction. To be called right after the constructor, at which point all constructors have run, and the class hierarchy is initialized.

Declaration
public override void Construct(string listName, string additionalInfo, int[] historyIDs, bool onlyReadHistory, string searchValue, bool forceFlatList)
Parameters
Type Name Description
String listName

List name (though note that as implemented by MDOProviderBase, this actually has to be a real table name, so subclasses should override and convert from their list name to a real table name) (yes it's a bit messy)

String additionalInfo

Additional information to provider: ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment
participantassociateidlist commaseparated list of persons (by their personid) participating in the current appointment. participantpersonidlist commaseparated list of resources (by their associateid) participating in the current appointment.
appointmentid Identifier of the appointment. 0 if the appointment is new. Used for conflict detection startdate start of the appointment if it is new enddate end of the appointment if it is new

Int32[] historyIDs

Ignored. Location does not have history.

Boolean onlyReadHistory

Ignored. Location does not have history

String searchValue

Ignored. Location does not have search

Boolean forceFlatList

Ignored, this list is always flat

Overrides
MDOProviderBase.Construct(String, String, Int32[], Boolean, String, Boolean)

GetHeadingIconHint(ListTableRow)

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
protected override string GetHeadingIconHint(ListTableRow row)
Parameters
Type Name Description
ListTableRow row
Returns
Type Description
String
Overrides
MDOProviderBase.GetHeadingIconHint(ListTableRow)

GetItemExtraInfo(ListTableRow)

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
protected override string GetItemExtraInfo(ListTableRow row)
Parameters
Type Name Description
ListTableRow row
Returns
Type Description
String
Overrides
MDOProviderBase.GetItemExtraInfo(ListTableRow)

GetItemIconHint(ListTableRow)

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
protected override string GetItemIconHint(ListTableRow row)
Parameters
Type Name Description
ListTableRow row
Returns
Type Description
String
Overrides
MDOProviderBase.GetItemIconHint(ListTableRow)

GetItemName(ListTableRow)

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
protected override string GetItemName(ListTableRow row)
Parameters
Type Name Description
ListTableRow row
Returns
Type Description
String
Overrides
MDOProviderBase.GetItemName(ListTableRow)

GetItemsAndHeadingsQuery(Boolean, Int32[])

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
protected override ListTableRows.CustomSearch GetItemsAndHeadingsQuery(bool bFlattened, params int[] selectedIds)
Parameters
Type Name Description
Boolean bFlattened
Int32[] selectedIds
Returns
Type Description
ListTableRows.CustomSearch
Overrides
MDOProviderBase.GetItemsAndHeadingsQuery(Boolean, Int32[])

GetItemTooltip(ListTableRow)

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
protected override string GetItemTooltip(ListTableRow row)
Parameters
Type Name Description
ListTableRow row
Returns
Type Description
String
Overrides
MDOProviderBase.GetItemTooltip(ListTableRow)

GetSimpleListQuery()

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
protected override ListTableRows.CustomSearch GetSimpleListQuery()
Returns
Type Description
ListTableRows.CustomSearch
Overrides
MDOProviderBase.GetSimpleListQuery()

OnAddRootElementToCollection(SoListItem)

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
protected override void OnAddRootElementToCollection(SoListItem item)
Parameters
Type Name Description
SoListItem item
Overrides
MDOProviderBase.OnAddRootElementToCollection(SoListItem)

OnAddSubItemToCollection(SoListItem, List<ISoListItem>)

Implements the mdo provider for the list of avaiable locations. This list aggregates elements from different sources like contact, person, associate, participants and resources to build a list that represents all the relevant, available locations that can be used when creating a new appointment.

The provider uses a set of name/value pairs in the additionalinfo parameter used in the construct() function. The available names are:

ownercontactid (mandatory): id of the contact for the owner of the appointment currentassociate (mandatory): currently logged in associate appointmentcontactid: id of the contact in the appointment appointmentpersonid: id of the person in the appointment appointmentid: id of existing appointment startdate: startdate used for conflict resolution enddate: enddate used for conflict resolution participantpersonidlist: comma separated list of existing participant person ids participantassociateidlist: comma separated list of existing participant associate ids(resources) skipresourcelocation: Skip resource locations

Declaration
protected override void OnAddSubItemToCollection(SoListItem item, List<ISoListItem> headingItemsCollection)
Parameters
Type Name Description
SoListItem item
List<ISoListItem> headingItemsCollection
Overrides
MDOProviderBase.OnAddSubItemToCollection(SoListItem, List<ISoListItem>)

Implements

System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
ISoListProvider
ISoList

Extension Methods

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