Class Index | File Index

Classes


Namespace dynaGroupDefinitions

Provides access to dynamic group definitions
Defined in: rhqapi.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
dynaGroupDefinitions.create(params)
Creates a new dynagroup definition with given parameters.
<static>  
dynaGroupDefinitions.edit(dynagroupDefName, params)
Edits existing dynagroup definition with given name using given parameters.
<static>  
dynaGroupDefinitions.find(params)
Finds dynagroup definitions according to given parameters.
<static>  
dynaGroupDefinitions.remove(dynagroupDefName)
Removes dynagroup definition with given name.
Namespace Detail
dynaGroupDefinitions
Method Detail
<static> {DynaGroupDefinition} dynaGroupDefinitions.create(params)
Creates a new dynagroup definition with given parameters.
dynaGroupDefinitions.create({name:"All agents",description:"All agents in inventory",expression:"resource.type.name=RHQ Agent"});
Parameters:
{Object} params
- see org.rhq.core.domain.resource.group.GroupDefinition.set[param] methods for available params.
Returns:
created dynagroup definition

<static> {DynaGroupDefinition} dynaGroupDefinitions.edit(dynagroupDefName, params)
Edits existing dynagroup definition with given name using given parameters.
dynaGroupDefinitions.edit("All agents",{name:"All agents - edited",recursive:true});
Parameters:
{String} dynagroupDefName
- name of dynagroup definition to be edited
{Object} params
- see org.rhq.core.domain.resource.group.GroupDefinition.set[param] methods for available params.
Returns:
updated dynagroup definition or null when dynagroup definition with given name was not found

<static> {DynaGroupDefinition[]} dynaGroupDefinitions.find(params)
Finds dynagroup definitions according to given parameters.
dynaGroupDefinitions.find({name:"All agents",description:"All agents in inventory"});
Parameters:
{Object} params
- see ResourceGroupDefinitionCriteria.addFilter[param] methods for available params.
Returns:
array of dynagroup definitions

<static> dynaGroupDefinitions.remove(dynagroupDefName)
Removes dynagroup definition with given name.
Parameters:
{String} dynagroupDefName
- name of dynagroup definition to be deleted

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jan 06 2014 16:48:32 GMT+0100 (CET)