File Coverage

blib/lib/Business/EDI/CodeList.pm

Criterion	Covered	Total	%
statement	65	76	85.5
branch	24	42	57.1
condition	3	3	100.0
subroutine	14	15	93.3
pod	4	10	40.0
total	110	146	75.3

package Business::EDI::CodeList;

use base qw/Business::EDI/;

use strict;
use warnings;
use Carp;
use UNIVERSAL::require;

=head1 Business::EDI::CodeList

Abstract object class for UN/EDIFACT objects that do not have further descendant objects and
do have a defined list of legal values.

=cut

our $VERSION = 0.01;
our $verbose = 0;
our %codemap;
my @fields = qw/ code value label desc /;

sub new_codelist {      # constructor: NOT to be overridden, first argument is string name like 'ResponseTypeCode'
    my $class = shift;  # note: we don't return objects of this class, we return an object from the subclasses
    my $type  = shift or carp "No CodeList object type specified";
    $type or return;
    if ($type =~ /^\d{4}$/) {
        my $map = $class->codemap();
        if (exists $map->{$type}) {
            $verbose and warn "Numerical CodeList $type => " . $map->{$type};
            $type = $map->{$type}; # replace 4-digit code w/ name, e.g. 1049 => 'MessageSectionCode'
        } else {
            carp "Numerical CodeList '$type' is not recognized.  Maybe you wanted a DataElement?  Constructor failure likely.";
        }
    }
    my $realtype = ($type =~ /^Business::EDI::CodeList::./) ? $type : "Business::EDI::CodeList::$type";
    unless ($realtype->require()) {
        carp "require failed! Unrecognized class $realtype: $@";
        return;
    }
    return $realtype->new(@_);
}

# this is the default constructor for subclasses, e.g. Business::EDI::CodeList::InventoryTypeCode->new()
sub new {       # override me if you want,
    my $class = shift;
    my $code  = shift; # or carp "No code argument for CodeList type '$class' specified";
    # $code or return;
    my $self = bless({}, $class);
    unless ($self->init($code, @_)) {
        carp $class . "->init('" . (defined($code) ? $code : '') . "', " . join(", ",@_), ") FAILED\n";
        return;
    }
    return $self;
}

sub init {
    my $self  = shift;
    my $value = shift;  # or return;
    defined($value) or $value = '';
    my $codes = $self->get_codes();    # from subobject
    $verbose and warn ref($self) . "->get_codes got " . scalar(keys %$codes) . ", setting value '$value'";
    $self->{value} = $value;
    $self->{code } = @_ ? shift : $self->list_number;
    $self->{_permitted} = {(map {$_ => 1} @fields)};
    unless (length($value) and $codes->{$value}) {
        $verbose and carp "Value '$value' is not an authorized value";
        $self->{label} = '';
        $self->{desc}  = '';
        return $self;
    }
    $self->{label} = $codes->{$value}->[0];
    $self->{desc}  = $codes->{$value}->[1];
    return $self;
}

# sub get_codes {
#     my $self  = shift;
#     my $class = ref($self) || $self;
#     warn "trying to get_codes for class $class";
#     no strict 'refs';
#     return \%{$class . "::code_hash"};
# }

sub code       { my $self = shift; return $self->listnumber(@_); }
sub listnumber { my $self = shift; @_ and $self->{code } = shift; return $self->{code }; }
sub label      { my $self = shift; @_ and $self->{label} = shift; return $self->{label}; }
sub desc       { my $self = shift; @_ and $self->{desc } = shift; return $self->{desc }; }
sub value      { my $self = shift; @_ and $self->{value} = shift; return $self->{value}; }

sub name2number {
    my $self = shift;
    my $name = shift or return;
    my $map  = $self->codemap;
    foreach (keys %$map) {
        $map->{$_} eq $name and return $_;
    }
    return; # undef, no match
}

