| 1 | #/usr/bin/env perl | ||
| 2 | ############################################################################### | ||
| 3 | # | ||
| 4 | # @file Status.pm | ||
| 5 | # | ||
| 6 | # @brief API::Eulerian::EDW Status used to return function error to the callers | ||
| 7 | # | ||
| 8 | # @author Thorillon Xavier:x.thorillon@eulerian.com | ||
| 9 | # | ||
| 10 | # @date 25/11/2021 | ||
| 11 | # | ||
| 12 | # @version 1.0 | ||
| 13 | # | ||
| 14 | ############################################################################### | ||
| 15 | # | ||
| 16 | # Setup perl package name | ||
| 17 | # | ||
| 18 | package API::Eulerian::EDW::Status; | ||
| 19 | # | ||
| 20 | # Enforce compilor rules | ||
| 21 | # | ||
| 22 | use strict; use warnings; | ||
| 23 | # | ||
| 24 | # @brief Allocate and initialize a new API::Eulerian::EDW::Status instance. | ||
| 25 | # | ||
| 26 | # @param $class - API::Eulerian::EDW::Status class. | ||
| 27 | # | ||
| 28 | # @return API::Eulerian::EDW::Status instance. | ||
| 29 | # | ||
| 30 | sub new | ||
| 31 | { | ||
| 32 | my ( $class ) = @_; | ||
| 33 | return bless( { | ||
| 34 | _ERROR => 0, | ||
| 35 | _MSG => '', | ||
| 36 | _CODE => 0, | ||
| 37 | _URL => '', | ||
| 38 | }, $class | ||
| 39 | ); | ||
| 40 | } | ||
| 41 | # | ||
| 42 | # @brief Get/Set error message. | ||
| 43 | # | ||
| 44 | # @param $self - API::Eulerian::EDW::Status instance. | ||
| 45 | # @param $msg - Error message. | ||
| 46 | # | ||
| 47 | # @return Error message. | ||
| 48 | # | ||
| 49 | sub msg | ||
| 50 | { | ||
| 51 | my ( $self, $msg ) = @_; | ||
| 52 | $self->{ _MSG } = $msg if defined( $msg ); | ||
| 53 | return $self->{ _MSG }; | ||
| 54 | } | ||
| 55 | # | ||
| 56 | # @brief Get/Set error code. | ||
| 57 | # | ||
| 58 | # @param $self - API::Eulerian::EDW::Status instance. | ||
| 59 | # @param $code - Error code. | ||
| 60 | # | ||
| 61 | # @return Error code. | ||
| 62 | # | ||
| 63 | sub code | ||
| 64 | { | ||
| 65 | my ( $self, $code ) = @_; | ||
| 66 | $self->{ _CODE } = $code if defined( $code ); | ||
| 67 | return $self->{ _CODE }; | ||
| 68 | } | ||
| 69 | # | ||
| 70 | # @brief Get/Set error. | ||
| 71 | # | ||
| 72 | # @param $self - API::Eulerian::EDW::Status instance. | ||
| 73 | # @param $error - Error. | ||
| 74 | # | ||
| 75 | # @return Error flag. | ||
| 76 | # | ||
| 77 | sub error | ||
| 78 | { | ||
| 79 | my ( $self, $error ) = @_; | ||
| 80 | $self->{ _ERROR } = $error if defined( $error ); | ||
| 81 | return $self->{ _ERROR }; | ||
| 82 | } | ||
| 83 | # | ||
| 84 | # @brief Get/Set URL. | ||
| 85 | # | ||
| 86 | # @param $self - API::Eulerian::EDW::Status instance. | ||
| 87 | # @param $url - Url. | ||
| 88 | # | ||
| 89 | # @return Url. | ||
| 90 | # | ||
| 91 | sub url | ||
| 92 | { | ||
| 93 | my ( $self, $url ) = @_; | ||
| 94 | $self->{ _URL } = $url if defined( $url ); | ||
| 95 | return $self->{ _URL }; | ||
| 96 | } | ||
| 97 | sub path | ||
| 98 | { | ||
| 99 | my $self = shift; | ||
| 100 | return $self->{ path }; | ||
| 101 | } | ||
| 102 | # | ||
| 103 | # @brief Dump status. | ||
| 104 | # | ||
| 105 | # @param $self - API::Eulerian::EDW::Status. | ||
| 106 | # | ||
| 107 | sub dump | ||
| 108 | { | ||
| 109 | my ( $self ) = @_; | ||
| 110 | my $error = $self->error() ? 'Yes' : 'No'; | ||
| 111 | my $code = $self->code(); | ||
| 112 | my $msg = $self->msg(); | ||
| 113 | my $url = $self->url(); | ||
| 114 | my $string = <<string_end; | ||
| 115 | Error : $error | ||
| 116 | Code : $code | ||
| 117 | Message : $msg | ||
| 118 | Url : $url | ||
| 119 | string_end | ||
| 120 | print( $string ); | ||
| 121 | } | ||
| 122 | # | ||
| 123 | # End up perl module properly | ||
| 124 | # | ||
| 125 | 1; | ||
| 126 | |||
| 127 | __END__ |