Class TypicalSearch

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for TypicalSearch. Complete information about a TypicalSearch (including criteria)

public class TypicalSearch : Carrier

Inheritance

object ← Carrier ← TypicalSearch

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()

Constructors

TypicalSearch()

Default constructor - defaults any enum props to 0.

public TypicalSearch()

Properties

EntityName

The name of the entity the typical search links to

public virtual string EntityName { get; set; }

Property Value

string

IncludePerson

For selection-of-company: state of the Include Main Contact checkbox

public virtual short IncludePerson { get; set; }

Property Value

short

IsEntityDefault

Indicates if this is the default set of criteria for an entity

public virtual short IsEntityDefault { get; set; }

Property Value

short

RestrictionGroups

The restrictions (can be multiple groups) that make up the TypicalSearch

public virtual ArchiveRestrictionGroup[] RestrictionGroups { get; set; }

Property Value

ArchiveRestrictionGroup[]

Source

Name of organisation that sources and maintains this TypicalSearch. Allows for both SuperOffice and partners to maintain sets of typical searches without conflict

public virtual string Source { get; set; }

Property Value

string

Title

The title of the typical search (multilingual)

public virtual string Title { get; set; }

Property Value

string The tooltip for the typical search (multilingual)

public virtual string Tooltip { get; set; }

Property Value

string

TypicalSearchId

Primary key

public virtual int TypicalSearchId { get; set; }

Property Value

int

VersionNumber

The current downloaded version of this typical search

public virtual int VersionNumber { get; set; }

Property Value

int

SuperOffice.WebApi.Data.TypicalSearch

Class TypicalSearch

Inheritance

Inherited Members

Constructors

TypicalSearch()

Properties

EntityName

Property Value

IncludePerson

Property Value

IsEntityDefault

Property Value

RestrictionGroups

Property Value

Source

Property Value

Title

Property Value

Tooltip

Property Value

TypicalSearchId

Property Value

VersionNumber

Property Value

See Also

​ Class TypicalSearch

​Inheritance

​Inherited Members

​Constructors

​ TypicalSearch()

​Properties

​ EntityName

​Property Value

​ IncludePerson

​Property Value

​ IsEntityDefault

​Property Value

​ RestrictionGroups

​Property Value

​ Source

​Property Value

​ Title

​Property Value

​ Tooltip

​Property Value

​ TypicalSearchId

​Property Value

​ VersionNumber

​Property Value

​See Also

Class TypicalSearch

Inheritance

Inherited Members

Constructors

TypicalSearch()

Properties

EntityName

Property Value

IncludePerson

Property Value

IsEntityDefault

Property Value

RestrictionGroups

Property Value

Source

Property Value

Title

Property Value

Tooltip

Property Value

TypicalSearchId

Property Value

VersionNumber

Property Value

See Also