SavedFilter Methods |
The SavedFilter type exposes the following members.
Name | Description | |
---|---|---|
CanUserShareFilters |
Determines whether the current application/tenant/user is allowed to share filters.
| |
Close |
Close the filter.
| |
Convert(IAppContext, IDatabase, SaveFilterConvertOptions) |
Convert the Saved Filter from one form to another per provided SaveFilterConvertOptions.
| |
Convert(IAppContext, IDatabase, SaveFilterConvertOptions, Int32) |
Convert the Saved Filter from one form to another per provided SaveFilterConvertOptions
and applying a TOPN clause.
| |
Copy |
Copy this filter's database records and return a newly created SavedFilter object using them.
| |
Delete |
Delete the filter.
| |
Equals | (Inherited from Object.) | |
ExtractFilterFromReq(IAppContext, HttpRequest) |
Extract any general filter clause from the 'flt' parameter of the request.
See ExtractFilterFromReq(IAppContext, HttpRequest, String, SavedFilter) for more information.
| |
ExtractFilterFromReq(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.
| |
ExtractFilterFromReq(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.
| |
ExtractFilterFromReq(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.
| |
FilterSignature |
Formats a signature for use on a QueryString
| |
Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
GenerateSubquery(String, DBMSType) |
Generate a subquery for this filter appropriate for use in a SQL IN clause.
| |
GenerateSubquery(String, DBMSType, String) |
Generate a subquery for this filter appropriate for use in a SQL IN clause.
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetSchema |
Get relevant schema information from cache if already retrieved, else from the database.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Loaded |
Mark this filter as loaded from xot_saved_filters.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Open(IAppContext, String) | ||
Open(IAppContext, IDatabase, String) |
Opens the specified saved filter from the specified database and returns the SavedFilter object.
| |
RegisterReqFilter(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.
| |
RegisterReqFilter(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.
| |
RegisterReqFilter(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.
| |
RegisterReqFilter(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.
| |
RegisterReqFilterUrl |
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.
| |
Save |
Save the filter to the xot_saved_filters table in the operational database saving any static filter keys as well.
| |
Signature |
Returns a QueryString signature for the saved filter.
| |
ToString | (Inherited from Object.) |
Name | Description | |
---|---|---|
EqualValue |
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.) |