Changeset 1044 for Scheduling/trunk

Timestamp:

Dec 12, 2010, 12:29:55 PM (14 years ago)

Author:

Sam Habiel

Message:

Comments in DAL

Location:

Scheduling/trunk/cs/bsdx0200GUISourceCode

Files:

• ClinicalScheduling.suo (modified) ( previous)
• DAL.cs (modified) (6 diffs)

Scheduling/trunk/cs/bsdx0200GUISourceCode/DAL.cs

@@ -27 +27 @@
         }
         
+        /// <summary>
+        /// Get Current version from ^ nmsp + APPL(1,0)
+        /// </summary>
+        /// <param name="nmsp">Namespace to ask for. Only "BMX" and "BSDX" are supported.</param>
+        /// <returns>Datatable with the following fields:
+        /// "T00030ERROR^T00030MAJOR_VERSION^T00030MINOR_VERSION^T00030BUILD</returns>
         public DataTable GetVersion(string nmsp)
         {
@@ -33 +39 @@
         }
 
+        /// <summary>
+        /// Get Scheduling User Info
+        /// </summary>
+        /// <param name="DUZ">You should know what this is</param>
+        /// <returns>Datatable with one column: "MANAGER": One Row that's "YES" or "NO"</returns>
         public DataTable GetUserInfo(string DUZ)
         {
@@ -39 +50 @@
         }
 
+        /// <summary>
+        /// Get all Access Types from the BSDX ACCESS TYPE file
+        /// </summary>
+        /// <returns>DataTable with the following fields (add _ for spaces) 
+        /// ACCESS TYPE NAME (RF), [0;1]
+        /// INACTIVE (S), [0;2]
+        /// DEPARTMENT NAME (P9002018.2'), [0;3]
+        /// DISPLAY COLOR (F), [0;4]
+        /// RED (NJ3,0), [0;5]
+        /// GREEN (NJ3,0), [0;6]
+        /// BLUE (NJ3,0), [0;7]
+        ///</returns>
         public DataTable GetAccessTypes()
         {
@@ -103 +126 @@
         }
 
+        /// <summary>
+        /// Should have documented this better when I remembered what this did!
+        /// </summary>
+        /// <param name="sApptList">| delimited list of appointment IENs in ^BSDXAPPT</param>
+        /// <returns>"T00030Name^D00020DOB^T00030Sex^T00030HRN^D00030NewApptDate^T00030Clinic^T00030TypeStatus
+        /// ^I00010RESOURCEID^T00030APPT_MADE_BY^D00020DATE_APPT_MADE^T00250NOTE^T00030STREET^T00030CITY
+        /// ^T00030STATE^T00030ZIP^T00030HOMEPHONE^D00030OldApptDate</returns>
         public DataTable GetRebookedAppointments(string sApptList)
         {
@@ -109 +139 @@
         }
 
-        public DataTable GetCancelledAppointments(string sClinicList, DateTime BeginDate, DateTime EndDate)
-        {
-            string sBegin = FMDateTime.Create(BeginDate).DateOnly.FMDateString;
-            string sEnd = FMDateTime.Create(EndDate).DateOnly.FMDateString;
-            string cmd = String.Format("BSDX CANCEL CLINIC LIST^{0}^{1}^{2}", sClinicList, sBegin, sEnd);
-            return RPMSDataTable(cmd, "");
-        }
-
-        /// <summary>
-        /// Delete All Slots for a Resource
-        /// </summary>
-        /// <param name="sResourceID"></param>
+        /// <summary>
+        /// Really does what it says! Gets them by going through the BSDX APPOITMENT file index 
+        /// between the specified dates for the Resource.
+        /// </summary>
+        /// <param name="sClinicList">| delmited list of Resource IENs in ^BSDXRES</param>
         /// <param name="BeginDate"></param>
         /// <param name="EndDate"></param>
-        /// <returns></returns>
+        /// <returns>"T00030Name^D00020DOB^T00030Sex^T00030HRN^D00030NewApptDate^T00030Clinic^T00030TypeStatus
+        /// ^I00010RESOURCEID^T00030APPT_MADE_BY^D00020DATE_APPT_MADE^T00250NOTE^T00030STREET^T00030CITY
+        /// ^T00030STATE^T00030ZIP^T00030HOMEPHONE^D00030OldApptDate</returns>
+        public DataTable GetCancelledAppointments(string sClinicList, DateTime BeginDate, DateTime EndDate)
+        {
+            string sBegin = FMDateTime.Create(BeginDate).DateOnly.FMDateString;
+            string sEnd = FMDateTime.Create(EndDate).DateOnly.FMDateString;
+            string cmd = String.Format("BSDX CANCEL CLINIC LIST^{0}^{1}^{2}", sClinicList, sBegin, sEnd);
+            return RPMSDataTable(cmd, "");
+        }
+
+        /// <summary>
+        /// Delete All Slots for a Resource
+        /// </summary>
+        /// <param name="sResourceID">Integer Resource IEN in BSDX RESOURCE</param>
+        /// <param name="BeginDate">Self-Explanatory</param>
+        /// <param name="EndDate">Self-Explanatory</param>
+        /// <returns>Table with 2 columns: ERRORID & ERRORTEXT
+        /// ErrorID of -1 is A OK (successful operation); anything else is bad.</returns>
         public DataTable MassSlotDelete(string sResourceID, DateTime BeginDate, DateTime EndDate)
         {
@@ -168 +209 @@
 
         }
-
-
     }
 }