Project getProjectByName: Difference between revisions
More actions
|  jrfconvert import | No edit summary | ||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| {{HelpFiles}}  | |||
|  | |||
| ====Project_getProjectByName==== | ==== Project_getProjectByName  ==== | ||
| Get a project by its qualified name. If no project is found with that name, empty will be returned. | Get a project by its qualified name. If no project is found with that name, empty will be returned.   | ||
| '''Syntax''' | '''Syntax'''   | ||
| Project_getProjectByName(''qualifiedName'') | Project_getProjectByName(''qualifiedName'')   | ||
| '''Arguments''' | '''Arguments'''   | ||
| * ''qualifiedName'': is a ''string ''expression. It is the qualified name of the project | *''qualifiedName'': is a ''string ''expression. It is the qualified name of the project | ||
| '''Return value''' | '''Return value'''   | ||
| An ''array'', it is  | An ''array'', it is a project object which contains the following items  | ||
| ''' | {| width="875" cellspacing="0" cellpadding="2" border="1" class="tableintopic" style="border: 1px solid rgb(1, 1, 1); border-collapse: collapse;" | ||
| |- valign="top" align="left" | |||
| | width="292" bgcolor="#c0c0c0" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| '''Index'''   | |||
| | width="116" bgcolor="#c0c0c0" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| '''Data type'''   | |||
| ''' | | width="467" bgcolor="#c0c0c0" style="border: 1px solid rgb(1, 1, 1);" |  | ||
| '''Value'''   | |||
| Version 5.6 | |- valign="top" align="left" | ||
| __NOTOC__ | | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | ||
| <!-- imported from file: 6261.htm--> | <span class="normalise">OBJECT_TYPE</span>  | ||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">number</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Object type (Default value: 4)</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_RESOURCE_ID</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">number</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Resource id (Default value: 0)</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_NAME</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">string</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Project name</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_TEMPLATE_RESOURCE_ID</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">number</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Project template's resource id</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_TIME_REGISTRATION</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">bool</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">If time registration is allowed (Default value: True)</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_COMPLETED</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">bool</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Complete a project (Default value: False)</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_PARENT_RESOURCE_ID</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">number</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Project's path</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_CODE</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">string</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Project code</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_PROPOSE_CODE</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">number</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Propose Code [Read Only]</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_CLIENT_REF_NO</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">string</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Client ref no (Default value: Empty)</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_TIME_BUDGET</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">number</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Time Budget</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_CALCULATED_MAN_HOURS</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">bool</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Calculated Man-Hours (Default value: False)</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_PLANNED_START_DATE</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">array (date time)</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Planned Start Date (Default value: MinDate)</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_ACTUAL_START_DATE</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">array (date time)</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Actual Start Date (Default value: MinDate)</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_PLANNED_END_DATE</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">array (date time)</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Planned End Date (Default value: MaxDate)</span>  | |||
| |- valign="top" align="left" | |||
| | width="292" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">PROJECT_ACTUAL_END_DATE</span>  | |||
| | width="116" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">array (date time)</span>  | |||
| | width="467" style="border: 1px solid rgb(1, 1, 1);" |  | |||
| <span class="normalise">Actual End Date (Default value: MaxDate)</span>  | |||
| |} | |||
| '''Example'''  | |||
| ''array project = Project_getProjectByName("CATINET\\Internal Projects\\Administration\\1014cat - Administration - old 14");''  | |||
| ''print(project);''  | |||
| ''//{4,1252151,1014cat - Administration - old 14,34409960,True,False,1168810,,0,,0,False,{1,1,1,7,0,0,0,1,65},{1,1,1,7,0,0,0,1,65},{9999,12,31,23,59,59,999,52,65},{9999,12,31,23,59,59,999,52,65}}''  | |||
| '''Availability'''  | |||
| Version 5.6 __NOTOC__ <!-- imported from file: 6261.htm-->   | |||
| [[Category:Project]] | |||
Latest revision as of 10:11, 22 December 2011
Project_getProjectByName
Get a project by its qualified name. If no project is found with that name, empty will be returned.
Syntax
Project_getProjectByName(qualifiedName)
Arguments
- qualifiedName: is a string expression. It is the qualified name of the project
Return value
An array, it is a project object which contains the following items
| Index | Data type | Value | 
| OBJECT_TYPE | number | Object type (Default value: 4) | 
| PROJECT_RESOURCE_ID | number | Resource id (Default value: 0) | 
| PROJECT_NAME | string | Project name | 
| PROJECT_TEMPLATE_RESOURCE_ID | number | Project template's resource id | 
| PROJECT_TIME_REGISTRATION | bool | If time registration is allowed (Default value: True) | 
| PROJECT_COMPLETED | bool | Complete a project (Default value: False) | 
| PROJECT_PARENT_RESOURCE_ID | number | Project's path | 
| PROJECT_CODE | string | Project code | 
| PROJECT_PROPOSE_CODE | number | Propose Code [Read Only] | 
| PROJECT_CLIENT_REF_NO | string | Client ref no (Default value: Empty) | 
| PROJECT_TIME_BUDGET | number | Time Budget | 
| PROJECT_CALCULATED_MAN_HOURS | bool | Calculated Man-Hours (Default value: False) | 
| PROJECT_PLANNED_START_DATE | array (date time) | Planned Start Date (Default value: MinDate) | 
| PROJECT_ACTUAL_START_DATE | array (date time) | Actual Start Date (Default value: MinDate) | 
| PROJECT_PLANNED_END_DATE | array (date time) | Planned End Date (Default value: MaxDate) | 
| PROJECT_ACTUAL_END_DATE | array (date time) | Actual End Date (Default value: MaxDate) | 
Example
array project = Project_getProjectByName("CATINET\\Internal Projects\\Administration\\1014cat - Administration - old 14");
print(project);
//{4,1252151,1014cat - Administration - old 14,34409960,True,False,1168810,,0,,0,False,{1,1,1,7,0,0,0,1,65},{1,1,1,7,0,0,0,1,65},{9999,12,31,23,59,59,999,52,65},{9999,12,31,23,59,59,999,52,65}}
Availability
Version 5.6
