Five New Optimizely Certifications are Here! Validate your expertise and advance your career with our latest certification exams. Click here to find out more

Interface ICustomViewSettingsService

Services for custom view settings.

Namespace: EPiServer.Commerce.CustomViewSetting.Internal
Assembly: EPiServer.Business.Commerce.dll
Version: 14.26.0
Syntax
public interface ICustomViewSettingsService

Methods

AddCustomViewSettings(CustomViewSettings)

Adds a custom view settings.

Declaration
int AddCustomViewSettings(CustomViewSettings customViewSettings)
Parameters
Type Name Description
CustomViewSettings customViewSettings

The custom view settings.

Returns
Type Description
System.Int32

The view identifier.

DeleteCustomViewSettings(Int32)

Deletes a custom view settings.

Declaration
void DeleteCustomViewSettings(int viewId)
Parameters
Type Name Description
System.Int32 viewId

The custom view id.

DeleteCustomViewSettings(String, String)

Deletes custom view settings by table name.

Declaration
void DeleteCustomViewSettings(string userName, string tableName)
Parameters
Type Name Description
System.String userName

The user name.

System.String tableName

The table name.

GetCustomViewSettings(Int32, String)

Gets the custom view settings.

Declaration
CustomViewSettings GetCustomViewSettings(int viewId, string userName)
Parameters
Type Name Description
System.Int32 viewId

The view id.

System.String userName

The user name.

Returns
Type Description
CustomViewSettings

A custom view settings.

GetCustomViewSettings_RecentView(String)

Gets list of recent view for custom column settings.

Declaration
IEnumerable<CustomViewSettings_RecentView> GetCustomViewSettings_RecentView(string userName)
Parameters
Type Name Description
System.String userName

The user name.

Returns
Type Description
System.Collections.Generic.IEnumerable<CustomViewSettings_RecentView>

A list of recent view for custom column settings.

ListConditions(String, String)

Gets list of conditions.

Declaration
ConditionElementCollection ListConditions(string tableName, string fieldName)
Parameters
Type Name Description
System.String tableName

The table name.

System.String fieldName

The field name.

Returns
Type Description
ConditionElementCollection

A list of conditions.

ListCustomViewSettings(String, String)

Gets list of custom view settings.

Declaration
IEnumerable<CustomViewSettings> ListCustomViewSettings(string userName, string tableName)
Parameters
Type Name Description
System.String userName

The user name.

System.String tableName

The table name.

Returns
Type Description
System.Collections.Generic.IEnumerable<CustomViewSettings>

A list of custom view settings.

RemoveFilters(String, String)

Removes filters by table name and field name.

Declaration
void RemoveFilters(string tableName, string fieldName)
Parameters
Type Name Description
System.String tableName

The table name.

System.String fieldName

The field name.

UpdateCustomViewSettings(CustomViewSettings)

Updates a custom view settings.

Declaration
void UpdateCustomViewSettings(CustomViewSettings customViewSettings)
Parameters
Type Name Description
CustomViewSettings customViewSettings

The custom view settings.

UpdateCustomViewSettings_RecentView(Int32, String, String)

Update recent view.

Declaration
void UpdateCustomViewSettings_RecentView(int viewId, string tableName, string userName)
Parameters
Type Name Description
System.Int32 viewId

The viewId.

System.String tableName

The table name

System.String userName

The user name.