Difference between revisions of "Group new"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{HelpFiles}}  
 
{{HelpFiles}}  
  
==== Group_new ====
+
==== Group_new ====
  
 
Create a group object  
 
Create a group object  
Line 17: Line 17:
 
'''Return value'''  
 
'''Return value'''  
  
An ''array'', it is the group object which contains the following information
+
An ''array'', it is the group object which contains the following information  
<table width="875" cellspacing="0" cellpadding="2" border="1" style="border-collapse:collapse; border:1px solid #010101" class="tableintopic">
 
<tbody><tr valign="top" align="left">
 
<td width="292" bgcolor="#C0C0C0" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Index</strong></p>
 
</td>
 
<td width="92" bgcolor="#C0C0C0" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Data type</strong></p>
 
</td>
 
<td width="491" bgcolor="#C0C0C0" style="border:1px solid #010101;"><p class="bodytext"><strong class="specialbold">Value</strong></p>
 
</td>
 
</tr>
 
<tr valign="top" align="left">
 
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_RESOURCE_ID</p>
 
</td>
 
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
 
</td>
 
<td width="491" style="border:1px solid #010101;"><p class="bodytext">Resource id of the group</p>
 
</td>
 
</tr>
 
<tr valign="top" align="left">
 
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_NAME</p>
 
</td>
 
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">string</span></p>
 
</td>
 
<td width="491" style="border:1px solid #010101;"><p class="bodytext">Name of the group</p>
 
</td>
 
</tr>
 
<tr valign="top" align="left">
 
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_TEMPLATE_RESOURCE_ID</p>
 
</td>
 
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
 
</td>
 
<td width="491" style="border:1px solid #010101;"><p class="bodytext">Group template's resource id</p>
 
</td>
 
</tr>
 
<tr valign="top" align="left">
 
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_PARENT_RESOURCE_ID</p>
 
</td>
 
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
 
</td>
 
<td width="491" style="border:1px solid #010101;"><p class="bodytext">Parent's resource id</p>
 
</td>
 
</tr>
 
<tr valign="top" align="left">
 
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_TIME_REGISTRATION</p>
 
</td>
 
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">bool</span></p>
 
</td>
 
<td width="491" style="border:1px solid #010101;"><p class="bodytext">If time registration is allowed on the group</p>
 
</td>
 
</tr>
 
<tr valign="top" align="left">
 
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_MAN_HOURS</p>
 
</td>
 
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">number</span></p>
 
</td>
 
<td width="491" style="border:1px solid #010101;"><p class="bodytext">The budget time for the group</p>
 
</td>
 
</tr>
 
<tr valign="top" align="left">
 
<td width="292" style="border:1px solid #010101;"><p class="bodytext">GROUP_CALCULATED_MAN_HOURS</p>
 
</td>
 
<td width="92" style="border:1px solid #010101;"><p class="bodytext"><span class="normalise">bool</span></p>
 
</td>
 
<td width="491" style="border:1px solid #010101;"><p class="bodytext">If the budget time is calculated based on time set in Team tab</p>
 
</td>
 
