Skip to content

clsMenuFavoriteCollection

A collection of clsMenuFavorite rows, either the full set or scoped to one user; backs favorites administration (OP-MENU-08).

Purpose

  • Loads and holds favorites, optionally scoped by UserID (BR-MENU-001).

Context

  • Namespace: SAIF.Business.Menu
  • Assembly/package: SAIF.Business.Menu (SAIF.BOF.Presentation.Web.Infragistics111 NuGet package)

Public members

Member Signature Purpose
NewMenuFavorites Shared Function NewMenuFavorites(dpi As IDataPortalInfo) As clsMenuFavoriteCollection Factory that creates an empty, unmanaged collection ready to hold new favorites.
GetAllMenuFavorites Shared Function GetAllMenuFavorites(dpi As IDataPortalInfo) As clsMenuFavoriteCollection Factory that loads every favorite row (SQL-020).
GetMenuFavoritesForUser Shared Function GetMenuFavoritesForUser(dpi As IDataPortalInfo, userID As String) As clsMenuFavoriteCollection Loads one user's favorites; unfiltered on ItemInactiveDate, unlike the authorization projection's favorites branch (BR-MENU-001, BR-MENU-006*, SQL-021).

Inherited public members

Members in this section are inherited from clsBusinessCollectionBase in SAIF.Framework.Core (delivered by the SAIF.BOF.Framework package). They are available on this type through inheritance.

Member Signature Purpose Origin
First Sub First() Moves the collection's current-item cursor to the first element (ITraversion).† SAIF.Framework.Core — clsBusinessCollectionBase
Last Sub Last() Moves the cursor to the last element (ITraversion).† SAIF.Framework.Core — clsBusinessCollectionBase
Next Sub Next() Advances the cursor to the next element (ITraversion).† SAIF.Framework.Core — clsBusinessCollectionBase
Previous Sub Previous() Moves the cursor to the previous element (ITraversion).† SAIF.Framework.Core — clsBusinessCollectionBase
SetCurrent Sub SetCurrent(item As Object) Sets the cursor to the given item (ITraversion).† SAIF.Framework.Core — clsBusinessCollectionBase
Traverse Sub Traverse(...) Iterates the collection, applying a traversal callback to each element (ITraversion).† SAIF.Framework.Core — clsBusinessCollectionBase
Error ReadOnly Property Error As String Aggregated validation error message for the collection (IDataErrorInfo).† SAIF.Framework.Core — clsBusinessCollectionBase
Item(columnName) ReadOnly Property Item(columnName As String) As String Per-column validation error message (IDataErrorInfo).† SAIF.Framework.Core — clsBusinessCollectionBase

Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with † were retrieved from dependency library documentation via the Legends CLI RAG service. They describe inherited behavior from the indicated origin library and should be verified if the dependency version changes.

Sources

  • SAIF.Business.Menu/clsMenuFavoriteCollection.vb