Class SelectionEntity

Carrier object for SelectionEntity. Services for the SelectionEntity Carrier is available from the Selection Agent.

Inheritance
object
SelectionEntity
Implements
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.1.0.0")]
public class SelectionEntity : Carrier, IVisibleForCarrier
Examples

Get SelectionEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new SelectionAgent();
   var selectionEntity = agent.GetSelectionEntity( 123 );
}

Find all SelectionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindSelection", "...", null, "getAllRows eq 1", null, 0, 100 );

Constructors

SelectionEntity()

Default constructor

Declaration
public SelectionEntity()
See Also

Properties

Associate

Owner of the selection

Declaration
[DataMember]
public virtual Associate Associate { get; set; }
Property Value
Type Description
Associate
See Also

ChartKey

ID/key of the last-used chart tile on this selection

Declaration
[DataMember]
public virtual string ChartKey { get; set; }
Property Value
Type Description
string
See Also

CompanyUnique

Filter out duplicate members based on company?

Declaration
[DataMember]
public virtual bool CompanyUnique { get; set; }
Property Value
Type Description
bool
See Also

Completed

The Completed state.

Declaration
[DataMember]
public virtual bool Completed { get; set; }
Property Value
Type Description
bool
See Also

CreatedBy

Who created the selection

Declaration
[DataMember]
public virtual Associate CreatedBy { get; set; }
Property Value
Type Description
Associate
See Also

CreatedDate

Registered when in UTC.

Declaration
[DataMember]
public virtual DateTime CreatedDate { get; set; }
Property Value
Type Description
DateTime
See Also

DashboardTileDefinitionId

The associated tile definition

Declaration
[DataMember]
public virtual int DashboardTileDefinitionId { get; set; }
Property Value
Type Description
int
See Also

Description

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also

GroupIdx

Original primary user group of associate

Declaration
[DataMember]
public virtual int GroupIdx { get; set; }
Property Value
Type Description
int
See Also

IncludePerson

0 = Include first person, 1 = Include all persons, 2 = Include no persons

Declaration
[DataMember]
public virtual int IncludePerson { get; set; }
Property Value
Type Description
int
See Also

LastLoaded

The date/time this selection was last loaded (selectionentity fetched)

Declaration
[DataMember]
public virtual DateTime LastLoaded { get; set; }
Property Value
Type Description
DateTime
See Also

LastLoadedBy

Who last loaded this selection

Declaration
[DataMember]
public virtual int LastLoadedBy { get; set; }
Property Value
Type Description
int
See Also

LastLoadedByAssociate

Associate that last looked at the selection members; only date (not time) is valid

Declaration
[DataMember]
public virtual Associate LastLoadedByAssociate { get; set; }
Property Value
Type Description
Associate
See Also

LastMembershipChange

The date/time the membership the selection last changed. Dynamic: change of criteria; Static: add/remove members; Combined: change of algorithm

Declaration
[DataMember]
public virtual DateTime LastMembershipChange { get; set; }
Property Value
Type Description
DateTime
See Also

LastMembershipChangeBy

Who last changed the membership

Declaration
[DataMember]
public virtual int LastMembershipChangeBy { get; set; }
Property Value
Type Description
int
See Also

LastMembershipChangeByAssociate

Associate that last changed the selection membership (static members, dynamic criteria, combined parameters); only date (not time) is valid

Declaration
[DataMember]
public virtual Associate LastMembershipChangeByAssociate { get; set; }
Property Value
Type Description
Associate
See Also

LeftSelectionId

LeftSelectionId is used in combination with RightSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.

Declaration
[DataMember]
public virtual int LeftSelectionId { get; set; }
Property Value
Type Description
int
See Also

MailingsProviderName

The name of the provider for the Mailings tab, if relevant; this string will contain resource references

Declaration
[DataMember]
public virtual string MailingsProviderName { get; set; }
Property Value
Type Description
string
See Also

MainHeading

'Static selection of Companies', or whatever else is appropriate, made by combining text resources for the type and the entity (plural form); this string will contain resource references

Declaration
[DataMember]
public virtual string MainHeading { get; set; }
Property Value
Type Description
string
See Also

MainProviderName

