Difference between revisions of "Quota new"

From Catglobe Wiki
Jump to: navigation, search
 
(One intermediate revision by one other user not shown)
Line 17: Line 17:
 
- quotaExpression : the expression of quota.  
 
- quotaExpression : the expression of quota.  
  
−
- PQResourceId : Id of questionnaire to which quota belongs  
+
- PQResourceId : Resource Id of questionnaire to which quota belongs. If it's empty, the project questionnaire context is needed
  
 
'''Return type'''  
 
'''Return type'''  
  
 
array  
 
array  
−
<table width="651" cellspacing="0" cellpadding="2" border="1" style="border-collapse:collapse; border:1px solid #010101" class="tableintopic">
 
−
<tbody><tr valign="top" align="left">
 
−
<td width="318" bgcolor="#BFBFBF" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Index</strong></p>
 
−
</td>
 
−
<td width="116" bgcolor="#BFBFBF" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Data type</strong></p>
 
−
</td>
 
−
<td width="217" bgcolor="#BFBFBF" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Initial value</strong></p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[OBJECT_TYPE]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">number</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">Quota object</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[QUOTA_ID]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">number</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">0</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[QUOTA_NAME]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">string</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">Entered value</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[QUOTA_TARGET]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">number</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">Entered value</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[QUOTA_EXPRESSION]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">string</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">Entered value</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[QUOTA_QUESTIONNAIRE_RESOURCE_ID]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">number</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">Entered value ( current PQ resource id if no entered value)</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[QUOTA_DESCRIPTION]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">string</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">empty string</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[QUOTA_PRESTRATIFICATION]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">bool</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">FALSE</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[QUOTA_DISABLED]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">bool</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">FALSE</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[QUOTA_CURRENT]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">number (read only)</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">0</p>
 
−
</td>
 
−
</tr>
 
−
<tr valign="top" align="left">
 
−
<td width="318" style="border:1px solid #010101;"><p class="bodytext">[QUOTA_ONGOING]</p>
 
−
</td>
 
−
<td width="116" style="border:1px solid #010101;"><p class="bodytext">number (read only)</p>
 
−
</td>
 
−
<td width="217" style="border:1px solid #010101;"><p class="bodytext">0</p>
 
−
</td>
 
−
</tr>
 
  
−
</tbody></table>
+
{| width="651" class="tableintopic" style="border: 1px solid rgb(1, 1, 1); border-collapse: collapse;" border="1" cellspacing="0" cellpadding="2"
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" bgcolor="#bfbfbf" |
 +
'''Index'''
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" bgcolor="#bfbfbf" |
 +
'''Data type'''
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" bgcolor="#bfbfbf" |
 +
'''Initial value'''
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[OBJECT_TYPE]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
number
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
Quota object
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[QUOTA_ID]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
number
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
0
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[QUOTA_NAME]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
string
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
Entered value
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[QUOTA_TARGET]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
number
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
Entered value
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[QUOTA_EXPRESSION]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
string
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
Entered value
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[QUOTA_QUESTIONNAIRE_RESOURCE_ID]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
number
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
Entered value ( current PQ resource id if no entered value)
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[QUOTA_DESCRIPTION]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
string
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
empty string
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[QUOTA_PRESTRATIFICATION]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
bool
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
FALSE
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[QUOTA_DISABLED]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
bool
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
FALSE
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[QUOTA_CURRENT]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
number (read only)
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
0
 +
 
 +
|- align="left" valign="top"
 +
| width="318" style="border: 1px solid rgb(1, 1, 1);" |
 +
[QUOTA_ONGOING]
 +
 
 +
| width="116" style="border: 1px solid rgb(1, 1, 1);" |
 +
number (read only)
 +
 
 +
| width="217" style="border: 1px solid rgb(1, 1, 1);" |
 +
0
 +
 
 +
|}
  
 
'''Example'''  
 
'''Example'''  
  
−
array a = Quota_new("male",5,"Qsingle == 1");  
+
array a = Quota_new("Arkitekt",5,"Q3 == [1-5]",5310088);
 +
 
 +
print(a);
  
 
OR  
 
OR  
  
−
array a = Quota_new("male",5,"Qsingle == 1",34806989);  
+
array a = Quota_new("Arkitekt",5,"Q3 == [1-5]");  
 +
 
 +
print(a);
 +
 
 +
//{26,0,Arkitekt,5,Q3 == [1-5],5310088,,False,False,0,0}
 +
 
  
 
'''Availability'''  
 
'''Availability'''  

Latest revision as of 11:57, 3 January 2012



Quota_new

To create a new quota object.

Syntax

array Quota_new(string quotaName, number quotaTarget, string quotaExpression[, number PQResourceId])

Arguments

- quotaName : the name of new quota.

- quotaTarget : the target of quota.

- quotaExpression : the expression of quota.

- PQResourceId : Resource Id of questionnaire to which quota belongs. If it's empty, the project questionnaire context is needed

Return type

array

Index

Data type

Initial value

[OBJECT_TYPE]

number

Quota object

[QUOTA_ID]

number

0

[QUOTA_NAME]

string

Entered value

[QUOTA_TARGET]

number

Entered value

[QUOTA_EXPRESSION]

string

Entered value

[QUOTA_QUESTIONNAIRE_RESOURCE_ID]

number

Entered value ( current PQ resource id if no entered value)

[QUOTA_DESCRIPTION]

string

empty string

[QUOTA_PRESTRATIFICATION]

bool

FALSE

[QUOTA_DISABLED]

bool

FALSE

[QUOTA_CURRENT]

number (read only)

0

[QUOTA_ONGOING]

number (read only)

0

Example

array a = Quota_new("Arkitekt",5,"Q3 == [1-5]",5310088);

print(a);

OR

array a = Quota_new("Arkitekt",5,"Q3 == [1-5]");

print(a);

//{26,0,Arkitekt,5,Q3 == [1-5],5310088,,False,False,0,0}


Availability

Version 5.8

Retrieved from "http://wiki.catglobe.com/index.php?title=Quota_new&oldid=23186"