sub codemap {
    my $self = shift;
    %codemap or %codemap = (
# These (0xxx) are from SYNTAX spec
        '0001' => q(SyntaxIdentifier),
        '0002' => q(SyntaxVersionNumber),
        '0004' => q(InterchangeSenderIdentification),
        '0007' => q(IdentificationCodeQualifier),
        '0008' => q(InterchangeSenderInternalIdentification),
        '0010' => q(InterchangeRecipientIdentification),
        '0014' => q(InterchangeRecipientInternalIdentification),
        '0017' => q(Date),
        '0019' => q(Time),
        '0020' => q(InterchangeControlReference),
        '0022' => q(RecipientReferencePassword),
        '0025' => q(RecipientReferencePasswordQualifier),
        '0026' => q(ApplicationReference),
        '0029' => q(ProcessingPriorityCode),
        '0031' => q(AcknowledgementRequest),
        '0032' => q(InterchangeAgreementIdentifier),
        '0035' => q(TestIndicator),
        '0036' => q(InterchangeControlCount),
        '0038' => q(MessageGroupIdentification),
        '0040' => q(ApplicationSenderIdentification),
        '0042' => q(InterchangeSenderInternalSubidentification),
        '0044' => q(ApplicationRecipientIdentification),
        '0046' => q(InterchangeRecipientInternalSubidentification),
        '0048' => q(GroupReferenceNumber),
        '0051' => q(ControllingAgencyCoded),
        '0052' => q(MessageVersionNumber),
        '0054' => q(MessageReleaseNumber),
        '0057' => q(AssociationAssignedCode),
        '0058' => q(ApplicationPassword),
        '0060' => q(GroupControlCount),
        '0062' => q(MessageReferenceNumber),
        '0065' => q(MessageType),
        '0068' => q(CommonAccessReference),
        '0070' => q(SequenceOfTransfers),
        '0073' => q(FirstAndLastTransfer),
        '0074' => q(NumberOfSegmentsInAMessage),
        '0076' => q(SyntaxReleaseNumber),
        '0080' => q(ServiceCodeListDirectoryVersionNumber),
        '0081' => q(SectionIdentification),
        '0083' => q(ActionCoded),
        '0085' => q(SyntaxErrorCoded),
        '0087' => q(AnticollisionSegmentGroupIdentification),
        '0096' => q(SegmentPositionInMessageBody),
        '0098' => q(ErroneousDataElementPositionInSegment),
        '0104' => q(ErroneousComponentDataElementPosition),
        '0110' => q(CodeListDirectoryVersionNumber),
        '0113' => q(MessageTypeSubfunctionIdentification),
        '0115' => q(MessageSubsetIdentification),
        '0116' => q(MessageSubsetVersionNumber),
        '0118' => q(MessageSubsetReleaseNumber),
        '0121' => q(MessageImplementationGuidelineIdentification),
        '0122' => q(MessageImplementationGuidelineVersionNumber),
        '0124' => q(MessageImplementationGuidelineReleaseNumber),
        '0127' => q(ScenarioIdentification),
        '0128' => q(ScenarioVersionNumber),
        '0130' => q(ScenarioReleaseNumber),
        '0133' => q(CharacterEncodingCoded),
        '0135' => q(ServiceSegmentTagCoded),
        '0136' => q(ErroneousDataElementOccurrence),
        '0138' => q(SecuritySegmentPosition),
        '0300' => q(InitiatorControlReference),
        '0303' => q(InitiatorReferenceIdentification),
        '0304' => q(ResponderControlReference),
        '0306' => q(TransactionControlReference),
        '0311' => q(DialogueIdentification),
        '0314' => q(EventTime),
        '0320' => q(SenderSequenceNumber),
        '0323' => q(TransferPositionCoded),
        '0325' => q(DuplicateIndicator),
        '0331' => q(ReportFunctionCoded),
        '0332' => q(Status),
        '0333' => q(StatusCoded),
        '0335' => q(LanguageCoded),
        '0336' => q(TimeOffset),
        '0338' => q(EventDate),
        '0340' => q(InteractiveMessageReferenceNumber),
        '0342' => q(DialogueVersionNumber),
        '0344' => q(DialogueReleaseNumber),
        '0501' => q(SecurityServiceCoded),
        '0503' => q(ResponseTypeCoded),
        '0505' => q(FilterFunctionCoded),
        '0507' => q(OriginalCharacterSetEncodingCoded),
        '0509' => q(RoleOfSecurityProviderCoded),
        '0511' => q(SecurityPartyIdentification),
        '0513' => q(SecurityPartyCodeListQualifier),
        '0515' => q(SecurityPartyCodeListResponsibleAgencyCoded),
        '0517' => q(DateAndTimeQualifier),
        '0518' => q(EncryptionReferenceNumber),
        '0520' => q(SecuritySequenceNumber),
        '0523' => q(UseOfAlgorithmCoded),
        '0525' => q(CryptographicModeOfOperationCoded),
        '0527' => q(AlgorithmCoded),
        '0529' => q(AlgorithmCodeListIdentifier),
        '0531' => q(AlgorithmParameterQualifier),
        '0533' => q(ModeOfOperationCodeListIdentifier),
        '0534' => q(SecurityReferenceNumber),
        '0536' => q(CertificateReference),
        '0538' => q(KeyName),
        '0541' => q(ScopeOfSecurityApplicationCoded),
        '0543' => q(CertificateOriginalCharacterSetRepertoireCoded),
        '0545' => q(CertificateSyntaxAndVersionCoded),
        '0546' => q(UserAuthorisationLevel),
        '0548' => q(ServiceCharacterForSignature),
        '0551' => q(ServiceCharacterForSignatureQualifier),
        '0554' => q(AlgorithmParameterValue),
        '0556' => q(LengthOfDataInOctetsOfBits),
        '0558' => q(ListParameter),
        '0560' => q(ValidationValue),
        '0563' => q(ValidationValueQualifier),
        '0565' => q(MessageRelationCoded),
        '0567' => q(SecurityStatusCoded),
        '0569' => q(RevocationReasonCoded),
        '0571' => q(SecurityErrorCoded),
        '0572' => q(CertificateSequenceNumber),
        '0575' => q(ListParameterQualifier),
        '0577' => q(SecurityPartyQualifier),
        '0579' => q(KeyManagementFunctionQualifier),
        '0582' => q(NumberOfPaddingBytes),
        '0586' => q(SecurityPartyName),
        '0588' => q(NumberOfSecuritySegments),
        '0591' => q(PaddingMechanismCoded),
        '0601' => q(PaddingMechanismCodeListIdentifier),
        '0800' => q(PackageReferenceNumber),
        '0802' => q(ReferenceIdentificationNumber),
        '0805' => q(ObjectTypeQualifier),
        '0808' => q(ObjectTypeAttribute),
        '0809' => q(ObjectTypeAttributeIdentification),
        '0810' => q(LengthOfObjectInOctetsOfBits),
        '0813' => q(ReferenceQualifier),
        '0814' => q(NumberOfSegmentsBeforeObject),

# The rest are from regular EDI spec
        1001 => "DocumentNameCode",
        1049 => "MessageSectionCode",
        1073 => "DocumentLineActionCode",
        1153 => "ReferenceCodeQualifier",
        1159 => "SequenceIdentifierSourceCode",
        1225 => "MessageFunctionCode",
        1227 => "CalculationSequenceCode",
        1229 => "ActionCode",
        1373 => "DocumentStatusCode",
        1501 => "ComputerEnvironmentDetailsCodeQualifier",
        1503 => "DataFormatDescriptionCode",
        1505 => "ValueListTypeCode",
        1507 => "DesignatedClassCode",
        2005 => "DateOrTimeOrPeriodFunctionCodeQualifier",
        2009 => "TermsTimeRelationCode",
        2013 => "FrequencyCode",
        2015 => "DespatchPatternCode",
        2017 => "DespatchPatternTimingCode",
        2023 => "PeriodTypeCodeQualifier",
        2151 => "PeriodTypeCode",
        2155 => "ChargePeriodTypeCode",
        2379 => "DateOrTimeOrPeriodFormatCode",
        2475 => "TimeReferenceCode",
        3035 => "PartyFunctionCodeQualifier",
        3045 => "PartyNameFormatCode",
        3055 => "CodeListResponsibleAgencyCode",
        3077 => "TestMediumCode",
        3079 => "OrganisationClassificationCode",
        3083 => "OrganisationalClassNameCode",
        3131 => "AddressTypeCode",
        3139 => "ContactFunctionCode",
        3153 => "CommunicationMediumTypeCode",
        3155 => "CommunicationAddressCodeQualifier",
        3227 => "LocationFunctionCodeQualifier",
        3237 => "SampleLocationDescriptionCode",
        3279 => "GeographicAreaCode",
        3285 => "InstructionReceivingPartyIdentifier",
        3289 => "PersonCharacteristicCodeQualifier",
        3295 => "NameOriginalAlphabetCode",
        3299 => "AddressPurposeCode",
        3301 => "EnactingPartyIdentifier",
        3397 => "NameStatusCode",
        3401 => "NameComponentUsageCode",
        3403 => "NameTypeCode",
        3405 => "NameComponentTypeCodeQualifier",
        3455 => "LanguageCodeQualifier",
        3457 => "OriginatorTypeCode",
        3475 => "AddressStatusCode",
        3477 => "AddressFormatCode",
        3479 => "MaritalStatusDescriptionCode",
        3493 => "NationalityCodeQualifier",
        4017 => "DeliveryPlanCommitmentLevelCode",
        4025 => "BusinessFunctionCode",
        4027 => "BusinessFunctionTypeCodeQualifier",
        4035 => "PriorityTypeCodeQualifier",
        4037 => "PriorityDescriptionCode",
        4043 => "TradeClassCode",
        4049 => "CertaintyDescriptionCode",
        4051 => "CharacteristicRelevanceCode",
        4053 => "DeliveryOrTransportTermsDescriptionCode",
        4055 => "DeliveryOrTransportTermsFunctionCode",
        4059 => "ClauseCodeQualifier",
        4065 => "ContractAndCarriageConditionCode",
        4071 => "ProvisoCodeQualifier",
        4079 => "HandlingInstructionDescriptionCode",
        4183 => "SpecialConditionCode",
        4215 => "TransportChargesPaymentMethodCode",
        4219 => "TransportServicePriorityCode",
        4221 => "DiscrepancyNatureIdentificationCode",
        4233 => "MarkingInstructionsCode",
        4237 => "PaymentArrangementCode",
        4277 => "PaymentTermsDescriptionIdentifier",
        4279 => "PaymentTermsTypeCodeQualifier",
        4295 => "ChangeReasonDescriptionCode",
        4343 => "ResponseTypeCode",
        4347 => "ProductIdentifierCodeQualifier",
        4383 => "BankOperationCode",
        4401 => "InstructionDescriptionCode",
        4403 => "InstructionTypeCodeQualifier",
        4405 => "StatusDescriptionCode",
        4407 => "SampleProcessStepCode",
        4419 => "TestAdministrationMethodCode",
        4431 => "PaymentGuaranteeMeansCode",
        4435 => "PaymentChannelCode",
        4437 => "AccountTypeCodeQualifier",
        4439 => "PaymentConditionsCode",
        4447 => "FreeTextFormatCode",
        4451 => "TextSubjectCodeQualifier",
        4453 => "FreeTextFunctionCode",
        4455 => "BackOrderArrangementTypeCode",
        4457 => "SubstitutionConditionCode",
        4461 => "PaymentMeansCode",
        4463 => "IntracompanyPaymentIndicatorCode",
        4465 => "AdjustmentReasonDescriptionCode",
        4471 => "SettlementMeansCode",
        4475 => "AccountingEntryTypeNameCode",
        4487 => "FinancialTransactionTypeCode",
        4493 => "DeliveryInstructionCode",
        4499 => "InventoryMovementReasonCode",
        4501 => "InventoryMovementDirectionCode",
        4503 => "InventoryBalanceMethodCode",
        4505 => "CreditCoverRequestTypeCode",
        4507 => "CreditCoverResponseTypeCode",
        4509 => "CreditCoverResponseReasonCode",
        4511 => "RequestedInformationDescriptionCode",
        4513 => "MaintenanceOperationCode",
        4517 => "SealConditionCode",
        5007 => "MonetaryAmountFunctionDescriptionCode",
        5013 => "IndexCodeQualifier",
        5025 => "MonetaryAmountTypeCodeQualifier",
        5027 => "IndexTypeIdentifier",
        5039 => "IndexRepresentationCode",
        5047 => "ContributionCodeQualifier",
        5049 => "ContributionTypeDescriptionCode",
        5125 => "PriceCodeQualifier",
        5153 => "DutyOrTaxOrFeeTypeNameCode",
        5189 => "AllowanceOrChargeIdentificationCode",
        5213 => "SublineItemPriceChangeOperationCode",
        5237 => "ChargeCategoryCode",
        5243 => "RateOrTariffClassDescriptionCode",
        5245 => "PercentageTypeCodeQualifier",
        5249 => "PercentageBasisIdentificationCode",
        5261 => "ChargeUnitCode",
        5267 => "ServiceTypeCode",
        5273 => "DutyOrTaxOrFeeRateBasisCode",
        5283 => "DutyOrTaxOrFeeFunctionCodeQualifier",
        5305 => "DutyOrTaxOrFeeCategoryCode",
        5315 => "RemunerationTypeNameCode",
        5375 => "PriceTypeCode",
        5379 => "ProductGroupTypeCode",
        5387 => "PriceSpecificationCode",
        5393 => "PriceMultiplierTypeCodeQualifier",
        5419 => "RateTypeCodeQualifier",
        5463 => "AllowanceOrChargeCodeQualifier",
        5495 => "SublineIndicatorCode",
        5501 => "RatePlanCode",
        6029 => "GeographicalPositionCodeQualifier",
        6063 => "QuantityTypeCodeQualifier",
        6069 => "ControlTotalTypeCodeQualifier",
        6071 => "FrequencyCodeQualifier",
        6077 => "ResultRepresentationCode",
        6079 => "ResultNormalcyCode",
        6085 => "DosageAdministrationCodeQualifier",
        6087 => "ResultValueTypeCodeQualifier",
        6145 => "DimensionTypeCodeQualifier",
        6155 => "NondiscreteMeasurementNameCode",
        6167 => "RangeTypeCodeQualifier",
        6173 => "SizeTypeCodeQualifier",
        6245 => "TemperatureTypeCodeQualifier",
        6311 => "MeasurementPurposeCodeQualifier",
        6313 => "MeasuredAttributeCode",
        6321 => "MeasurementSignificanceCode",
        6331 => "StatisticTypeCodeQualifier",
        6341 => "ExchangeRateCurrencyMarketIdentifier",
        6343 => "CurrencyTypeCodeQualifier",
        6347 => "CurrencyUsageCodeQualifier",
        6353 => "UnitTypeCodeQualifier",
        6415 => "ClinicalInformationTypeCodeQualifier",
        7001 => "PhysicalOrLogicalStateTypeCodeQualifier",
        7007 => "PhysicalOrLogicalStateDescriptionCode",
        7009 => "ItemDescriptionCode",
        7011 => "ItemAvailabilityCode",
        7039 => "SampleSelectionMethodCode",
        7045 => "SampleStateCode",
        7047 => "SampleDirectionCode",
        7059 => "ClassTypeCode",
        7073 => "PackagingTermsAndConditionsCode",
        7075 => "PackagingLevelCode",
        7077 => "DescriptionFormatCode",
        7081 => "ItemCharacteristicCode",
        7083 => "ConfigurationOperationCode",
        7085 => "CargoTypeClassificationCode",
        7133 => "ProductDetailsTypeCodeQualifier",
        7143 => "ItemTypeIdentificationCode",
        7161 => "SpecialServiceDescriptionCode",
        7171 => "HierarchicalStructureRelationshipCode",
        7173 => "HierarchyObjectCodeQualifier",
        7187 => "ProcessTypeDescriptionCode",
        7233 => "PackagingRelatedDescriptionCode",
        7273 => "ServiceRequirementCode",
        7293 => "SectorAreaIdentificationCodeQualifier",
        7295 => "RequirementOrConditionDescriptionIdentifier",
        7297 => "SetTypeCodeQualifier",
        7299 => "RequirementDesignatorCode",
        7365 => "ProcessingIndicatorDescriptionCode",
        7383 => "SurfaceOrLayerCode",
        7405 => "ObjectIdentificationCodeQualifier",
        7429 => "IndexingStructureCodeQualifier",
        7431 => "AgreementTypeCodeQualifier",
        7433 => "AgreementTypeDescriptionCode",
        7449 => "MembershipTypeCodeQualifier",
        7451 => "MembershipCategoryDescriptionCode",
        7455 => "MembershipLevelCodeQualifier",
        7459 => "AttendeeCategoryDescriptionCode",
        7491 => "InventoryTypeCode",
        7493 => "DamageDetailsCodeQualifier",
        7495 => "ObjectTypeCodeQualifier",
        7497 => "StructureComponentFunctionCodeQualifier",
        7511 => "MarkingTypeCode",
        7515 => "StructureTypeCode",
        8015 => "TrafficRestrictionCode",
        8025 => "ConveyanceCallPurposeDescriptionCode",
        8035 => "TrafficRestrictionTypeCodeQualifier",
        8051 => "TransportStageCodeQualifier",
        8053 => "EquipmentTypeCodeQualifier",
        8077 => "EquipmentSupplierCode",
        8101 => "TransitDirectionIndicatorCode",
        8155 => "EquipmentSizeAndTypeDescriptionCode",
        8169 => "FullOrEmptyIndicatorCode",
        8179 => "TransportMeansDescriptionCode",
        8249 => "EquipmentStatusCode",
        8273 => "DangerousGoodsRegulationsCode",
        8275 => "ContainerOrPackageContentsIndicatorCode",
        8281 => "TransportMeansOwnershipIndicatorCode",
        8323 => "TransportMovementCode",
        8335 => "MovementTypeDescriptionCode",
        8339 => "PackagingDangerLevelCode",
        8341 => "HaulageArrangementsCode",
        8393 => "ReturnablePackageLoadContentsCode",
        8395 => "ReturnablePackageFreightPaymentResponsibilityCode",
        8457 => "ExcessTransportationReasonCode",
        8459 => "ExcessTransportationResponsibilityCode",
        9003 => "EmploymentDetailsCodeQualifier",
        9013 => "StatusReasonDescriptionCode",
        9015 => "StatusCategoryCode",
        9017 => "AttributeFunctionCodeQualifier",
        9023 => "DefinitionFunctionCode",
        9025 => "DefinitionExtentCode",
        9029 => "ValueDefinitionCodeQualifier",
        9031 => "EditMaskRepresentationCode",
        9035 => "QualificationApplicationAreaCode",
        9037 => "QualificationTypeCodeQualifier",
        9039 => "FacilityTypeDescriptionCode",
        9043 => "ReservationIdentifierCodeQualifier",
        9045 => "BasisCodeQualifier",
        9051 => "ApplicabilityCodeQualifier",
        9141 => "RelationshipTypeCodeQualifier",
        9143 => "RelationshipDescriptionCode",
        9153 => "SimpleDataElementCharacterRepresentationCode",
        9155 => "LengthTypeCode",
        9161 => "CodeSetIndicatorCode",
        9169 => "DataRepresentationTypeCode",
        9175 => "DataElementUsageTypeCode",
        9213 => "DutyRegimeTypeCode",
        9285 => "ValidationCriteriaCode",
        9303 => "SealingPartyNameCode",
        9353 => "GovernmentProcedureCode",
        9411 => "GovernmentInvolvementCode",
        9415 => "GovernmentAgencyIdentificationCode",
        9417 => "GovernmentActionCode",
        9421 => "ProcessStageCodeQualifier",
        9437 => "ClinicalInterventionDescriptionCode",
        9441 => "ClinicalInterventionTypeCodeQualifier",
        9443 => "AttendanceTypeCodeQualifier",
        9447 => "DischargeTypeDescriptionCode",
        9453 => "CodeValueSourceCode",
        9501 => "FormulaTypeCodeQualifier",
        9507 => "FormulaSequenceCodeQualifier",
        9509 => "FormulaSequenceOperandCode",
        9601 => "InformationCategoryCode",
        9623 => "DiagnosisTypeCode",
        9625 => "RelatedCauseCode",
        9633 => "InformationDetailsCodeQualifier",
        9635 => "EventDetailsCodeQualifier",
        9641 => "ServiceBasisCodeQualifier",
        9643 => "SupportingEvidenceTypeCodeQualifier",
        9645 => "PayerResponsibilityLevelCode",
        9649 => "ProcessingInformationCodeQualifier",
    );
    return \%codemap;
}

1;
__END__