# $Id$

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

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

=head1 NAME

NACL::CS::SystemNodeHardwareUnifiedConnect

=head1 DESCRIPTION

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

=head1 ATTRIBUTES

The individual pieces of data that are part of the state of the SystemNodeHardwareUnifiedConnect
element are the attributes of the SystemNodeHardwareUnifiedConnect 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<< supported_modes >>

Supported Modes possible value(s) are, fc,cna
(Array)
Note that for array fields, the accessor method can be invoked in either
scalar or list context.

my $supported_modes = $obj->supported_modes();
 
# $supported_modes contains a reference to the array of values
 
my @supported_modes = $obj->supported_modes();
 
# @supported_modes 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 => { supported_modes = [ value1, value2...] }

Filled in for CMode CLI/ZAPI iter, non-iter.

Mapping for CMode ZAPI iter: <uc-adapter-info>
  <supported-mode ucm-mode="@values" />
</uc-adapter-info>

Mapping for CMode ZAPI non-iter: <supported-mode ucm-mode="@values" />


=item C<< adapter >>

Adapter
Filled in for CMode CLI/ZAPI iter, non-iter.

Mapping for CMode ZAPI iter: <uc-adapter-info adapter-name="$value" />

Mapping for CMode ZAPI non-iter: adapter-name


=item C<< current_mode >>

Current Mode possible value(s) are, fc,cna
Filled in for CMode CLI/ZAPI iter, non-iter.

Mapping for CMode ZAPI iter: <uc-adapter-info mode="$value" />

Mapping for CMode ZAPI non-iter: mode


=item C<< pending_mode >>

Pending Mode possible value(s) are, fc,cna
Filled in for CMode CLI/ZAPI iter, non-iter.

Mapping for CMode ZAPI iter: <uc-adapter-info pending-mode="$value" />


=item C<< pending_type >>

Pending Type possible value(s) are, initiator,target
Filled in for CMode CLI/ZAPI iter, non-iter.

Mapping for CMode ZAPI iter: <uc-adapter-info pending-fc4-type="$value" />

Mapping for CMode ZAPI non-iter: pending-fc4-type


=item C<< current_type >>

Current Type possible value(s) are, initiator,target
Filled in for CMode CLI/ZAPI iter, non-iter.

Mapping for CMode ZAPI iter: <uc-adapter-info fc4-type="$value" />

Mapping for CMode ZAPI non-iter: fc4-type


=item C<< status_admin >>

Administrative Status
Filled in for CMode CLI/ZAPI iter, non-iter.

Mapping for CMode ZAPI iter: <uc-adapter-info status-admin="$value" />


=item C<< supported_cna_types >>

Supported CNA Types possible value(s) are, initiator,target
(Array)
Note that for array fields, the accessor method can be invoked in either
scalar or list context.

my $supported_cna_types = $obj->supported_cna_types();
 
# $supported_cna_types contains a reference to the array of values
 
my @supported_cna_types = $obj->supported_cna_types();
 
# @supported_cna_types 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 => { supported_cna_types = [ value1, value2...] }

Filled in for CMode CLI/ZAPI iter, non-iter.

Mapping for CMode ZAPI iter: <uc-adapter-info>
  <supported-fc4-type-for-cna-mode ucm-type="@values" />
</uc-adapter-info>

Mapping for CMode ZAPI non-iter: <supported-fc4-type-for-cna-mode ucm-type="@values" />


=item C<< supported_fc_types >>

Supported FC Types possible value(s) are, initiator,target
(Array)
Note that for array fields, the accessor method can be invoked in either
scalar or list context.

my $supported_fc_types = $obj->supported_fc_types();
 
# $supported_fc_types contains a reference to the array of values
 
my @supported_fc_types = $obj->supported_fc_types();
 
# @supported_fc_types 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 => { supported_fc_types = [ value1, value2...] }

Filled in for CMode CLI/ZAPI iter, non-iter.

Mapping for CMode ZAPI iter: <uc-adapter-info>
  <supported-fc4-type-for-fc-mode ucm-type="@values" />
</uc-adapter-info>

Mapping for CMode ZAPI non-iter: <supported-fc4-type-for-fc-mode ucm-type="@values" />


=item C<< node >>

Node possible value(s) are, <nodename>,local
Filled in for CMode CLI/ZAPI iter, non-iter.

