Click or drag to resize

SavedFilter Methods

The SavedFilter type exposes the following members.

Methods
  NameDescription
Public methodStatic memberCanUserShareFilters
Determines whether the current application/tenant/user is allowed to share filters.
Public methodClose
Close the filter.
Public methodConvert(IAppContext, IDatabase, SaveFilterConvertOptions)
Convert the Saved Filter from one form to another per provided SaveFilterConvertOptions.
Public methodConvert(IAppContext, IDatabase, SaveFilterConvertOptions, Int32)
Convert the Saved Filter from one form to another per provided SaveFilterConvertOptions and applying a TOPN clause.
Public methodCopy
Copy this filter's database records and return a newly created SavedFilter object using them.
Public methodDelete
Delete the filter.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodStatic memberExtractFilterFromReq(IAppContext, HttpRequest)
Extract any general filter clause from the 'flt' parameter of the request. See ExtractFilterFromReq(IAppContext, HttpRequest, String, SavedFilter) for more information.
Public methodStatic memberExtractFilterFromReq(IAppContext, HttpRequest, SavedFilter)
Extract any general filter clause and its SavedFilter from the 'flt' parameter of the request. See ExtractFilterFromReq(IAppContext, HttpRequest, String, SavedFilter) for more information.
Public methodStatic memberExtractFilterFromReq(IAppContext, HttpRequest, String)
Extract any general filter clause from the named HTTP request parameter. See ExtractFilterFromReq(IAppContext, HttpRequest, String, SavedFilter) for more information. Note that calling this overload is the same as calling the ExtractFilterFromReq(IAppContext, HttpRequest) overload specifying 'flt' as the name value.
Public methodStatic memberExtractFilterFromReq(IAppContext, HttpRequest, String, SavedFilter)
Extract any general filter clause from the request. Use this method to obtain the filter clause and SavedFilter specified in the request via the name (defaults to 'flt') parameter. The value must be a special SavedFilter identifier generated using one of the RegisterReqFilter(IAppContext, String) overloads. If the parameter is not present, or its value is blank/null, a blank/null clause will be returned and the returned filter will be null.
Remarks
In early version of the platform providing a raw SQL filter clause was allowed, but due to the risk of SQL injection this is no longer supported and an error will be thrown if a non-blank/empty parameter value is found that is not a recognized SavedFilter identifier.
Public methodStatic memberFilterSignature
Formats a signature for use on a QueryString
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGenerateSubquery(String, DBMSType)
Generate a subquery for this filter appropriate for use in a SQL IN clause.
Public methodGenerateSubquery(String, DBMSType, String)
Generate a subquery for this filter appropriate for use in a SQL IN clause.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodStatic memberGetSchema
Get relevant schema information from cache if already retrieved, else from the database.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodLoaded
Mark this filter as loaded from xot_saved_filters.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodStatic memberCode exampleOpen(IAppContext, String)
Opens the specified filter from the IAppContext.DataDB database and returns the SavedFilter object.
Public methodStatic memberOpen(IAppContext, IDatabase, String)
Opens the specified saved filter from the specified database and returns the SavedFilter object.
Public methodStatic memberRegisterReqFilter(IAppContext, String)
Register a filter clause for use in a URL's flt parameter. Registration will cause a SavedFilter to be created and written to the database. The method returns a filter spec that can be included in a URL without risk of a SQL injection attack. Filters created using this overload will always be marked as Temp with a default expiration and will be restricted to the current user.
Public methodStatic memberRegisterReqFilter(IAppContext, String, NullableDateTime)
Register a filter clause for use in a URL's flt parameter. Registration will cause a SavedFilter to be created and written to the database. The method returns a filter spec that can be included in a URL without risk of a SQL injection attack. Filters created using this overload will always be marked as Temp with a default expiration and will be restricted to the current user.
Public methodStatic memberRegisterReqFilter(IAppContext, String, String, String, String)
Register a filter clause for use in a URL's flt parameter. Registration will cause a SavedFilter to be created and written to the database. The method returns a filter spec that can be included in a URL without risk of a SQL injection attack. Filters created using this overload will always be marked as Temp with a default expiration and will be restricted to the current user.
Public methodStatic memberRegisterReqFilter(IAppContext, String, FilterAttributes, String, String, String, NullableDateTime, String)
Register a filter clause for use in a URL's flt parameter. Registration will cause a SavedFilter to be created and written to the database. The method returns a filter spec that can be included in a URL without risk of a SQL injection attack. You can use one of the ExtractFilterFromReq(IAppContext, HttpRequest, String, SavedFilter) overloads to extract the filter.
Public methodStatic memberRegisterReqFilterUrl
Register a filter clause for use in a URL's flt parameter. Registration will cause a SavedFilter to be created and written to the database. The method returns a filter spec that can be included in a URL without risk of a SQL injection attack. Filters created using this overload will always be marked as Temp with a default expiration and will be restricted to the current user.
Public methodSave
Save the filter to the xot_saved_filters table in the operational database saving any static filter keys as well.
Public methodSignature
Returns a QueryString signature for the saved filter.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also