The name of the Archive Provider that will deliver the content of the archive - the actual entity rows

Declaration
[DataMember]
public virtual string MainProviderName { get; set; }
Property Value
Type Description
string
See Also

MemberCount

How many selectionmembers (for progress bar calculations) - estimate, -1 (or 4294967295) means we don't know

Declaration
[DataMember]
public virtual uint MemberCount { get; set; }
Property Value
Type Description
uint
See Also

MemberTabHeading

'Companies', or whatever else is appropriate - the plural form of the entity name; this string will contain resource references

Declaration
[DataMember]
public virtual string MemberTabHeading { get; set; }
Property Value
Type Description
string
See Also

Name

Name of selection, freetext indexed

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also

Postit

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

Declaration
[DataMember]
public virtual string Postit { get; set; }
Property Value
Type Description
string
See Also

PostitTextId

Postit text record id.

Declaration
[DataMember]
public virtual int PostitTextId { get; set; }
Property Value
Type Description
int
See Also

RightSelectionId

RightSelectionId is used in combination with LeftSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.

Declaration
[DataMember]
public virtual int RightSelectionId { get; set; }
Property Value
Type Description
int
See Also

SelectionCategory

Selection category type (list item)

Use MDO List name "searchCat" to get list items.

Declaration
[DataMember]
public virtual SelectionCategory SelectionCategory { get; set; }
Property Value
Type Description
SelectionCategory
See Also

SelectionId

Primary key

Declaration
[DataMember]
public virtual int SelectionId { get; set; }
Property Value
Type Description
int
See Also

SelectionType

Static/Dynamic/Combined?

Declaration
[DataMember]
public virtual SelectionType SelectionType { get; set; }
Property Value
Type Description
SelectionType
See Also

SelectionUnionType

How to combine the two selections when SelectionType = Combined.

Declaration
[DataMember]
public virtual SelectionUnionType SelectionUnionType { get; set; }
Property Value
Type Description
SelectionUnionType
See Also

ShadowProviderName

The name, if relevant, of the Archive Provider that will deliver the Shadow rows: contact/person rows related to the actual entity. Can be blank, indicating that there is no shadow archive

Declaration
[DataMember]
public virtual string ShadowProviderName { get; set; }
Property Value
Type Description
string
See Also

SoundEx

What the name sounds like, for duplicate detection

Declaration
[DataMember]
public virtual string SoundEx { get; set; }
Property Value
Type Description
string
See Also

Source

How did we get this selection? For future integration needs

Declaration
[DataMember]
public virtual short Source { get; set; }
Property Value
Type Description
short
See Also

TargetTableName

TargetTableName contains the name of the table in lowercase. defines the type of selection members this selection contains. e.g. 'contact', or 'project' or 'sale'

Declaration
[DataMember]
public virtual string TargetTableName { get; set; }
Property Value
Type Description
string
See Also

TargetTableNumber

TargetTableNumber defines the type of selection members this selection contains. e.g. the table number for 'contact', or 'project' or 'sale'

Declaration
[DataMember]
public virtual int TargetTableNumber { get; set; }
Property Value
Type Description
int
See Also

TextId

Description text record id

Declaration
[DataMember]
public virtual int TextId { get; set; }
Property Value
Type Description
int
See Also

UpdatedBy

Who last modified the selection

Declaration
[DataMember]
public virtual Associate UpdatedBy { get; set; }
Property Value
Type Description
Associate
See Also

UpdatedCount

Number of updates made to this record

Declaration
[DataMember]
public virtual short UpdatedCount { get; set; }
Property Value
Type Description
short
See Also

UpdatedDate

Last updated when in UTC.

Declaration
[DataMember]
public virtual DateTime UpdatedDate { get; set; }
Property Value
Type Description
DateTime
See Also

Visibility

Obsolete, but still maintained denormalization of visiblefor

Declaration
[DataMember]
public virtual short Visibility { get; set; }
Property Value
Type Description
short
See Also

VisibleFor

The set of users or groups the record is visible for

Declaration
[DataMember]
public VisibleFor[] VisibleFor { get; set; }
Property Value
Type Description
VisibleFor[]
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

Implements

See Also