Class TypicalSearch

Complete information about a TypicalSearch (including criteria)

Carrier object for TypicalSearch. Services for the TypicalSearch Carrier is available from the Selection Agent.
Inheritance
object
TypicalSearch
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.2.0.0")]
public class TypicalSearch : Carrier

Constructors

TypicalSearch()

Default constructor

Declaration
public TypicalSearch()
See Also

Properties

EntityName

The name of the entity the typical search links to

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

IncludePerson

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

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

IsEntityDefault

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

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

RestrictionGroups

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

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

Source

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

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

Title

The title of the typical search (multilingual)

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

Tooltip

The tooltip for the typical search (multilingual)

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

TypicalSearchId

Primary key

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

VersionNumber

The current downloaded version of this typical search

Declaration
[DataMember]
public virtual int VersionNumber { get; set; }
Property Value
Type Description
int
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

See Also