Interface IOrmSeltzrOptionsBuilder<TModel, TUser>

Contract for an options builder for an ORM-based API

Namespace: Seltzr.OrmBase.Options

Assembly: Seltzr.OrmBase.dll

Syntax

C#

Copy

public interface IOrmSeltzrOptionsBuilder<TModel, in TUser>
    where TModel : class where TUser : class

Type Parameters

TModel

The model type that the API is being built for

TUser

The type of authenticated user context

Methods

GetCreateOperation()

Gets a create IOperation<TModel, TUser> for this model

C#

Copy

IOperation<TModel, TUser> GetCreateOperation()

Returns

IOperation<TModel, TUser>

A new create operation for TModel

GetDeleteOperation()

Gets a delete IOperation<TModel, TUser> for this model

C#

Copy

IOperation<TModel, TUser> GetDeleteOperation()

Returns

IOperation<TModel, TUser>

A new delete operation for TModel

GetPrimaryKey()

Gets the properties that make up the primary key of TModel

C#

Copy

List<KeyProperty> GetPrimaryKey()

Returns

List<KeyProperty>

The properties that make up the primary key of TModel

GetUpdateOperation(PropertyInfo[], ParameterRetriever[])

Gets an update IOperation<TModel, TUser> for this model

C#

Copy

IOperation<TModel, TUser> GetUpdateOperation(PropertyInfo[] properties, ParameterRetriever[] retrievers)

Parameters

propertiesPropertyInfo[]

The properties to use to compare existing models with parsed models to determine which models to update

retrieversParameterRetriever[]

A list of parameter retrievers to use to get values for the properties. If null, the parsed body will be used instead

Returns

IOperation<TModel, TUser>

A new update operation for TModel