Quota new: Difference between revisions

← Older edit

VisualWikitext

Latest revision as of 09: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

@@ Line 1: / Line 1: @@
 {{HelpFiles}}
-==== Quota_new ====
+==== Quota_new  ====
 To create a new quota object.
@@ Line 17: / Line 17: @@
 - quotaExpression&nbsp;: the expression of quota.
-- PQResourceId&nbsp;: Id of questionnaire to which quota belongs
+- PQResourceId&nbsp;: Resource Id of questionnaire to which quota belongs. If it's empty, the project questionnaire context is needed
 '''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
+{| 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);" |
+|- 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);" |
+|- 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);" |
+|}
 '''Example'''
-array a = Quota_new("male",5,"Qsingle == 1");
+array a = Quota_new("Arkitekt",5,"Q3 == [1-5]",5310088);
+print(a);
 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'''