clsMenuFavoriteCollection¶
Loads favorites for all users or one user.
Purpose¶
- Provide favorite rows for maintenance.
- Provide the user-scoped subset reused during menu composition.
Context¶
- Namespace:
SAIF.Business.Menu - Assembly/package:
SAIF.Business.Menu.dll
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| Item (default, keyed) | Default Public Overloads ReadOnly Property Item(ByVal inMenuFavoriteSeqNum As Decimal) As clsMenuFavorite |
Looks up a favorite row in the loaded collection by its MenuFavoriteSeqNum key, returning Nothing if no item matches. |
| CurrentItem | Public Shadows ReadOnly Property CurrentItem() As clsMenuFavorite |
Returns the base collection's current item cast to clsMenuFavorite, avoiding caller-side casting when navigating a user's loaded favorites. |
| Save | Public Overrides Function Save() As Boolean |
Persists the current object state through the SAIF data-portal lifecycle. |
| Add | Public Shadows Function Add(ByVal inclsMenuFavorite As clsMenuFavorite) As Integer |
Appends an already-constructed row to the in-memory collection so it participates in the next Save() and any collection-wide iteration, without issuing a retrieve. |
| Contains | Public Overloads Function Contains(ByVal inclsMenuFavorite As clsMenuFavorite) As Boolean |
Scans the loaded collection for an item whose MenuFavoriteSeqNum equals the supplied object's MenuFavoriteSeqNum (clsMenuFavorite.Equals compares only that sequence-number field). |
| Contains | Public Overloads Function Contains(ByVal inMenuFavoriteSeqNum As Decimal) As Boolean |
Scans the loaded collection for an item whose MenuFavoriteSeqNum property equals the supplied value. |
| ContainsDeleted | Public Overloads Function ContainsDeleted(ByVal inclsMenuFavorite As clsMenuFavorite) As Boolean |
Scans the deleted-items list for an entry whose MenuFavoriteSeqNum equals the supplied object's MenuFavoriteSeqNum. |
| ContainsDeleted | Public Overloads Function ContainsDeleted(ByVal inMenuFavoriteSeqNum As Decimal) As Boolean |
Scans the deleted-items list for an entry matching the supplied sequence number, via clsMenuFavorite.Equals(Object). |
| Remove | Public Overloads Sub Remove(ByVal inMenuFavoriteSeqNum As Decimal) |
Removes the favorite matching the supplied key from the in-memory collection and moves it to the inherited deleted-items list so a subsequent Save() still issues the delete statement. |
| NewMenuFavorites | Public Shared Function NewMenuFavorites(ByVal inDataportal As IDataPortalInfo, ByVal inUserID As String) As clsMenuFavoriteCollection |
Creates a new typed object using the supplied data-portal context. |
| GetAllMenuFavorites | Public Shared Function GetAllMenuFavorites(ByVal inDataportal As IDataPortalInfo) As clsMenuFavoriteCollection |
Retrieves the full typed set from Oracle. |
| GetMenuFavoritesForUser | Public Shared Function GetMenuFavoritesForUser(ByVal inDataportal As IDataPortalInfo, ByVal inUserID As String) As clsMenuFavoriteCollection |
Retrieves the MENU_FAVORITE rows owned by the user named in inUserID, producing the per-user favorites subset later unioned into the authorized-menu result set under BR-MENU-004. |
Behavioral notes¶
- User-scoped retrieval is later folded into BR-MENU-004.
Constraints and usage notes¶
- Collection wrapper around favorite rows.
Inherited public members¶
No dependency-resolution.json was produced for this run, so the members below are a best-effort inference from typical SAIF BOF framework (clsBusinessCollection(Of T)) patterns observed elsewhere in this codebase, not a Legends CLI-sourced dependency lookup.**
From clsBusinessCollection(Of clsMenuFavorite) (SAIF.BOF.Framework)**¶
| Member | Signature | Purpose | Origin |
|---|---|---|---|
| Count | Public ReadOnly Property Count() As Integer |
*Purpose could not be verified beyond the standard collection-indexer contract**; inferred usage is bounding For loops when callers iterate loaded clsMenuFavorite rows outside GetEnumerator. |
clsBusinessCollection(Of T) |
| Item | Public Default ReadOnly Property Item(ByVal index As Integer) As clsMenuFavorite |
*Purpose could not be verified beyond the standard collection-indexer contract**; inferred usage is positional access to a loaded clsMenuFavorite row during indexed iteration or lookup-by-slot. |
clsBusinessCollection(Of T) |
| GetEnumerator | Public Function GetEnumerator() As IEnumerator(Of clsMenuFavorite) |
Supports For Each iteration over the loaded collection.** |
clsBusinessCollection(Of T) |
| IsDirty | Public Overridable ReadOnly Property IsDirty() As Boolean |
Reports whether any loaded or deleted item in the collection has pending changes.** | clsBusinessCollection(Of T) |
| IsValid | Public Overridable ReadOnly Property IsValid() As Boolean |
Reports whether every loaded item in the collection independently reports itself valid.** | clsBusinessCollection(Of T) |
Note: Statements marked with
**could not be confirmed; treat as unknown until verified.
Sources¶
SAIF.Business.Menu\clsMenuFavoriteCollection.vb