Difference between revisions of "Quota new"

From Catglobe Wiki
Jump to: navigation, search
Line 22: Line 22:
  
 
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>
  
−
[OBJECT_TYPE] | style="border: 1px solid #010101" width="116" | number | style="border: 1px solid #010101" width="217" | Quota object |- align="left" valign="top" | style="border: 1px solid #010101" width="318" | [QUOTA_ID] | style="border: 1px solid #010101" width="116" | number | style="border: 1px solid #010101" width="217" | 0 |- align="left" valign="top" | style="border: 1px solid #010101" width="318" | [QUOTA_NAME] | style="border: 1px solid #010101" width="116" | string | style="border: 1px solid #010101" width="217" | Entered value |- align="left" valign="top" | style="border: 1px solid #010101" width="318" | [QUOTA_TARGET] | style="border: 1px solid #010101" width="116" | number | style="border: 1px solid #010101" width="217" | Entered value |- align="left" valign="top" | style="border: 1px solid #010101" width="318" | [QUOTA_EXPRESSION] | style="border: 1px solid #010101" width="116" | string | style="border: 1px solid #010101" width="217" | Entered value |- align="left" valign="top" | style="border: 1px solid #010101" width="318" | [QUOTA_QUESTIONNAIRE_RESOURCE_ID] | style="border: 1px solid #010101" width="116" | number | style="border: 1px solid #010101" width="217" | Entered value ( current PQ resource id if no entered value) |- align="left" valign="top" | style="border: 1px solid #010101" width="318" | [QUOTA_DESCRIPTION] | style="border: 1px solid #010101" width="116" | string | style="border: 1px solid #010101" width="217" | empty string |- align="left" valign="top" | style="border: 1px solid #010101" width="318" | [QUOTA_PRESTRATIFICATION] | style="border: 1px solid #010101" width="116" | bool | style="border: 1px solid #010101" width="217" | FALSE |- align="left" valign="top" | style="border: 1px solid #010101" width="318" | [QUOTA_DISABLED] | style="border: 1px solid #010101" width="116" | bool | style="border: 1px solid #010101" width="217" | FALSE |- align="left" valign="top" | style="border: 1px solid #010101" width="318" | [QUOTA_CURRENT] | style="border: 1px solid #010101" width="116" | number (read only) | style="border: 1px solid #010101" width="217" | 0 |- align="left" valign="top" | style="border: 1px solid #010101" width="318" | [QUOTA_ONGOING] | style="border: 1px solid #010101" width="116" | number (read only) | style="border: 1px solid #010101" width="217" | 0
+
</tbody></table>
  
 
'''Example'''  
 
'''Example'''  

Revision as of 10:19, 15 December 2011



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 : Id of questionnaire to which quota belongs

Return type

array

<tbody> </tbody>

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("male",5,"Qsingle == 1");

OR

array a = Quota_new("male",5,"Qsingle == 1",34806989);

Availability

Version 5.8

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