Class AccountFilter

Filter specified when querying for accounts.

Inheritance

System.Object

AccountFilter

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Moraware.JobTrackerAPI5

Assembly: JobTrackerAPI5.dll

Syntax

public class AccountFilter

Constructors

AccountFilter()

Creates a filter that as-is does nothing. (Unlike the version 1 FilterGetAccounts filter, this doesn't default to filtering on active accounts.)

Declaration

public AccountFilter()

AccountFilter(Account.AccountStatusType_Enum)

Creates an account filter specifying the status of accounts to be included.

Declaration

public AccountFilter(Account.AccountStatusType_Enum accountStatusType_)

Parameters

Type	Name	Description
Account.AccountStatusType_Enum	accountStatusType_	Identifies the account status to filter on.

Properties

ViewId

Sets a view filter.

Declaration

public int? ViewId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Methods

AddAccountCustomFieldFilter(Int32, ICustomFieldFilter)

Adds a filter for a account custom field. (May be one of ListOfValuesFilter, TextFilter, NumberFilter or DateFilter)

Declaration

public void AddAccountCustomFieldFilter(int customFieldId_, ICustomFieldFilter filter_)

Parameters

Type	Name	Description
System.Int32	customFieldId_	Identifies the account custom field to which the filter applies.
ICustomFieldFilter	filter_	Describes the filter. (May be one of ListOfValuesFilter, TextFilter, NumberFilter or DateFilter)

AddAccountStatusFilter(Account.AccountStatusType_Enum)

Adds a filter on account status.

Declaration

public void AddAccountStatusFilter(Account.AccountStatusType_Enum accountStatusType_)

Parameters

Type	Name	Description
Account.AccountStatusType_Enum	accountStatusType_	Filter on the given status.

AddAccountStatusFilter(AccountStatusFilter)

Adds a filter on account status.

Declaration

public void AddAccountStatusFilter(AccountStatusFilter accountStatusFilter_)

Parameters

Type	Name	Description
AccountStatusFilter	accountStatusFilter_	Describes the filter.

AddListOfValuesFilter(AccountFilter.AccountListOfValuesFilterFields_Enum, ListOfValuesFilter)

Adds a list of values filter for one of the built-in fields.

Declaration

public void AddListOfValuesFilter(AccountFilter.AccountListOfValuesFilterFields_Enum field_, ListOfValuesFilter listOfValuesFilter_)

Parameters

Type	Name	Description
AccountFilter.AccountListOfValuesFilterFields_Enum	field_	The field being filtered.
ListOfValuesFilter	listOfValuesFilter_	The filter being applied.

AddTextFilter(AccountFilter.AccountTextFilterFields_Enum, TextFilter)

Adds a text filter for one of the built-in fields.

Declaration

public void AddTextFilter(AccountFilter.AccountTextFilterFields_Enum field_, TextFilter textFilter_)

Parameters

Type	Name	Description
AccountFilter.AccountTextFilterFields_Enum	field_	The field being filtered.
TextFilter	textFilter_	The filter being applied.