Class AccountStatusFilter
Filter on Account status.
Inherited Members
Namespace: Moraware.JobTrackerAPI5
Assembly: JobTrackerAPI5.dll
Syntax
public class AccountStatusFilter : Filter, IFilter, ICloneable
Constructors
AccountStatusFilter()
Creates a filter with no values assigned.
Declaration
public AccountStatusFilter()
AccountStatusFilter(Account.AccountStatusType_Enum)
Creates a new, list of values filter using a single account status.
Declaration
public AccountStatusFilter(Account.AccountStatusType_Enum value_)
Parameters
| Type | Name | Description |
|---|---|---|
| Account.AccountStatusType_Enum | value_ | The value to filter on. |
AccountStatusFilter(Boolean, Account.AccountStatusType_Enum)
Creates a new, list of values filter using a single account status and indicating whether or not the list should be inverted.
Declaration
public AccountStatusFilter(bool invert_, Account.AccountStatusType_Enum value_)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | invert_ | When using this filter, filter for the inversion of the specified list. (i.e. Filter for values NOT in the given list.) |
| Account.AccountStatusType_Enum | value_ | The value to filter on. |
AccountStatusFilter(Boolean, AccountStatusFilterValues)
Creates a new, list of values filter.
Declaration
public AccountStatusFilter(bool invert_, AccountStatusFilterValues values_)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | invert_ | When using this filter, filter for the inversion of the specified list. (i.e. Filter for values NOT in the given list.) |
| AccountStatusFilterValues | values_ | The values to filter on. |
AccountStatusFilter(Boolean, IEnumerable<Account.AccountStatusType_Enum>)
Creates a new, list of values filter using a set of statuses.
Declaration
public AccountStatusFilter(bool invert_, IEnumerable<Account.AccountStatusType_Enum> values_)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | invert_ | When using this filter, filter for the inversion of the specified list. (i.e. Filter for values NOT in the given list.) |
| System.Collections.Generic.IEnumerable<Account.AccountStatusType_Enum> | values_ | The values to filter on. |
Properties
Invert
True if the associated list should be inverted when filtering (i.e. Filter for values NOT in the given list.)
Declaration
public bool Invert { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Values
The set of values to filter on.
Declaration
public AccountStatusFilterValues Values { get; }
Property Value
| Type | Description |
|---|---|
| AccountStatusFilterValues |
Methods
BuildDescription(String)
Builds a description of the filter.
Declaration
public string BuildDescription(string fieldName_)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | fieldName_ | Name to use for the field in the filter description. |
Returns
| Type | Description |
|---|---|
| System.String | A description of the filter |
Clone()
Creates a copy of this ListOfValuesFilter.
Declaration
public override object Clone()
Returns
| Type | Description |
|---|---|
| System.Object | A copy of this object. |