Class: IBRuby::AddUser

Inherits:
Object
  • Object
show all
Defined in:
lib/src.rb

Overview

This class represents a service manager task to add a new user to a database instance. NOTE: This class does not currently work on the Mac OS X platform.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_name, password, firsts_name = nil, middle_name = nil, last_name = nil) ⇒ AddUser

This is a constructor for the AddUser class.

Parameters

user_name

A String containing the user name to be assigned to the new user.

password

A String containing the password to be assigned to the new user.

first_name

A String containing the first name to be associated with the new user. Defaults to nil.

middle_name

A String containing the middle name to be associated with the new user. Defaults to nil.

last_name

A String containing the last name to be associated with the new user. Defaults to nil.



1318
1319
1320
# File 'lib/src.rb', line 1318

def initialize(user_name, password, firsts_name=nil, middle_name=nil,
               last_name=nil)
end

Instance Attribute Details

#first_nameObject

Attribute accessor.



1298
1299
1300
# File 'lib/src.rb', line 1298

def first_name
  @first_name
end

#last_nameObject

Attribute accessor.



1298
1299
1300
# File 'lib/src.rb', line 1298

def last_name
  @last_name
end

#middle_nameObject

Attribute accessor.



1298
1299
1300
# File 'lib/src.rb', line 1298

def middle_name
  @middle_name
end

#passwordObject

Attribute accessor.



1298
1299
1300
# File 'lib/src.rb', line 1298

def password
  @password
end

#user_nameObject

Attribute accessor.



1298
1299
1300
# File 'lib/src.rb', line 1298

def user_name
  @user_name
end

Instance Method Details

#execute(manager) ⇒ Object

This method executes the add user task against a service manager.

Parameters

manager

A reference to the ServiceManager object to execute the task on.

Exceptions

IBRubyException

Generated whenever a disconnected service manager

is specified or an error occurs executing the
task.


1335
1336
# File 'lib/src.rb', line 1335

def execute(manager)
end