Show / Hide Table of Contents

Class NamedQueryExtensions

This class adds extension methods to NamedQueryFilter class.

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

Methods

BuildExpando(String, Object)

Builds Expandobject.

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

key for the dictionary.

System.Object value

value for the dictionary.

Returns
Type Description
ExpandoObject

.

WithNamedQuery(NamedQueryFilter, String, Object)

Example:



//Creates ?keywordSearch={"keywordSearch":"History"}
string label = "keywordSearch";
string keywordValue = "History";
string expected = $"?keywordSearch={{\"keywordSearch\":\"{keywordValue}\"}}";
var result = new NamedQueryFilter( label ).WithNamedQuery( label, keywordValue ).BuildNamedQuery();

Declaration
public static NamedQueryFilter WithNamedQuery(this NamedQueryFilter namedQuery, string key, object value)
Parameters
Type Name Description
NamedQueryFilter namedQuery

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

System.String key

The key.

System.Object value

The value which is an NamedQueryFilter.

Returns
Type Description
NamedQueryFilter

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

WithNamedQuery(NamedQueryFilter, String, String, Object)

Example:



    //Creates ?instructor={"instructor":{"id":"11111111-1111-1111-1111-111111111111"}}
    string label = "instructor";
    string guid = "11111111-1111-1111-1111-111111111111";
    string expected = $"?instructor={{\"instructor\":{{\"id\":\"{guid}\"}}}}";
    var result = new NamedQueryFilter( label ).WithNamedQuery( label, "id", guid ).BuildNamedQuery();

Declaration
public static NamedQueryFilter WithNamedQuery(this NamedQueryFilter namedQuery, string queryLabel, string key, object value)
Parameters
Type Name Description
NamedQueryFilter namedQuery

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

System.String queryLabel

The root label.

System.String key

The key.

System.Object value

The value which is an NamedQueryFilter.

Returns
Type Description
NamedQueryFilter

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

WithNamedQuery(NamedQueryFilter, String, (String label, String key, Object value)[])

Example:


    //Creates section-registrations?registrationStatusesByAcademicPeriod={"statuses":[{"detail":{"id":"11111111-1111-1111-1111-111111111111"}},{"detail":{"id":"11111111-1111-1111-1111-111111111112"}}],"academicPeriod":{"id":"11111111-1111-1111-1111-111111111113"}}
    var filter = new NamedQueryFilter( "registrationStatusesByAcademicPeriod" )
                    .WithNamedQuery( "statuses", ("detail", "id", "11111111-1111-1111-1111-111111111111"), ("detail", "id", "11111111-1111-1111-1111-111111111112") )
                    .WithNamedQuery( "academicPeriod", "id", "11111111-1111-1111-1111-111111111113" )
                    .BuildNamedQuery();
Declaration
public static NamedQueryFilter WithNamedQuery(this NamedQueryFilter namedQuery, string queryLabel, params (string label, string key, object value)[] keyValues)
Parameters
Type Name Description
NamedQueryFilter namedQuery

Instance of NamedQueryFilter object.

System.String queryLabel

Named query label.

System.ValueTuple<System.String, System.String, System.Object>[] keyValues

key and value with specific label.

Returns
Type Description
NamedQueryFilter

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

WithNamedQuery(NamedQueryFilter, (String key, Object value)[])

Example:



    //Creates ?accountSpecification={"accountingString":"11-01-01-00-11111-11111","amount":"2000","balanceOn":"2018-04-01","submittedBy":"11111111-1111-1111-1111-111111111112"}
    string label = "accountSpecification";
    string accountingString = "11-01-01-00-11111-11111";
    string amount = "2000";
    string balanceOn = "2018-04-01";
    string submittedBy = "11111111-1111-1111-1111-111111111112";
    string expected = $"?{label}={{\"accountingString\":\"{accountingString}\",\"amount\":\"{amount}\",\"balanceOn\":\"{balanceOn}\",\"submittedBy\":\"{submittedBy}\"}}";
            var result = new NamedQueryFilter( "accountSpecification" )
                         .WithNamedQuery( ("accountingString", accountingString), ("amount", amount), ("balanceOn", balanceOn), ("submittedBy", submittedBy) )
                         .BuildNamedQuery();

Declaration
public static NamedQueryFilter WithNamedQuery(this NamedQueryFilter namedQuery, params (string key, object value)[] values)
Parameters
Type Name Description
NamedQueryFilter namedQuery

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

System.ValueTuple<System.String, System.Object>[] values

Dictionary<string, object> names = new Dictionary<string, object>

Returns
Type Description
NamedQueryFilter

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

In This Article
Back to top Generated by DocFX