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