Rev 18103 | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
18103 | bpr | 1 | !! +exec+ +score+ +subst+ +var+ +adm+ |
2 | tit:getsheetstatus |
||
3 | type:$type_both; $type_adm |
||
4 | |||
5 | syntax:!getsheetstatus ``[class=qclass]'' ``[user=quser]'' ``[sheet=qsheet]'' |
||
6 | mean:return 0 if the current sheet is in preparation, 1 if it is activated,\ |
||
7 | 2 if it is expired and 3 if it is hidden.\ |
||
8 | The technical variables attached to quser in qclass are taken in account.\ |
||
9 | so if the current sheet is activate or expired, the sheet can be hidden if the technical\ |
||
10 | conditions are fulled.\ |
||
11 | <ul><li>Default value for class is ``wims_class''.</li> \ |
||
18170 | bpr | 12 | <li>Default value for user is ``wims_user''.</li></ul>\ |
13 | Write ``!getsheetstatus user=no'' to ask the generic status of the sheet.\ |
||
14 | The command can be used in non administrative module if no user and no class is specified.\ |
||
15 | So it applies to the current ``wims_user'' and ``wims_class''. |
||
18103 | bpr | 16 | |
17 | One can have the following values\ |
||
18 | <table class="wimsborder"><tr><th>getscorestatus</th><th>getscorestatus with tech</th><th>getsheetstatus</th><th>getsheetstatus with techn. cond. can be</th><tr>\ |
||
19 | <tr><td>no</td><td>no</td><td>0</td><td>0</td></tr>\ |
||
20 | <tr><td>yes</td><td>yes | no</td><td>1</td><td>1 | 3</td></tr>\ |
||
21 | <tr><td>no</td><td>no</td><td>2</td><td>2 | 3</td></tr>\ |
||
22 | <tr><td>no</td><td>no</td><td>3</td><td>3</td></tr>\ |
||
23 | </table>\ |