Class PurchaseOrderStatusFilter
Filter on purchase order status.
Inherited Members
Namespace: Moraware.JobTrackerAPI5
Assembly: JobTrackerAPI5.dll
Syntax
public class PurchaseOrderStatusFilter : Filter, IFilter, ICloneable
Constructors
PurchaseOrderStatusFilter()
Creates a filter with no values assigned.
Declaration
public PurchaseOrderStatusFilter()
PurchaseOrderStatusFilter(PurchaseOrder.PurchaseOrderStatusType_Enum)
Creates a new, list of values filter using a single po status.
Declaration
public PurchaseOrderStatusFilter(PurchaseOrder.PurchaseOrderStatusType_Enum value_)
Parameters
| Type | Name | Description |
|---|---|---|
| PurchaseOrder.PurchaseOrderStatusType_Enum | value_ | The value to filter on. |
PurchaseOrderStatusFilter(Boolean, PurchaseOrder.PurchaseOrderStatusType_Enum)
Creates a new, list of values filter using a single po status and indicating whether or not the list should be inverted.
Declaration
public PurchaseOrderStatusFilter(bool invert_, PurchaseOrder.PurchaseOrderStatusType_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.) |
| PurchaseOrder.PurchaseOrderStatusType_Enum | value_ | The value to filter on. |
PurchaseOrderStatusFilter(Boolean, PurchaseOrderStatusFilterValues)
Creates a new, list of values filter indicating whether or not the list should be inverted.
Declaration
public PurchaseOrderStatusFilter(bool invert_, PurchaseOrderStatusFilterValues 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.) |
| PurchaseOrderStatusFilterValues | values_ | The values to filter on. |
PurchaseOrderStatusFilter(Boolean, IEnumerable<PurchaseOrder.PurchaseOrderStatusType_Enum>)
Creates a new, list of values filter using a set of statuses and indicating whether or not the list should be inverted.
Declaration
public PurchaseOrderStatusFilter(bool invert_, IEnumerable<PurchaseOrder.PurchaseOrderStatusType_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<PurchaseOrder.PurchaseOrderStatusType_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 PurchaseOrderStatusFilterValues Values { get; }
Property Value
| Type | Description |
|---|---|
| PurchaseOrderStatusFilterValues |
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. |