Changeset 1044 for Scheduling


Ignore:
Timestamp:
Dec 12, 2010, 12:29:55 PM (14 years ago)
Author:
Sam Habiel
Message:

Comments in DAL

Location:
Scheduling/trunk/cs/bsdx0200GUISourceCode
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • Scheduling/trunk/cs/bsdx0200GUISourceCode/DAL.cs

    r1039 r1044  
    2727        }
    2828       
     29        /// <summary>
     30        /// Get Current version from ^ nmsp + APPL(1,0)
     31        /// </summary>
     32        /// <param name="nmsp">Namespace to ask for. Only "BMX" and "BSDX" are supported.</param>
     33        /// <returns>Datatable with the following fields:
     34        /// "T00030ERROR^T00030MAJOR_VERSION^T00030MINOR_VERSION^T00030BUILD</returns>
    2935        public DataTable GetVersion(string nmsp)
    3036        {
     
    3339        }
    3440
     41        /// <summary>
     42        /// Get Scheduling User Info
     43        /// </summary>
     44        /// <param name="DUZ">You should know what this is</param>
     45        /// <returns>Datatable with one column: "MANAGER": One Row that's "YES" or "NO"</returns>
    3546        public DataTable GetUserInfo(string DUZ)
    3647        {
     
    3950        }
    4051
     52        /// <summary>
     53        /// Get all Access Types from the BSDX ACCESS TYPE file
     54        /// </summary>
     55        /// <returns>DataTable with the following fields (add _ for spaces)
     56        /// ACCESS TYPE NAME (RF), [0;1]
     57        /// INACTIVE (S), [0;2]
     58        /// DEPARTMENT NAME (P9002018.2'), [0;3]
     59        /// DISPLAY COLOR (F), [0;4]
     60        /// RED (NJ3,0), [0;5]
     61        /// GREEN (NJ3,0), [0;6]
     62        /// BLUE (NJ3,0), [0;7]
     63        ///</returns>
    4164        public DataTable GetAccessTypes()
    4265        {
     
    103126        }
    104127
     128        /// <summary>
     129        /// Should have documented this better when I remembered what this did!
     130        /// </summary>
     131        /// <param name="sApptList">| delimited list of appointment IENs in ^BSDXAPPT</param>
     132        /// <returns>"T00030Name^D00020DOB^T00030Sex^T00030HRN^D00030NewApptDate^T00030Clinic^T00030TypeStatus
     133        /// ^I00010RESOURCEID^T00030APPT_MADE_BY^D00020DATE_APPT_MADE^T00250NOTE^T00030STREET^T00030CITY
     134        /// ^T00030STATE^T00030ZIP^T00030HOMEPHONE^D00030OldApptDate</returns>
    105135        public DataTable GetRebookedAppointments(string sApptList)
    106136        {
     
    109139        }
    110140
    111         public DataTable GetCancelledAppointments(string sClinicList, DateTime BeginDate, DateTime EndDate)
    112         {
    113             string sBegin = FMDateTime.Create(BeginDate).DateOnly.FMDateString;
    114             string sEnd = FMDateTime.Create(EndDate).DateOnly.FMDateString;
    115             string cmd = String.Format("BSDX CANCEL CLINIC LIST^{0}^{1}^{2}", sClinicList, sBegin, sEnd);
    116             return RPMSDataTable(cmd, "");
    117         }
    118 
    119         /// <summary>
    120         /// Delete All Slots for a Resource
    121         /// </summary>
    122         /// <param name="sResourceID"></param>
     141        /// <summary>
     142        /// Really does what it says! Gets them by going through the BSDX APPOITMENT file index
     143        /// between the specified dates for the Resource.
     144        /// </summary>
     145        /// <param name="sClinicList">| delmited list of Resource IENs in ^BSDXRES</param>
    123146        /// <param name="BeginDate"></param>
    124147        /// <param name="EndDate"></param>
    125         /// <returns></returns>
     148        /// <returns>"T00030Name^D00020DOB^T00030Sex^T00030HRN^D00030NewApptDate^T00030Clinic^T00030TypeStatus
     149        /// ^I00010RESOURCEID^T00030APPT_MADE_BY^D00020DATE_APPT_MADE^T00250NOTE^T00030STREET^T00030CITY
     150        /// ^T00030STATE^T00030ZIP^T00030HOMEPHONE^D00030OldApptDate</returns>
     151        public DataTable GetCancelledAppointments(string sClinicList, DateTime BeginDate, DateTime EndDate)
     152        {
     153            string sBegin = FMDateTime.Create(BeginDate).DateOnly.FMDateString;
     154            string sEnd = FMDateTime.Create(EndDate).DateOnly.FMDateString;
     155            string cmd = String.Format("BSDX CANCEL CLINIC LIST^{0}^{1}^{2}", sClinicList, sBegin, sEnd);
     156            return RPMSDataTable(cmd, "");
     157        }
     158
     159        /// <summary>
     160        /// Delete All Slots for a Resource
     161        /// </summary>
     162        /// <param name="sResourceID">Integer Resource IEN in BSDX RESOURCE</param>
     163        /// <param name="BeginDate">Self-Explanatory</param>
     164        /// <param name="EndDate">Self-Explanatory</param>
     165        /// <returns>Table with 2 columns: ERRORID & ERRORTEXT
     166        /// ErrorID of -1 is A OK (successful operation); anything else is bad.</returns>
    126167        public DataTable MassSlotDelete(string sResourceID, DateTime BeginDate, DateTime EndDate)
    127168        {
     
    168209
    169210        }
    170 
    171 
    172211    }
    173212}
Note: See TracChangeset for help on using the changeset viewer.