Show / Hide Table of Contents

Class FilterUtility

This is a utility class used by Criteria and NamedQuery classes.

Inheritance
System.Object
FilterUtility
Namespace: Ellucian.Ethos.Integration.Client.Proxy.Filter
Assembly: Ellucian.Ethos.Integration.dll
Syntax
public static class FilterUtility : object

Methods

Add(String, Object)

Creates an with key and its value.

Declaration
public static ExpandoObject Add(string key, object value)
Parameters
Type Name Description
System.String key

key for the json object.

System.Object value

value for the json object.

Returns
Type Description
ExpandoObject

An with key and its value.

Build<T>(T)

This method serializes the object of type T and returns the json string.

Declaration
public static string Build<T>(T t)
    where T : class
Parameters
Type Name Description
T t

The instance of type T to be serialized.

Returns
Type Description
System.String

Serialized the json string.

Type Parameters
Name Description
T

Object of type T to be serialized.

BuildCriteria(CriteriaFilter)

This method builds and return criteria as a json fragment.

Declaration
public static string BuildCriteria(this CriteriaFilter source)
Parameters
Type Name Description
CriteriaFilter source

The expando object with various key value pairs.

Returns
Type Description
System.String

Returns formatted criteria filter json fragment used in the url to make a proxy request.

BuildNamedQuery(NamedQueryFilter)

This method builds and returns a named query as a json fragment.

Declaration
public static string BuildNamedQuery(this NamedQueryFilter source)
Parameters
Type Name Description
NamedQueryFilter source

NamedQueryFilter Represents an object whose members can be dynamically added and removed at run time.

Returns
Type Description
System.String

Returns formatted named query json fragment used in the url to make a proxy request.

IsNull(IDictionary<String, Object>)

Checks for null values.

Declaration
public static bool IsNull(IDictionary<string, object> expando)
Parameters
Type Name Description
IDictionary<System.String, System.Object> expando
Returns
Type Description
System.Boolean

Validate(ExpandoObject)

Validates the inputs.

Declaration
public static void Validate(ExpandoObject expandoObject)
Parameters
Type Name Description
ExpandoObject expandoObject

ExpandoObject to be checked for nulls.

In This Article
Back to top Generated by DocFX