Class: OpenNebula::DocumentPool

Inherits:
Pool show all
Defined in:
lib/opennebula/document_pool.rb

Overview

All subclasses must define the DOCUMENT_TYPE constant and the factory method.

Examples:

require 'opennebula/document_pool'

module OpenNebula
    class CustomObjectPool < DocumentPool

        DOCUMENT_TYPE = 400

        def factory(element_xml)
            OpenNebula::CustomObject.new(element_xml, @client)
        end
    end
end

Direct Known Subclasses

DocumentPoolJSON

Constant Summary collapse

DOCUMENT_POOL_METHODS =

Constants and Class attribute accessors

{
    :info => 'documentpool.info'
}

Constants inherited from Pool

Pool::INFO_ALL, Pool::INFO_GROUP, Pool::INFO_MINE, Pool::INFO_PRIMARY_GROUP, Pool::PAGINATED_POOLS

Instance Attribute Summary

Attributes inherited from Pool

#element_name, #pool_name

Instance Method Summary collapse

Methods inherited from Pool

#each, #each_page, #each_page_delete, #each_with_xpath, #get_hash, #get_page, #info_paginated, #is_paginated?, #loop_page, #to_str

Methods inherited from XMLPool

#each_element

Methods inherited from XMLElement

#[], #add_element, #attr, build_xml, #delete_element, #each, #each_xpath, #element_xml, #has_elements?, #initialize_xml, #name, #retrieve_elements, #retrieve_xmlelements, #set_content, #template_like_str, #template_str, #template_xml, #text, #to_hash, #to_xml, #xml_nil?

Constructor Details

#initialize(client, user_id = -1)) ⇒ DocumentPool

Class constructor

Parameters:



58
59
60
61
62
 
# File 'lib/opennebula/document_pool.rb', line 58

def initialize(client, user_id = -1)
    super('DOCUMENT_POOL', 'DOCUMENT', client)

    @user_id = user_id
end

Instance Method Details

#document_type ⇒ Object 



98
99
100
 
# File 'lib/opennebula/document_pool.rb', line 98

def document_type
    self.class::DOCUMENT_TYPE
end

#info(*args) ⇒ nil, OpenNebula::Error Also known as: info!

Retrieves all or part of the Documents in the pool.

Returns:



72
73
74
75
76
77
78
79
 
# File 'lib/opennebula/document_pool.rb', line 72

def info(*args)
    case args.size
        when 0
            info_filter(DOCUMENT_POOL_METHODS[:info],@user_id,-1,-1, document_type)
        when 3
            info_filter(DOCUMENT_POOL_METHODS[:info],args[0],args[1],args[2], document_type)
    end
end

#info_all ⇒ Object Also known as: info_all! 



81
82
83
 
# File 'lib/opennebula/document_pool.rb', line 81

def info_all()
    return super(DOCUMENT_POOL_METHODS[:info], document_type)
end

#info_group ⇒ Object Also known as: info_group! 



89
90
91
 
# File 'lib/opennebula/document_pool.rb', line 89

def info_group()
    return super(DOCUMENT_POOL_METHODS[:info], document_type)
end

#info_mine ⇒ Object Also known as: info_mine! 



85
86
87
 
# File 'lib/opennebula/document_pool.rb', line 85

def info_mine()
    return super(DOCUMENT_POOL_METHODS[:info], document_type)
end