</tr>
 
  
</tbody></table>
+
{| width="875" class="tableintopic" style="border: 1px solid rgb(1, 1, 1); border-collapse: collapse;" border="1" cellspacing="0" cellpadding="2"
 +
|- align="left" valign="top"
 +
| width="292" style="border: 1px solid rgb(1, 1, 1);" bgcolor="#c0c0c0" |
 +
'''Index'''
  
 +
| width="92" style="border: 1px solid rgb(1, 1, 1);" bgcolor="#c0c0c0" |
 +
'''Data type'''
  
'''Availability'''  
+
| width="491" style="border: 1px solid rgb(1, 1, 1);" bgcolor="#c0c0c0" |
 +
'''Value'''
  
Version 5.6 __NOTOC__
+
|- align="left" valign="top"
 +
| width="292" style="border: 1px solid rgb(1, 1, 1);" |
 +
GROUP_RESOURCE_ID
 +
 
 +
| width="92" style="border: 1px solid rgb(1, 1, 1);" |
 +
<span class="normalise">number</span>
 +
 
 +
| width="491" style="border: 1px solid rgb(1, 1, 1);" |
 +
Resource id of the group
 +
 
 +
|- align="left" valign="top"
 +
| width="292" style="border: 1px solid rgb(1, 1, 1);" |
 +
GROUP_NAME
 +
 
 +
| width="92" style="border: 1px solid rgb(1, 1, 1);" |
 +
<span class="normalise">string</span>
 +
 
 +
| width="491" style="border: 1px solid rgb(1, 1, 1);" |
 +
Name of the group
 +
 
 +
|- align="left" valign="top"
 +
| width="292" style="border: 1px solid rgb(1, 1, 1);" |
 +
GROUP_TEMPLATE_RESOURCE_ID
 +
 
 +
| width="92" style="border: 1px solid rgb(1, 1, 1);" |
 +
<span class="normalise">number</span>
 +
 
 +
| width="491" style="border: 1px solid rgb(1, 1, 1);" |
 +
Group template's resource id
 +
 
 +
|- align="left" valign="top"
 +
| width="292" style="border: 1px solid rgb(1, 1, 1);" |
 +
GROUP_PARENT_RESOURCE_ID
 +
 
 +
| width="92" style="border: 1px solid rgb(1, 1, 1);" |
 +
<span class="normalise">number</span>
 +
 
 +
| width="491" style="border: 1px solid rgb(1, 1, 1);" |
 +
Parent's resource id
 +
 
 +
|- align="left" valign="top"
 +
| width="292" style="border: 1px solid rgb(1, 1, 1);" |
 +
GROUP_TIME_REGISTRATION
 +
 
 +
| width="92" style="border: 1px solid rgb(1, 1, 1);" |
 +
<span class="normalise">bool</span>
 +
 
 +
| width="491" style="border: 1px solid rgb(1, 1, 1);" |
 +
If time registration is allowed on the group
 +
 
 +
|- align="left" valign="top"
 +
| width="292" style="border: 1px solid rgb(1, 1, 1);" |
 +
GROUP_MAN_HOURS
 +
 
 +
| width="92" style="border: 1px solid rgb(1, 1, 1);" |
 +
<span class="normalise">number</span>
 +
 
 +
| width="491" style="border: 1px solid rgb(1, 1, 1);" |
 +
The budget time for the group
 +
 
 +
|- align="left" valign="top"
 +
| width="292" style="border: 1px solid rgb(1, 1, 1);" |
 +
GROUP_CALCULATED_MAN_HOURS
 +
 
 +
| width="92" style="border: 1px solid rgb(1, 1, 1);" |
 +
<span class="normalise">bool</span>
 +
 
 +
| width="491" style="border: 1px solid rgb(1, 1, 1);" |
 +
If the budget time is calculated based on time set in Team tab
 +
 
 +
|}
 +
 
 +
<br> '''Availability'''
 +
 
 +
Version 5.6 __NOTOC__  
  
 
[[Category:Group_Functions]]
 
[[Category:Group_Functions]]

Revision as of 07:06, 19 December 2011



Group_new

Create a group object

Syntax

Group_new(name, groupTemplateResourceId, parentResourceId)

Arguments

  • name: is a string expression. It is the name of the group, which must follow the standard format of resource name
  • groupTemplateResourceId: is a number expression. It is the resource id of the group's resource template
  • parentResourceId: is a number expression. It is the resource id of the group's parent

Return value

An array, it is the group object which contains the following information

Index

Data type

Value

GROUP_RESOURCE_ID

number

Resource id of the group

GROUP_NAME

string

Name of the group

GROUP_TEMPLATE_RESOURCE_ID

number

Group template's resource id

GROUP_PARENT_RESOURCE_ID

number

Parent's resource id

GROUP_TIME_REGISTRATION

bool

If time registration is allowed on the group

GROUP_MAN_HOURS

number

The budget time for the group

GROUP_CALCULATED_MAN_HOURS

bool

If the budget time is calculated based on time set in Team tab


Availability

Version 5.6