Class: JobGroup

Inherits:
BsaSoapBase show all
Defined in:
lib/bl_soap/job_group.rb

Overview

does not support add/remove permissions or ACL, makes no sense in BRPM does not support creating job groups does not support setting descriptions

Constant Summary

Constants inherited from BsaSoapBase

BsaSoapBase::CLI_SERVICE, BsaSoapBase::CLI_WSDL, BsaSoapBase::DEFAULT_AUTH_TYPE, BsaSoapBase::HTTP_READ_TIMEOUT, BsaSoapBase::LOGIN_SERVICE, BsaSoapBase::LOGIN_WSDL, BsaSoapBase::ROLE_SERVICE, BsaSoapBase::ROLE_WSDL

Instance Method Summary collapse

Methods inherited from BsaSoapBase

#execute_cli_with_attachments, #execute_cli_with_param_list, #get_all_servers, #get_cli_return_value, #initialize, #validate_cli_option_hash_string_values, #validate_cli_options_hash, #validate_cli_result, #validate_servers

Constructor Details

This class inherits a constructor from BsaSoapBase

Instance Method Details

#create_group_with_parent_name(options = {}) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
 
# File 'lib/bl_soap/job_group.rb', line 5

def create_group_with_parent_name(options = {})
  validate_cli_options_hash([:group_name, :parent_group_name], options)
  integer_result = execute_cli_with_param_list(self.class, "createGroupWithParentName",
                                               [
                                                   options[:group_name],			# group name to be created
                                                   options[:parent_group_name]		# parent group name
                                               ])
  integer_value = get_cli_return_value(integer_result)
rescue => exception
  raise "Exception executing #{self.class} function: #{exception.to_s}"
end

#create_job_group(options = {}) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/bl_soap/job_group.rb', line 17

def create_job_group(options = {})
  validate_cli_options_hash([:group_name, :parent_id], options)
  integer_result = execute_cli_with_param_list(self.class, "createJobGroup",
                                               [
                                                   options[:group_name],	# group name to be created
                                                   options[:parent_id]		# parent group id
                                               ])
  integer_value = get_cli_return_value(integer_result)
rescue => exception
  raise "Exception executing #{self.class} function: #{exception.to_s}"
end

#find_all_groups_by_parent_group_name(options = {}) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/bl_soap/job_group.rb', line 29

def find_all_groups_by_parent_group_name(options = {})
  validate_cli_options_hash([:job_group], options)
  string_result = execute_cli_with_param_list(self.class, "findAllGroupsByParentGroupName",
                                              [
                                                  options[:job_group]	# Fully qualified parent job group name (/ for root group)
                                              ])
  string_value = get_cli_return_value(string_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#group_exists(options = {}) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/bl_soap/job_group.rb', line 40

def group_exists(options = {})
  validate_cli_options_hash([:group_name], options)
  boolean_result = execute_cli_with_param_list(self.class, "groupExists",
                                               [
                                                   options[:group_name]	# Fully qualified job group name (/ for root group)
                                               ])
  boolean_value = get_cli_return_value(boolean_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#group_name_to_db_key(options = {}) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/bl_soap/job_group.rb', line 51

def group_name_to_db_key(options = {})
  validate_cli_options_hash([:group_name], options)
  db_key_result = execute_cli_with_param_list(self.class, "groupNameToDBKey",
                                              [
                                                  options[:group_name]	# Fully qualified job group name (/ for root group)
                                              ])
  db_key = get_cli_return_value(db_key_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#group_name_to_id(options = {}) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/bl_soap/job_group.rb', line 62

def group_name_to_id(options = {})
  validate_cli_options_hash([:group_name], options)
  integer_result = execute_cli_with_param_list(self.class, "groupNameToId",
                                               [
                                                   options[:group_name]	# Fully qualified job group name (/ for root group)
                                               ])
  integer_value = get_cli_return_value(integer_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end