ljrojas91/adas-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

=== Summary: 675 files | 7 generated | 484 fresh | 4605 untracked | 4268 adopted | 355 marked | 466 validated-ok | 2+0 stale (sig+body) | 0 skipped | 0 failed | elapsed 11:08:11.442 (40091.44s) ===

Browse Source
This commit is contained in:
julian
2026-06-28 02:50:05 -07:00
parent a19fb90902
commit 586f02a2ca
654 changed files with 5260 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
adas-core.Application/Services/Interfaces/IDisplayService.cs
+28
View File
@@ -16,6 +16,7 @@ public interface IDisplayService
/// Asynchronously retrieves all displays in a compact format containing only minimal identifying information.
/// </summary>
/// <returns>A task that represents the asynchronous operation. The task result contains a list of <see cref="DisplayMinimalDto"/> objects representing all available displays in a compact projection.</returns>
/// <!-- aidoc:v1 sig=05ec358 -->
Task<List<DisplayMinimalDto>> GetAllCompact();
/// <summary>
/// Retrieves all displays along with their associated permissions for the specified user.
@@ -23,30 +24,35 @@ public interface IDisplayService
/// </summary>
/// <param name="userName">The username used to look up the associated displays and permissions. May be null.</param>
/// <returns>A task that represents the asynchronous operation, containing a list of <see cref="DisplayWithPermissionsDto"/> entries for the user.</returns>
/// <!-- aidoc:v1 sig=970fb6e -->
Task<List<DisplayWithPermissionsDto>> GetAllByUser(string? userName);
/// <summary>
/// Asynchronously retrieves a list of <see cref="Display"/> entries filtered by the specified display type.
/// </summary>
/// <param name="type">The display type used to filter the returned collection.</param>
/// <returns>A task that represents the asynchronous operation, containing the list of <see cref="Display"/> items matching the specified type.</returns>
/// <!-- aidoc:v1 sig=257ad89 -->
Task<List<Display>> GetByType(DisplayConfigEnums.DisplayType type);
/// <summary>
/// Asynchronously retrieves the list of displays associated with the specified point of care.
/// </summary>
/// <param name="pointOfCare">The point of care used to filter the displays to be returned.</param>
/// <returns>A task that represents the asynchronous operation, containing the list of <see cref="Display"/> items linked to the given point of care.</returns>
/// <!-- aidoc:v1 sig=04ec30c -->
Task<List<Display>> GetByPointOfCare(PointOfCare pointOfCare);
/// <summary>
/// Retrieves a list of displays associated with the specified configuration identifier.
/// </summary>
/// <param name="configId">The unique identifier of the configuration used to filter the displays.</param>
/// <returns>A task that represents the asynchronous operation. The task result contains a list of displays matching the specified configuration identifier.</returns>
/// <!-- aidoc:v1 sig=b59323e -->
Task<List<Display>> GetByConfigId(ObjectId configId);
/// <summary>
/// Retrieves a list of <see cref="Display"/> entities associated with the specified card configuration identifier.
/// </summary>
/// <param name="configId">The unique identifier of the card configuration whose associated displays are to be retrieved.</param>
/// <returns>A task that represents the asynchronous operation, containing a list of <see cref="Display"/> objects linked to the given card configuration.</returns>
/// <!-- aidoc:v1 sig=7885fbb -->
Task<List<Display>> GetByCardConfigId(ObjectId configId);
// Task<List<Display>> GetByUser();
@@ -56,12 +62,14 @@ public interface IDisplayService
/// </summary>
/// <param name="name">The name of the display to look up.</param>
/// <returns>A <see cref="Task{Display}"/> that resolves to the matching <see cref="Display"/>, or <c>null</c> if none is found.</returns>
/// <!-- aidoc:v1 sig=02f4c9c -->
Task<Display?> GetByName(string name);
/// <summary>
/// Retrieves a <see cref="Display"/> entity by its unique identifier.
/// </summary>
/// <param name="id">The unique identifier of the display to retrieve.</param>
/// <returns>A task that represents the asynchronous operation. The task result contains the <see cref="Display"/> if found; otherwise, <c>null</c>.</returns>
/// <!-- aidoc:v1 sig=3467c35 -->
Task<Display?> GetById(ObjectId id);
/// <summary>
/// Asynchronously retrieves a display representation of an entity along with its associated permissions, localized for the specified locale.
@@ -69,12 +77,14 @@ public interface IDisplayService
/// <param name="id">The unique identifier of the entity to retrieve.</param>
/// <param name="localeEnum">The locale used to localize the returned display data.</param>
/// <returns>A task that represents the asynchronous operation, containing the localized display data with permissions.</returns>
/// <!-- aidoc:v1 sig=22adc98 -->
Task<DisplayWithPermissionsDto> GetByIdWithPermissions(ObjectId id, LocaleEnum localeEnum);
/// <summary>
/// Asynchronously counts the number of displays associated with the specified unit identifier.
/// </summary>
/// <param name="unitId">The unique identifier of the unit whose displays should be counted.</param>
/// <returns>A task that represents the asynchronous operation. The task result contains the count of displays linked to the specified unit.</returns>
/// <!-- aidoc:v1 sig=c09d0d4 -->
Task<long> CountDisplaysByUnitId(ObjectId unitId);
/// <summary>
@@ -90,6 +100,7 @@ public interface IDisplayService
/// <param name="fillDisplayConfig">When <c>true</c>, includes the display configuration in the result.</param>
/// <param name="ct">Token used to cancel the asynchronous operation.</param>
/// <returns>A <see cref="Task{T}"/> that resolves to the <see cref="Display"/> if found, or <c>null</c> if no display matches the specified <paramref name="id"/>.</returns>
/// <!-- aidoc:v1 sig=04117d6 -->
Task<Display?> GetInfo(
ObjectId id,
string? userName,
@@ -111,6 +122,7 @@ public interface IDisplayService
/// <param name="userName">The user name used to resolve user-specific sections, or <c>null</c> if not applicable.</param>
/// <param name="authorizations">The list of authorizations used to authorize and filter the returned sections, or <c>null</c> if no authorization filtering is required.</param>
/// <returns>A task that yields the list of <see cref="MinimalDisplaySection"/> instances matching the supplied criteria.</returns>
/// <!-- aidoc:v1 sig=1bea901 -->
Task<List<MinimalDisplaySection>> GetDisplaySectionByUser(
DisplayConfigEnums.DisplayType type,
ObjectId? currentDisplay,
@@ -121,12 +133,14 @@ public interface IDisplayService
/// Asynchronously retrieves all display sections as a minimal display list.
/// </summary>
/// <returns>A task that represents the asynchronous operation, containing the <see cref="MinimalDisplayListDto"/> with the display section data.</returns>
/// <!-- aidoc:v1 sig=a8be7f7 -->
Task<MinimalDisplayListDto> GetAllDisplaySection();
/// <summary>
/// Retrieves a list of <see cref="Display"/> records associated with the specified unit identifier.
/// </summary>
/// <param name="id">The <see cref="ObjectId"/> that identifies the unit whose displays are being requested.</param>
/// <returns>A task that represents the asynchronous operation, containing a <see cref="List{Display}"/> of displays linked to the given unit.</returns>
/// <!-- aidoc:v1 sig=a786839 -->
Task<List<Display>> GetByUnitId(ObjectId id);
/// <summary>
/// Retrieves all available Points of Contact (POCs) along with their associated unit information, optionally filtered by the provided display identifiers and allowing exclusion of virtual entries.
@@ -134,23 +148,27 @@ public interface IDisplayService
/// <param name="displayIds">The list of display identifiers used to filter the available POCs.</param>
/// <param name="excludeVirtual">When set to <c>true</c>, excludes virtual POCs from the results; otherwise, virtual POCs are included.</param>
/// <returns>A task that represents the asynchronous operation. The task result contains a <see cref="PocAndUnitDto"/> with the matching POCs and their unit details.</returns>
/// <!-- aidoc:v1 sig=1142e26 -->
Task<PocAndUnitDto> GetAllAvailablePoc(List<string> displayIds, bool excludeVirtual = false);
/// <summary>
/// Asynchronously retrieves all Points of Care (POCs) associated with the specified display identifier.
/// </summary>
/// <param name="id">The display identifier used to look up the associated Points of Care.</param>
/// <returns>A task representing the asynchronous operation, containing a list of Points of Care matching the specified display identifier.</returns>
/// <!-- aidoc:v1 sig=9c3ab00 -->
Task<List<PointOfCare>> GetAllPocsByDisplayId(ObjectId id);
/// <summary>
/// Inserts a new display record into the data store and returns the persisted entity.
/// </summary>
/// <param name="display">The display entity to insert.</param>
/// <returns>A task that represents the asynchronous operation, containing the inserted <see cref="Display"/>.</returns>
/// <!-- aidoc:v1 sig=333acbc -->
Task<Display> InsertOne(Display display);
/// <summary>
/// Asynchronously inserts a single test <see cref="Display"/> record and returns the persisted result.
/// </summary>
/// <returns>A <see cref="Task{Display}"/> that represents the asynchronous insert operation, containing the inserted <see cref="Display"/>.</returns>
/// <!-- aidoc:v1 sig=eba6c71 -->
Task<Display> InsertOneTest();
/// <summary>
/// Updates the configuration of an existing display using the provided new configuration.
@@ -158,6 +176,7 @@ public interface IDisplayService
/// <param name="oldDisplay">The current display whose configuration will be updated.</param>
/// <param name="newDisplayConfig">The new display configuration to apply, or null to leave the configuration unchanged.</param>
/// <returns>A task that represents the asynchronous operation. The task result contains the updated <see cref="Display"/>, or null if the update was not performed.</returns>
/// <!-- aidoc:v1 sig=d4b8ee5 -->
Task<Display?> UpdateConfig(Display oldDisplay, DisplayConfig? newDisplayConfig);
/// <summary>
/// Updates the configuration identifier associated with the specified display.
@@ -165,6 +184,7 @@ public interface IDisplayService
/// <param name="oldDisplay">The existing display whose configuration identifier will be updated.</param>
/// <param name="configId">The new configuration identifier to associate with the display.</param>
/// <returns>A task that resolves to the updated <see cref="Display"/>, or <c>null</c> if no result is available.</returns>
/// <!-- aidoc:v1 sig=8265f8f -->
Task<Display?> UpdateConfigId(Display oldDisplay, ObjectId configId);
/// <summary>
/// Updates the point of care list associated with the specified object identifier, replacing or merging it with the provided list of point of care object identifiers.
@@ -172,6 +192,7 @@ public interface IDisplayService
/// <param name="objectId">The identifier of the object whose point of care list is being updated.</param>
/// <param name="listPocObId">The collection of point of care object identifiers to apply to the target object.</param>
/// <returns>A task that represents the asynchronous operation, containing the resulting <see cref="Display"/> when the update succeeds, or <c>null</c> when no matching object is found.</returns>
/// <!-- aidoc:v1 sig=48f0e68 -->
Task<Display?> UpdatePointOfCareList(ObjectId objectId, List<ObjectId> listPocObId);
/// <summary>
/// Updates the configuration preset associated with the specified display using the provided configuration display.
@@ -179,6 +200,7 @@ public interface IDisplayService
/// <param name="objectIdDisplay">The unique identifier of the display whose configuration preset will be updated.</param>
/// <param name="objectIdConfigDisplay">The unique identifier of the configuration display to apply as the preset.</param>
/// <returns>A task that resolves to the updated <see cref="Display"/>, or <c>null</c> if no matching display is found.</returns>
/// <!-- aidoc:v1 sig=6061a62 -->
Task<Display?> UpdateConfigPreset(ObjectId objectIdDisplay, ObjectId objectIdConfigDisplay);
/// <summary>
/// Updates the name of the entity identified by the given identifier and returns the resulting <see cref="Display"/>.
@@ -186,34 +208,40 @@ public interface IDisplayService
/// <param name="id">The identifier of the entity whose name should be updated.</param>
/// <param name="name">The new name to apply to the entity.</param>
/// <returns>A task that represents the asynchronous update operation, containing the updated <see cref="Display"/> or <c>null</c> if no entity was found.</returns>
/// <!-- aidoc:v1 sig=67bb64c -->
Task<Display?> UpdateName(ObjectId id, string name);
/// <summary>
/// Retrieves a paginated collection of displays based on the provided filter criteria.
/// </summary>
/// <param name="filter">The pagination filter that defines the page size, page number, and any additional filtering criteria for the display results.</param>
/// <returns>A task that represents the asynchronous operation, containing a <see cref="PaginationResponse{Display}"/> with the requested page of displays and pagination metadata.</returns>
/// <!-- aidoc:v1 sig=847a84e -->
Task<PaginationResponse<Display>> GetPaginatedDisplays(PaginationFilter filter);
/// <summary>
/// Asynchronously deletes the display identified by the specified identifier.
/// </summary>
/// <param name="id">The unique identifier of the display to delete.</param>
/// <returns>A task that represents the asynchronous operation, containing a value indicating whether the display was successfully deleted.</returns>
/// <!-- aidoc:v1 sig=5bb6263 -->
Task<bool> DeleteDisplay(ObjectId id);
/// <summary>
/// Retrieves the list of display configuration locations associated with the specified display configuration.
/// </summary>
/// <param name="displayConfigId">The unique identifier of the display configuration whose locations are being retrieved.</param>
/// <returns>A task that represents the asynchronous operation, containing a list of <see cref="DisplayConfigLocationDto"/> objects for the specified display configuration.</returns>
/// <!-- aidoc:v1 sig=89491e6 -->
Task<List<DisplayConfigLocationDto>> GetDisplayConfigLocations(ObjectId displayConfigId);
/// <summary>
/// Asynchronously determines whether the specified display configuration is currently in use.
/// </summary>
/// <param name="displayConfigId">The identifier of the display configuration to check.</param>
/// <returns>A task that represents the asynchronous operation. The task result is <c>true</c> if the display configuration is in use; otherwise, <c>false</c>.</returns>
/// <!-- aidoc:v1 sig=387c518 -->
Task<bool> IsDisplayConfigInUse(ObjectId displayConfigId);
/// <summary>
/// Deletes display records associated with the specified unit identifier.
/// </summary>
/// <param name="unitId">The identifier of the unit whose displays should be removed.</param>
/// <!-- aidoc:v1 sig=6bb1d75 -->
Task DeleteDisplaysByUnitId(ObjectId unitId);
}