Difference between revisions of "Quota new"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
−
[[Category:Questionnaire_Functions]]
+
{{HelpFiles}}  
−
{{HelpFiles}}
+
 
 +
==== Quota_new ====
  
−
====Quota_new====
+
To create a new quota object.
  
−
To create a new quota object.
+
'''Syntax'''
  
−
'''Syntax'''
+
array Quota_new(string quotaName, number quotaTarget, string quotaExpression[, number PQResourceId])
  
−
array Quota_new(string quotaName, number quotaTarget, string quotaExpression[, number PQResourceId])
+
'''Arguments'''
  
−
'''Arguments'''
+
- quotaName : the name of new quota.
  
−
- quotaName : the name of new quota.
+
- quotaTarget : the target of quota.  
  
−
- quotaTarget : the target of quota.
+
- quotaExpression : the expression of quota.  
  
−
- quotaExpression : the expression of quota.
+
- PQResourceId : Id of questionnaire to which quota belongs
  
−
- PQResourceId : Id of questionnaire to which quota belongs
+
'''Return type'''
  
−
'''Return type'''
+
array [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
  
−
array
+
'''Example'''
−
[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
 
  
−
'''Example'''
+
array a = Quota_new("male",5,"Qsingle == 1");
  
−
array a = Quota_new("male",5,"Qsingle == 1");
+
OR
  
−
OR
+
array a = Quota_new("male",5,"Qsingle == 1",34806989);
  
−
array a = Quota_new("male",5,"Qsingle == 1",34806989);
+
'''Availability'''
  
−
'''Availability'''
+
Version 5.8
  
−
Version 5.8
+
[[Category:Questionnaire_Functions]]
−
__NOTOC__
 
−
<!-- imported from file: 8019.htm-->
 

Revision as of 09:07, 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 [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

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=20805"