Mapping for CMode ZAPI iter: <uc-adapter-info node-name="$value" />

Mapping for CMode ZAPI non-iter: node-name

=back

=cut

package NACL::CS::SystemNodeHardwareUnifiedConnect;

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  => 'supported_modes',
    scalar => 'adapter',
    scalar => 'current_mode',
    scalar => 'pending_mode',
    scalar => 'pending_type',
    scalar => 'current_type',
    scalar => 'status_admin',
    array  => 'supported_cna_types',
    array  => 'supported_fc_types',
    scalar => 'node',
];
my $Log = log_global();
my $may_enter = $Log->may_enter();
my $may_exit  = $Log->may_exit();

sub _check_non_iter {
    $Log->enter() if $may_enter;
    my ($pkg, @opts) = @_;
    $pkg->_base_check_non_iter(
        @opts,
        _primary_keys => [qw(adapter node)],
        _vs_context   => 0
    );
    $Log->exit() if $may_exit;
}

=head1 METHODS

=head2 fetch

    my $SystemNodeHardwareUnifiedConnect_state  = NACL::CS::SystemNodeHardwareUnifiedConnect->fetch(command_interface => $ci, ...);
	my @SystemNodeHardwareUnifiedConnect_states = NACL::CS::SystemNodeHardwareUnifiedConnect->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 ucm-adapter-get-iter API for CMode ZAPI iter.

Invokes ucm-adapter-get API for CMode ZAPI non-iter.

            
=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,
        show_cmd => 'system node hardware unified-connect show',
        choices  => [
            {   method    => '_fetch_cmode_cli',
                interface => 'CLI',
                set       => 'CMode',
                zapi_type => 'none',
            },
            {   method    => '_fetch_cmode_zapi',
                interface => 'ZAPI',
                set       => 'CMode',
                zapi_type => 'iter'
            },
            {   method    => '_fetch_cmode_zapi_non_iter',
                interface => 'ZAPI',
                set       => 'CMode',
                zapi_type => 'non-iter',
                check     => '_check_non_iter'
            },
        ],
        exception_text =>
            'No matching system node hardware unified-connect(s) found',
        frontend => 'NACL::CS::SystemNodeHardwareUnifiedConnect::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 => 'system_node_hardware_unified_connect_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(pending-mode status-admin
                )
        ],
        map => {
            'supported-modes' => [
                make_zapi_array('supported-mode'),
                make_zapi_skip('ucm-mode'),
            ],
            'pending-type'        => 'pending-fc4-type',
            'current-mode'        => 'mode',
            'adapter'             => 'adapter-name',
            'current-type'        => 'fc4-type',
            'supported-cna-types' => [
                make_zapi_array('supported-fc4-type-for-cna-mode'),
                make_zapi_skip('ucm-type'),
            ],
            'supported-fc-types' => [
                make_zapi_array('supported-fc4-type-for-fc-mode'),
                make_zapi_skip('ucm-type'),
            ],
            'node' => 'node-name',
        },
        api => "ucm-adapter-get-iter",
    );
    $Log->exit() if $may_exit;
    return @state_objs;
}

sub _fetch_cmode_zapi_non_iter {
    $Log->enter() if $may_enter;
    my ($pkg, @args) = @_;
    my @state_objs = $pkg->SUPER::_fetch_cmode_zapi_non_iter(
        @args,
        copy => [
            qw(pending-mode status-admin
                )
        ],
        map => {
            'supported-modes' => [
                make_zapi_array('supported-mode'),
                make_zapi_skip('ucm-mode'),
            ],
            'pending-type'        => 'pending-fc4-type',
            'current-mode'        => 'mode',
            'adapter'             => 'adapter-name',
            'current-type'        => 'fc4-type',
            'supported-cna-types' => [
                make_zapi_array('supported-fc4-type-for-cna-mode'),
                make_zapi_skip('ucm-type'),
            ],
            'supported-fc-types' => [
                make_zapi_array('supported-fc4-type-for-fc-mode'),
                make_zapi_skip('ucm-type'),
            ],
            'node' => 'node-name',
        },
        api          => "ucm-adapter-get",
        primary_keys => [qw( adapter node )],
    );
    $Log->exit() if $may_exit;
    return @state_objs;
}
1;