AdvantageModuleEngine Members
The AdvantageModuleEngine type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
AdvantageModuleEngine(SQL, Int32, Int32) |
Required constructor for accessing data/objects
|
|
|
AdvantageModuleEngine(HttpContext, SQL, Int32, Int32) |
Initializes a new instance of the AdvantageModuleEngine class with an HttpContext for web cache optimization.
|
Methods
| Name | Description | |
|---|---|---|
|
|
Dispose()()()() |
Disposes this instance, releasing the base engine and the BusinessHelper.
|
|
Dispose(Boolean) | (Inherited from AdvantageEngineBase.) |
|
|
FindPublishedObjectsByNode<(Of <<'(T>)>>)(String, eComparison, String) |
performs a non-indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement
This function works well with small sets of typed published items. Performance may be impacted on larger object sets, and "GetByKey" should be implemented.
|
|
|
FindPublishedObjectsByNode<(Of <<'(T>)>>)(String, eComparison, DateTime) |
Performs a non-indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement
This function works well with small sets of typed published items. Performance may be impacted on larger object sets, and "GetByKey" should be implemented.
|
|
|
FindPublishedObjectsByNode<(Of <<'(T>)>>)(String, eComparison, Int32) |
Performs a non-indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement
This function works well with small sets of typed published items. Performance may be impacted on larger object sets, and "GetByKey" should be implemented.
|
|
|
FindPublishedObjectsByNode<(Of <<'(T>)>>)(String, eComparison, Decimal) |
Performs a non-indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement
This function works well with small sets of typed published items. Performance may be impacted on larger object sets, and "GetByKey" should be implemented.
|
|
|
FindPublishedObjectsByNode<(Of <<'(T>)>>)(String, eComparison, Guid) |
Performs a non-indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement
This function works well with small sets of typed published items. Performance may be impacted on larger object sets, and "GetByKey" should be implemented.
|
|
|
FindPublishedObjectsByNode<(Of <<'(T>)>>)(String, eComparison, Boolean) |
Performs a non-indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement
This function works well with small sets of typed published items. Performance may be impacted on larger object sets, and "GetByKey" should be implemented.
|
|
|
GetAllPublishedObjects<(Of <<'(T>)>>) |
Gets a List of all specified business objects based on object type passed in
|
|
|
GetAllPublishedObjectsLight<(Of <<'(T>)>>)(List<(Of <<'(String>)>>)) |
Returns a list of BusinessObjects that are filled only with the properties specified in the parameter list
Items that DO NOT need to be specified are:ObjectTypeName, ObjectTypeID, MasterID, DomainID, LanguageID, Version, PublishStatus, SEOName, LastModifiedBy, LastModifiedDate, CreatedBy, CreatedDate.
|
|
|
GetAllPublishedObjectsLight<(Of <<'(T>)>>)(List<(Of <<'(String>)>>), Boolean) |
Returns a list of BusinessObjects that are filled only with the properties specified in the parameter list
Items that DO NOT need to be specified are:ObjectTypeName, ObjectTypeID, MasterID, DomainID, LanguageID, Version, PublishStatus, SEOName, LastModifiedBy, LastModifiedDate, CreatedBy, CreatedDate, SEOKeywords, SEOContent
|
|
|
GetPublishedKeyValueObjects<(Of <<'(T, Y>)>>)(String) |
Badly formed XML comment.
|
|
|
GetPublishedKeyValueObjects<(Of <<'(T, Y>)>>)(String, List<(Of <<'(Guid>)>>)) |
Retrieves a list of values of a specified type Y from key-value pairs
based on a provided key name and optional list of master IDs.
|
|
|
GetPublishedObjectByMasterId<(Of <<'(T>)>>) |
Returns the specified business object from the masterId passed.
|
|
|
GetPublishedObjectByMasterIds<(Of <<'(T>)>>) | Obsolete.
Returns a list of published business objects by MasterIDs. Use [GetPublishedObjectsByMasterIds{T}] instead.
|
|
|
GetPublishedObjectBySeoName<(Of <<'(T>)>>) |
Returns a business object based on the SEO Name passed in
|
|
|
GetPublishedObjectBySeoNames<(Of <<'(T>)>>) |
Returns a list of business objects populated by the SEO name list passed in
|
|
|
GetPublishedObjectsBykey<(Of <<'(T>)>>)(String, eComparison, String) |
Performs a indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement.
Index items must be set inside the business object "SetSearchableProperties" method, and published before results will be returned.
|
|
|
GetPublishedObjectsBykey<(Of <<'(T>)>>)(String, eComparison, DateTime) |
Performs a indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement.
Index items must be set inside the business object "SetSearchableProperties" method, and published before results will be returned.
|
|
|
GetPublishedObjectsBykey<(Of <<'(T>)>>)(List<(Of <<'(ObjectKeyCriteria>)>>)) |
Gets the published objects by matching criteria (Inner Join)
|
|
|
GetPublishedObjectsBykey<(Of <<'(T>)>>)(String, eComparison, Int32) |
Performs a indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement.
Index items must be set inside the business object "SetSearchableProperties" method, and published before results will be returned.
|
|
|
GetPublishedObjectsBykey<(Of <<'(T>)>>)(String, eComparison, Guid) |
Performs a indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement.
Index items must be set inside the business object "SetSearchableProperties" method, and published before results will be returned.
|
|
|
GetPublishedObjectsBykey<(Of <<'(T>)>>)(String, eComparison, Boolean) |
Performs a indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement.
Index items must be set inside the business object "SetSearchableProperties" method, and published before results will be returned.
|
|
|
GetPublishedObjectsBykey<(Of <<'(T>)>>)(String, eComparison, Decimal) |
Performs a indexed search of all business objects of the specified type and returns a list of objects matching the conditional statement.
Index items must be set inside the business object "SetSearchableProperties" method, and published before results will be returned.
|
|
|
GetPublishedObjectsBykeyLight<(Of <<'(T>)>>)(String, eComparison, Boolean, List<(Of <<'(String>)>>), Boolean) |
Performs an indexed search returning lightweight business objects populated only with the specified properties, filtered by a boolean key value.
|
|
|
GetPublishedObjectsBykeyLight<(Of <<'(T>)>>)(String, eComparison, DateTime, List<(Of <<'(String>)>>), Boolean) |
Performs an indexed search returning lightweight business objects populated only with the specified properties, filtered by a DateTime key value.
|
|
|
GetPublishedObjectsBykeyLight<(Of <<'(T>)>>)(String, eComparison, Decimal, List<(Of <<'(String>)>>), Boolean) |
Performs an indexed search returning lightweight business objects populated only with the specified properties, filtered by a decimal key value.
|
|
|
GetPublishedObjectsBykeyLight<(Of <<'(T>)>>)(String, eComparison, Guid, List<(Of <<'(String>)>>), Boolean) |
Performs an indexed search returning lightweight business objects populated only with the specified properties, filtered by a Guid key value.
|
|
|
GetPublishedObjectsBykeyLight<(Of <<'(T>)>>)(String, eComparison, Int32, List<(Of <<'(String>)>>), Boolean) |
Performs an indexed search returning lightweight business objects populated only with the specified properties, filtered by an integer key value.
|
|
|
GetPublishedObjectsBykeyLight<(Of <<'(T>)>>)(String, eComparison, String, List<(Of <<'(String>)>>), Boolean) |
Performs an indexed search returning lightweight business objects populated only with the specified properties, filtered by a string key value.
|
|
|
GetPublishedObjectsByMasterIds<(Of <<'(T>)>>) |
Returns a list of business objects populated by the masterId list passed in
|
|
|
GetPublishedObjectsByMasterIdsLight<(Of <<'(T>)>>) |
Returns lightweight business objects by MasterIDs, populated only with the specified properties for better performance.
|
|
|
SiteSettings()()()() |
Retrieves the domain-level site settings dynamically by resolving the type from the database.
|
|
|
SiteSettings<(Of <<'(T>)>>)()()()() |
Retrieves the domain-level site settings of the specified type, using web cache for performance.
|
|
|
WebCache_ClearItem |
Clears a specific item from the web cache.
(Inherited from AdvantageEngineBase.) |
|
|
WebCache_Get<(Of <<'(T>)>>) |
Retrieves an item from the web cache.
(Inherited from AdvantageEngineBase.) |
|
|
WebCache_Invalidate(String) |
Invalidates a specific item from the web cache by key.
(Inherited from AdvantageEngineBase.) |
|
|
WebCache_Invalidate(List<(Of <<'(String>)>>)) |
Invalidates web cache items by one or more categories.
(Inherited from AdvantageEngineBase.) |
|
|
WebCache_Store<(Of <<'(T>)>>) |
Stores an item in the web cache.
(Inherited from AdvantageEngineBase.) |
Properties
| Name | Description | |
|---|---|---|
|
BusinessHelper |
Helper to perform business functions for publishing and retreiving non-published objects.
|
|
Context | (Inherited from AdvantageEngineBase.) |