Wiki source code of System
Hide last authors
3.1 | 1 | This object provide a few utility functions to access the inners of the Requea platform. | |
1.1 | 2 | ||
3.1 | 3 | == Properties == | |
4.1 | 4 | ||
3.1 | 5 | === User === | |
1.1 | 6 | ||
3.1 | 7 | ReadOnly | |
1.1 | 8 | ||
3.1 | 9 | return: The current logged user object | |
10 | example: | ||
4.1 | 11 | {{code language="javascript"}}var login = System.User.Login;{{/code}} | |
1.1 | 12 | ||
3.1 | 13 | === UserName === | |
1.1 | 14 | ||
3.1 | 15 | ReadOnly | |
1.1 | 16 | ||
3.1 | 17 | return: The currently logged user name | |
4.1 | 18 | ||
3.1 | 19 | === UserLogin === | |
1.1 | 20 | ||
3.1 | 21 | ReadOnly | |
1.1 | 22 | ||
3.1 | 23 | return: The currently logged user login | |
4.1 | 24 | ||
3.1 | 25 | === SessionId === | |
1.1 | 26 | ||
3.1 | 27 | ReadOnly | |
1.1 | 28 | ||
3.1 | 29 | eturn: The current HttpSession ID | |
4.1 | 30 | ||
3.1 | 31 | === IPAddress === | |
1.1 | 32 | ||
3.1 | 33 | ReadOnly | |
1.1 | 34 | ||
3.1 | 35 | return: The IP address of the current user | |
4.1 | 36 | ||
3.1 | 37 | === UserId === | |
1.1 | 38 | ||
3.1 | 39 | ReadOnly | |
1.1 | 40 | ||
3.1 | 41 | return: the logged user id (sysId of the sysPerson) | |
42 | example: | ||
4.1 | 43 | {{code language="javascript"}}data.rqBeneficiary = System.UserId;{{/code}} | |
1.1 | 44 | ||
3.1 | 45 | === Client === | |
1.1 | 46 | ||
3.1 | 47 | ReadOnly | |
1.1 | 48 | ||
3.1 | 49 | return: the client type (browser) | |
4.1 | 50 | ||
3.1 | 51 | === ClientVersion === | |
1.1 | 52 | ||
3.1 | 53 | ReadOnly | |
1.1 | 54 | ||
3.1 | 55 | return: The client version (browser version) | |
4.1 | 56 | ||
3.1 | 57 | === DefaultTimeZoneID === | |
1.1 | 58 | ||
3.1 | 59 | ReadOnly | |
1.1 | 60 | ||
3.1 | 61 | return: the default timezone for the platform. | |
62 | This parameter may be changed in TimeZone system setting | ||
4.1 | 63 | ||
3.1 | 64 | === DefaultLanguage === | |
1.1 | 65 | ||
3.1 | 66 | ReadOnly | |
1.1 | 67 | ||
3.1 | 68 | return: The default language for the platform. | |
69 | This parameter may be changed in Language system setting | ||
4.1 | 70 | ||
3.1 | 71 | === Registry === | |
1.1 | 72 | ||
3.1 | 73 | ReadOnly | |
1.1 | 74 | ||
3.1 | 75 | return: The Registry Object | |
76 | The Registry object. The Registry object is used to access to the entity metadata and provides a few utility functions. | ||
77 | example: | ||
4.1 | 78 | {{code language="javascript"}}var reg = System.Registry; | |
79 | var app = reg.getApplication("rqRequest");{{/code}} | ||
1.1 | 80 | ||
3.1 | 81 | example: | |
4.1 | 82 | {{code language="javascript"}}var values=System.Registry.getOptionValues("2c9e849412dd022b0112f5ed01c8656e"); | |
83 | var first=values[0].sysValue;{{/code}} | ||
1.1 | 84 | ||
3.1 | 85 | === NewGuid === | |
4.1 | 86 | ||
3.1 | 87 | Generates a new Guid | |
88 | ReadOnly | ||
1.1 | 89 | ||
3.1 | 90 | return: The generated guid as a string | |
1.1 | 91 | ||
92 | |||
3.1 | 93 | == Functions == | |
4.1 | 94 | ||
3.1 | 95 | === parseDate(str) === | |
4.1 | 96 | ||
3.1 | 97 | Parse a date from a string | |
1.1 | 98 | ||
3.1 | 99 | return: the parsed date | |
4.1 | 100 | ||
3.1 | 101 | === formatDate(dt, style) === | |
4.1 | 102 | ||
3.1 | 103 | Format a date. The string representation is based on the locale of the user | |
4.1 | 104 | ||
3.1 | 105 | * dt. The date to format | |
106 | * style. The style parameter can be: "long", "short", "medium", "full" or "ISO8601". By default, the style is "medium" | ||
1.1 | 107 | ||
4.1 | 108 | return: The formatted date as a string | |
109 | |||
3.1 | 110 | === formatNumber(obj, pattern) === | |
4.1 | 111 | ||
3.1 | 112 | Format a number as a string. The string representation is based on the locale of the user | |
1.1 | 113 | ||
4.1 | 114 | return: The formatted number. | |
115 | |||
116 | === formatDateTime(dt, style, timezone) === | ||
117 | |||
3.1 | 118 | Format a date time | |
4.1 | 119 | ||
3.1 | 120 | * dt. The date to format | |
121 | * style. The style parameter can be: "long", "short", "medium", "full" or "ISO8601". By default, the style is "medium" | ||
4.1 | 122 | * timezone : The timezone for the rendering. By default the server timezone is used. | |
1.1 | 123 | ||
4.1 | 124 | return: The formatted date as a string | |
125 | |||
3.1 | 126 | === formatTime(dt, style) === | |
4.1 | 127 | ||
3.1 | 128 | Format the time portion of a date time. | |
4.1 | 129 | ||
3.1 | 130 | * dt. The date to format | |
131 | * style. The style parameter can be: "long", "short", "medium", "full" or "ISO8601". By default, the style is "medium" | ||
1.1 | 132 | ||
4.1 | 133 | return: The formatted time as a string. | |
134 | |||
135 | === parseDateTime(str, format(% style="font-size: 20.4400005340576px; background-color: rgb(245, 245, 245);" %), timezone)(%%) === | ||
136 | |||
3.1 | 137 | Parse a date time | |
4.1 | 138 | ||
3.1 | 139 | * str. The string to parse | |
140 | * format. The java SimpleDateFormat used for the parsing | ||
4.1 | 141 | * timezone. The timezone corresponding to the time. (% style="font-family: sans-serif; font-size: 14px; font-style: normal; line-height: 19.6000003814697px; text-align: start;" %) By default the server timezone is used. | |
1.1 | 142 | ||
3.1 | 143 | return.: The parsed date | |
4.1 | 144 | ||
3.1 | 145 | === getDayOfDate(obj) === | |
4.1 | 146 | ||
3.1 | 147 | Extract the date portion of a time stamp. The date is rounded at 0:00:00, based on the timezone of the user. | |
4.1 | 148 | ||
3.1 | 149 | * the date and time (timestamp) | |
1.1 | 150 | ||
3.1 | 151 | return: the date | |
4.1 | 152 | ||
3.1 | 153 | === getTimeOfDate(obj) === | |
4.1 | 154 | ||
3.1 | 155 | Extract the time portion of a date time | |
4.1 | 156 | ||
3.1 | 157 | * the time stamp | |
1.1 | 158 | ||
3.1 | 159 | return: the time as a number of milliseconds since 0:00:00 | |
4.1 | 160 | ||
3.1 | 161 | === isMemberOfGroup(objusr, grpname) === | |
4.1 | 162 | ||
3.1 | 163 | Check if a user is a member of a group | |
4.1 | 164 | ||
3.1 | 165 | * user: The user | |
166 | * grpname: the group name | ||
1.1 | 167 | ||
3.1 | 168 | return: true if the user belongs to this group | |
4.1 | 169 | ||
1.1 | 170 | === hasBundleAccess(bid) === | |
4.1 | 171 | ||
3.1 | 172 | Checks if the current user may edit a bundle given its id. | |
4.1 | 173 | ||
3.1 | 174 | * bundle Id | |
1.1 | 175 | ||
3.1 | 176 | return: true if the user has edit access | |
4.1 | 177 | ||
1.1 | 178 | === EvalScript(jsScript, jsContext) === | |
4.1 | 179 | ||
3.1 | 180 | Eval a script | |
1.1 | 181 | ||
3.1 | 182 | return: the return value of the script evaluation | |
4.1 | 183 | ||
1.1 | 184 | === executeSQL(strCommand) === | |
4.1 | 185 | ||
3.1 | 186 | Execute a row SQL command. | |
187 | Note that some updates made by hibernate may not yet have been flushed to the database | ||
1.1 | 188 | ||
189 | === Encrypt(cipher, value, type) === | ||
4.1 | 190 | ||
3.1 | 191 | Encrypt a string | |
4.1 | 192 | ||
3.1 | 193 | * cipher. only 3DES is supported for now | |
1.1 | 194 | ||
3.1 | 195 | return: the encrypted value as a string | |
4.1 | 196 | ||
1.1 | 197 | === Decrypt(cipher, value, type) === | |
4.1 | 198 | ||
3.1 | 199 | Decrypt a string | |
1.1 | 200 | ||
3.1 | 201 | return: the decrypted value as a string | |
4.1 | 202 | ||
3.1 | 203 | === getLineCount(code) === | |
4.1 | 204 | ||
3.1 | 205 | Count the number of lines in a script | |
1.1 | 206 | ||
3.1 | 207 | return: the number of lines as an integer. |