Skip to main content

Class SelectionEntity

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for SelectionEntity.

Inheritance

objectCarrierSelectionEntity

Inherited Members

Carrier.TableRight, Carrier.FieldProperties, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Examples

Get SelectionEntity 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new SelectionAgent(configuration);
var selectionEntity = agent.GetSelectionEntity( 123 );

Remarks

Use : All SelectionEntity:
“FindSelection”

Constructors

SelectionEntity()

Default constructor - defaults any enum props to 0.

Properties

Associate

Owner of the selection

Property Value

Associate

ChartKey

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

Property Value

string

CompanyUnique

Filter out duplicate members based on company?

Property Value

bool

Completed

The Completed state.

Property Value

bool

CreatedBy

Who created the selection

Property Value

Associate

CreatedDate

Registered when

Property Value

DateTime

DashboardTileDefinitionId

The associated tile definition

Property Value

int

Description

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

Property Value

string

GroupIdx

Original primary user group of associate

Property Value

int

IncludePerson

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

Property Value

int

LastLoaded

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

Property Value

DateTime

LastLoadedBy

Who last loaded this selection

Property Value

int

LastLoadedByAssociate

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

Property Value

Associate

LastMembershipChange

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

Property Value

DateTime

LastMembershipChangeBy

Who last changed the membership

Property Value

int

LastMembershipChangeByAssociate

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

Property Value

Associate

LeftSelectionId

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

Property Value

int

MailingsProviderName

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

Property Value

string

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

Property Value

string

MainProviderName

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

Property Value

string

MemberCount

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

Property Value

uint

MemberTabHeading

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

Property Value

string

Name

Name of selection, freetext indexed

Property Value

string

Postit

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

Property Value

string

PostitTextId

Postit text record id.

Property Value

int

RightSelectionId

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

Property Value

int

SelectionCategory

Selection category type (list item)

Use MDO List name “searchCat” to get list items.

Property Value

SelectionCategory

SelectionId

Primary key

Property Value

int

SelectionType

Static/Dynamic/Combined? NULL if unknown enum value.

Property Value

SelectionType?

See Also

SelectionEntity.SelectionType_String

SelectionType_String

Static/Dynamic/Combined? Raw string enum value.

Property Value

string

See Also

SelectionEntity.SelectionType

SelectionUnionType

How to combine the two selections when SelectionType = Combined. NULL if unknown enum value.

Property Value

SelectionUnionType?

See Also

SelectionEntity.SelectionUnionType_String

SelectionUnionType_String

How to combine the two selections when SelectionType = Combined. Raw string enum value.

Property Value

string

See Also

SelectionEntity.SelectionUnionType

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

Property Value

string

SoundEx

What the name sounds like, for duplicate detection

Property Value

string

Source

How did we get this selection? For future integration needs

Property Value

short

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’

Property Value

string

TargetTableNumber

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

Property Value

int

TextId

Description text record id

Property Value

int

UpdatedBy

Who last modified the selection

Property Value

Associate

UpdatedCount

Number of updates made to this record

Property Value

short

UpdatedDate

Last updated when

Property Value

DateTime

Visibility

Obsolete, but still maintained denormalization of visiblefor

Property Value

short

VisibleFor

The set of users or groups the record is visible for

Property Value

VisibleFor[]

See Also

SelectionAgent, ArchiveAgent,