#
# Copyright (c) 2001-2013 NetApp, Inc., All Rights Reserved
#   Any use, modification, or distribution is prohibited
#   without prior written consent from NetApp, Inc.
#

## @summary VserverServicesNameServiceDns ComponentState Module (auto-generated by CGT)
## @author dl-nacl-dev@netapp.com
## @status shared
## @pod here

=head1 NAME

NACL::CS::VserverServicesNameServiceDns

=head1 DESCRIPTION

C<NACL::CS::VserverServicesNameServiceDns> is a derived class of
L<NACL::CS::ComponentState::ONTAP|lib-NACL-CS-ComponentState-ONTAP-pm>. It represents the
state of an ONTAP VserverServicesNameServiceDns.  A related class is
L<NACL::C::VserverServicesNameServiceDns|lib-NACL-C-VserverServicesNameServiceDns-pm>, which represents access
to an ONTAP VserverServicesNameServiceDns.

=head1 ATTRIBUTES

The individual pieces of data that are part of the state of the VserverServicesNameServiceDns
element are the attributes of the VserverServicesNameServiceDns ComponentState.

Additionally, the command_interface used to obtain the ComponentState object is
also an attribute of the object. This makes it easier to obtain the component
object corresponding to the CS object, using
L<get_component_instance|lib-NACL-CS-ComponentState-pm/get_component_instance>.

=over

=item command_interface

The command_interface with which the CS object was obtained. (Available in
all CS objects regardless of requested_fields and the mode/interface)

=item C<< domains >>

Domains
(Array)
Note that for array fields, the accessor method can be invoked in either
scalar or list context.

my $domains = $obj->domains();

# $domains contains a reference to the array of values

my @domains = $obj->domains();

# @domains contains the array of values

If this field needs to be passed to the filter hash,
the value for this field should be passed in as an arrayref

# filter => { domains = [ value1, value2...] }


Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-dns-info></net-dns-info>



=item C<< timeout >>

Timeout (secs) ranges from 1 to 5

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-dns-info timeout="$value" />



=item C<< vserver >>

Vserver

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-dns-info vserver-name="$value" />



=item C<< name_servers >>

Name Servers
(Array)
Note that for array fields, the accessor method can be invoked in either
scalar or list context.

my $name_servers = $obj->name_servers();

# $name_servers contains a reference to the array of values

my @name_servers = $obj->name_servers();

# @name_servers contains the array of values

If this field needs to be passed to the filter hash,
the value for this field should be passed in as an arrayref

# filter => { name_servers = [ value1, value2...] }


Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-dns-info></net-dns-info>



=item C<< user_modified >>

User Modified This Row possible value(s) are, true,false

Filled in for CMode CLI.

=item C<< attempts >>

Maximum Attempts ranges from 1 to 4

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-dns-info attempts="$value" />



=item C<< state >>

Enable/Disable DNS possible value(s) are, enabled,disabled

Filled in for CMode CLI/ZAPI.
Maps to:

CMode ZAPI:

For "requested_fields", "filter" and Output mapping:

<net-dns-info dns-state="$value" />



=back

=cut

package NACL::CS::VserverServicesNameServiceDns;

use strict;
use warnings;
use Params::Validate qw(validate);
use NATE::Log qw(log_global);

use NACL::Exceptions::NoElementsFound qw(:try);

use NACL::CS::ComponentState::ZapiSkip qw(make_zapi_skip);
use NACL::CS::ComponentState::ZapiArray qw(make_zapi_array);
use base 'NACL::CS::ComponentState::ONTAP';

use Class::MethodMaker [
    array  => 'domains',
    scalar => 'timeout',
    scalar => 'vserver',
    array  => 'name_servers',
    scalar => 'user_modified',
    scalar => 'attempts',
    scalar => 'state',
];

my $Log = log_global();
my $may_enter = $Log->may_enter();
my $may_exit  = $Log->may_exit();

=head1 METHODS

=head2 fetch

    my $VserverServicesNameServiceDns_state  = NACL::CS::VserverServicesNameServiceDns->fetch(command_interface => $ci, ...);
	my @VserverServicesNameServiceDns_states = NACL::CS::VserverServicesNameServiceDns->fetch(command_interface => $ci, ...);

(Class method)
Discovers which elements are present and returns their state in ComponentState
objects. Called in scalar context it returns only one state object, in list
context it returns all state objects.
See L<NACL::CS::ComponentState|lib-NACL-CS-ComponentState-pm/fetch> for a
more detailed description along with a complete explanation of the options
it accepts.

Uses CMode CLI/ZAPI.

Invokes net-dns-get-iter API for CMode ZAPI.


=over

=item Exceptions

=over

=item C<NACL::Exceptions::NoElementsFound>

When there are no elements matching the query specified or elements of that type
doesn't exist, then this exception will be thrown.

=back

=back

=cut

sub fetch {
    $Log->enter() if $may_enter;
    my ($pkg, @args) = @_;
    my @state_objs = $pkg->SUPER::fetch(
        @args,
        choices => [
            {   method    => '_fetch_cmode_cli',
                interface => 'CLI',
                set       => 'CMode'
            },
            {   method    => '_fetch_cmode_zapi',
                interface => 'ZAPI',
                set       => 'CMode'
            },
        ],
        show_cmd => 'vserver services name-service dns show',
	exception_text =>
            'No matching vserver services name-service dns(s) found',
        frontend => 'NACL::CS::VserverServicesNameServiceDns::fetch',
    );
    $Log->exit() if $may_exit;
    return wantarray ? @state_objs : $state_objs[0];
}

sub _fetch_cmode_cli {
    $Log->enter() if $may_enter;
    my ($pkg, @args) = @_;
    my @state_objs = $pkg->SUPER::_fetch_cmode_cli(@args,
        api => 'vserver_services_name_service_dns_show',);
    $Log->exit() if $may_exit;
    return @state_objs;
}

sub _fetch_cmode_zapi {
    $Log->enter() if $may_enter;
    my ($pkg, @args) = @_;
    my @state_objs = $pkg->SUPER::_fetch_cmode_zapi(
        @args,
        copy => [
            qw(timeout attempts
                )
        ],
        map => {
            'state'        => 'dns-state',
            'vserver'      => 'vserver-name',
            'name-servers' => [
                make_zapi_array('name-servers'),
                make_zapi_skip('ip-address')
            ],
            'domains' =>
                [make_zapi_array('domains'), make_zapi_skip('string')],
        },
        api => "net-dns-get-iter",
    );
    $Log->exit() if $may_exit;
    return @state_objs;
}
1;