Differences

This shows you the differences between two versions of the page.

Link to this comparison view

72:scripting_project_class [2018/07/24 16:47]
bkkr created
72:scripting_project_class [2018/07/24 19:47] (current)
bkkr [ProjectClass]
Line 2: Line 2:
  
 ====== ProjectClass ====== ====== ProjectClass ======
 +
 +It corresponds to the organizational structure ("​project structure"​) in Stages.
 +
 +**ID**
 +
 +   * Type: String
 +  * Documentation:​ Project ID; can be used to generate internal Stages URL links
 +
 +**Name**
 +
 +  * Type: String
 +  * Documentation:​ Name of the project as visible on the Stages project naviation
 +
 +**Description**
 +
 +  * Type: String
 +  * Documentation:​ Project description;​ In Stages you find this information in the project administratin or at the "At a glance"​ page. (HTML encoded)
 +
 +**Properties**
 +
 +  * Type: String
 +  * Documentation:​ Returns the properties which are set for the project (Project Administration).
 +      * Possible value (separated by comma):
 +        * inactive - project is not active (e.g. stopped or archived)
 +        * logbook - infocenter
 +        * downloadcenter - infocenter
 +        * groupParent - activate project group
 +        * reviewProject - review-project
 +        * disableCMS - disable access to all files managed in a CM system
 +      * Suppress project variable expansion (e.g. %PROJECTNAME%)
 +        * suppressVariableExpansion
 +
 +**Categories**
 +
 +  * Type: Sting
 +  * Documentation:​ Returns the infocenter categories which are enabled for project (Project Administration)
 +      * The values (comma separated) match to the PKitConfig.xml categories ident values.
 +
 +**State**
 +
 +  * Type: String
 +  * Documentation:​ Project state ("At a glance - Project State"​);​ Return value will be the name in the (<​projectstatename="​red"/>​) quickview projectstate tag from PKitConfig.xml.
 +      * Returns nothing if previous state was undefined.
 +
 +**PreviousState**
 +
 +  * Type: String
 +  * Documentation:​ Previous Project state ("At a glance - Project State"​);​ Return value will be the name in the (<​projectstatename="​red"/>​) quickview projectstate tag from PKitConfig.xml.
 +      * Returns nothing if previous state was undefined
 +
 +**PreviousStateChange**
 +
 +  * Type: Timestamp
 +  * Documentation:​ N/A
 +
 +**RequestConfig**
 +
 +  * Type: String
 +  * Documentation:​ Name (indent) of the request configuration
 +
 +**StateChangeComment**
 +
 +  * Type: String
 +  * Documentation:​ Comment of the last project state change (HTML encoded)
 +
 +**LastAccess**
 +
 +  * Type: Integer
 +  * Documentation:​ N/A
 +
 +**DisplayDescription**
 +
 +  * Type: Description
 +  * Documentation:​ Returns a description of the workspace description.
 +
 +**Variables**
 +
 +  * Type: Map
 +  * Documentation:​ Returns a JAVA map with all variables and their values.