Transaction System API

TagFilter

TagFilter for system data views that support tagging.

Method Summary
TagFilter addAnd()

Adds an AND operator to the tag query.

TagFilter addBetween(String tagKey, float startFloatValue, float endFloatValue)

Includes records matching tag with value between the specified range.

TagFilter addBetweenDates(String tagKey, Date tagStartDate, Date tagEndDate)

Includes records matching tag with date between the specified dates.

TagFilter addEqual(String tagKey, String tagValue)

Select records matching the given tag and value.

TagFilter addEqualTo(String tagKey, float tagFloat)

Includes records matching tag with value equal to the specified float.

TagFilter addEqualToDate(String tagKey, Date tagDate)

Includes records matching tag with value equal to the specified date.

TagFilter addGreater(String tagKey, float tagFloat)

Includes records matching tag with value greater than specified float.

TagFilter addGreaterThanDate(String tagKey, Date tagDate)

Includes records matching tag with date greater than specified date.

TagFilter addLessThan(String tagKey, float tagFloat)

Includes records matching tag with value less than specified float.

TagFilter addLessThanDate(String tagKey, Date tagDate)

Includes records matching tag with date less than specified date.

TagFilter addNotEqual(String tagKey, String tagValue)

Select records where the given tag does not have the value specified.

TagFilter addOr()

Adds an OR operator to the tag query.

TagFilter beginGroup()

Begins a group of statements for the tag query.

TagFilter endGroup()

Ends a group of statements for the tag query.

Method Detail


TagFilter addAnd()

Adds an AND operator to the tag query.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addBetween(String tagKey, float startFloatValue, float endFloatValue)

Includes records matching tag with value between the specified range.

Parameters:

  • String   tagKey Required parameter.
  • float   startFloatValue Required parameter.
  • float   endFloatValue Required parameter.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addBetweenDates(String tagKey, Date tagStartDate, Date tagEndDate)

Includes records matching tag with date between the specified dates.

Parameters:

  • String   tagKey Required parameter.
  • Date   tagStartDate Required parameter.
  • Date   tagEndDate Required parameter.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addEqual(String tagKey, String tagValue)

Select records matching the given tag and value.

Parameters:

  • String   tagKey Required parameter. Maximum allowed size of parameter: 20
  • String   tagValue Required parameter. Maximum allowed size of parameter: 100

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addEqualTo(String tagKey, float tagFloat)

Includes records matching tag with value equal to the specified float.

Parameters:

  • String   tagKey Required parameter.
  • float   tagFloat Required parameter.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addEqualToDate(String tagKey, Date tagDate)

Includes records matching tag with value equal to the specified date.

Parameters:

  • String   tagKey Required parameter.
  • Date   tagDate Required parameter.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addGreater(String tagKey, float tagFloat)

Includes records matching tag with value greater than specified float.

Parameters:

  • String   tagKey Required parameter.
  • float   tagFloat Required parameter.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addGreaterThanDate(String tagKey, Date tagDate)

Includes records matching tag with date greater than specified date.

Parameters:

  • String   tagKey Required parameter.
  • Date   tagDate Required parameter.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addLessThan(String tagKey, float tagFloat)

Includes records matching tag with value less than specified float.

Parameters:

  • String   tagKey Required parameter.
  • float   tagFloat Required parameter.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addLessThanDate(String tagKey, Date tagDate)

Includes records matching tag with date less than specified date.

Parameters:

  • String   tagKey Required parameter.
  • Date   tagDate Required parameter.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addNotEqual(String tagKey, String tagValue)

Select records where the given tag does not have the value specified.

Parameters:

  • String   tagKey Required parameter. Maximum allowed size of parameter: 20
  • String   tagValue Required parameter. Maximum allowed size of parameter: 100

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter addOr()

Adds an OR operator to the tag query.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter beginGroup()

Begins a group of statements for the tag query.

Returns:  TagFilter

Since: 01-10-2013

top

TagFilter endGroup()

Ends a group of statements for the tag query.

Returns:  TagFilter

Since: 01-10-2013

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM