Jump to: navigation, search

Difference between revisions of "Orion/Documentation/Developer Guide/Project services"

(Created page with "= Overview of project services = Orion allows to extend the project functionality by adding other project types. Project types are not exclusive, one project may be of two dif...")
 
(Service properties)
Line 12: Line 12:
 
== Service properties ==
 
== Service properties ==
 
; id
 
; id
 +
: <tt>String</tt>
 
; type
 
; type
 +
: <tt>String</tt> the unique identifier of the project type (for instance ''git'' or ''jazz'')
 
; addParamethers
 
; addParamethers
 +
: <tt>ParameterDefinition[]</tt> Array of objects containing '''id''' <tt>String</tt>, '''type''' <tt>String</tt> describing one of the html5 input types or "textarea" and '''name''' being a display <tt>String</tt> for the parameter. Those parameters will be used to generate an input form when user tries init and new project or dependency.
 
; optionalParamethers
 
; optionalParamethers
 +
: ''Since 5.0'' <tt>arameterDefinition[]</tt> a list of optional parameters that will display in a separate dialog when user clicks "More" in the input form with '''addParamethers'''
 
; addDependencyName
 
; addDependencyName
 +
: <tt>String</tt> Name of the action for adding dependency
 
; addDependencyTooltip
 
; addDependencyTooltip
 +
: <tt>String</tt> Tooltip of the action for adding dependency
 
; addProjectName
 
; addProjectName
 +
: <tt>String</tt> Name of the action for adding project
 
; addProjectTooltip
 
; addProjectTooltip
 +
: <tt>String</tt> Tooltip of the action for adding project
 
; actionComment
 
; actionComment
 +
: ''optional'' <tt>String</tt> comment displayed when project or dependency are being initialized
 
; validationProperties
 
; validationProperties
 +
''optional'' <tt>ValidationProperties[]</tt> that define if given item can be handled by this project handler, see [[Orion/Documentation/Developer Guide/Plugging into Orion_pages#Validation_Properties | Validation Properties]]
  
 
== Service methods ==
 
== Service methods ==

Revision as of 07:31, 8 November 2013

Overview of project services

Orion allows to extend the project functionality by adding other project types. Project types are not exclusive, one project may be of two different types.

orion.project.handler

The orion.project.handler service is used to provide a custom project handler. Creating a custom project handler enables to:

  • Creating project of given type
  • Adding dependencies of given type
  • Adding additional information to project page

Service properties

id
String
type
String the unique identifier of the project type (for instance git or jazz)
addParamethers
ParameterDefinition[] Array of objects containing id String, type String describing one of the html5 input types or "textarea" and name being a display String for the parameter. Those parameters will be used to generate an input form when user tries init and new project or dependency.
optionalParamethers
Since 5.0 arameterDefinition[] a list of optional parameters that will display in a separate dialog when user clicks "More" in the input form with addParamethers
addDependencyName
String Name of the action for adding dependency
addDependencyTooltip
String Tooltip of the action for adding dependency
addProjectName
String Name of the action for adding project
addProjectTooltip
String Tooltip of the action for adding project
actionComment
optional String comment displayed when project or dependency are being initialized
validationProperties

optional ValidationProperties[] that define if given item can be handled by this project handler, see Validation Properties

Service methods

getAdditionalProjectProperties (item, projectMetadata)
initProject (params, projectMetadata)
initDependency (dependency, params, projectMetadata)
getDependencyDescription (item)
paramsToDependencyDescription (params)