com.sap.cloud.sdk.s4hana.serialization

Class StringBasedErpType<T extends StringBasedErpType<T>>

java.lang.Object

com.sap.cloud.sdk.s4hana.serialization.StringBasedErpType<T>

Type Parameters:

T - The type implementing this abstract class.

All Implemented Interfaces:

ErpType<T>, StringRepresentableKey, Serializable, Comparable<T>

Direct Known Subclasses:

Account, AccountDetermination, AccountingDocumentLineItemNumber, AccountingDocumentNumber, AccountingPrinciple, AccountNumberOfBankAccountAtPostOffice, AccountNumberOfSupplier, AccountNumberOfTheBranch, AccountNumberOfVendor, AccountType, AccountType, ActiveStatusOfTransactionOrActivity, ActivityType, ActivityUnit, AdditionalDepreciation, AdditionalDepreciationCode, AlternativePayee, AlternativePayerPayee, AmountAsTextField, Application, ApplicationLogInternalMessageSerialNumber, ApplicationLogLogNumber, AreaUnit, AssetAccountingAcquisMonth, AssetClass, AssetClass, AssetInsuranceType, AssetItem, AssetLocation, AssetSCountryOfOrigin, AssetStructure, AssetSubnumber, AssetSubnumber4, AssetSuperNumber, AssetTypeName, AssignmentNumber, AuthorizationGroup, BankAccount, BankAccountNumber, BankControlKey, BankCountryKey, BankCountryKeyInIsoCode, BankInternalId, BankKeys, BankNumber, BankStatementId, BankTypeOfAlternativePayer, BaseUnitOfMeasure, BaseUnitOfMeasureInIsoCode, BillingCategory, BillingType, BlockKey, BlockKeyForAdditionalDepreciation, BranchCode, BudgetPeriod, BudgetPeriodForApcAccountAssignments, BuildingNumber, BusinessArea, BusinessEntityNumber, BusinessPartnerNumber, BusinessProcess, CancelObjectKey, CcaTemplSki, CentralClearingOption, ChangeType, ChartOfAccounts, CheckboxForRequestingDataForGetlist, ClearingStatus, CoActualPostingsFastInputVariant, CommitmentItem, CommitmentItem24, Company, CompanyCode, CompanyCode, CompanyCodeOfFacility, CompanyCodeOfRealEstateObjectsToBeSent, CompanyCodeOfReceivingRealEstateObject, CompanyIdOfTradingPartner, ComponentInAccInterface, ConditionCategory, ConditionCounter, ConditionType, ConfirmationStatus, ContractNumber, ControllingArea, ControllingArea, CorrectionItemNumber, CostCenter, CostCenter, CostCenterCategory, CostCenterResponsibleForAsset, CostElement, CostingSheet, CostObject, Counterconfirmation, CountryIsoCode, CountryKey, CountryKeyInIsoCode, Currency, CurrencyForAutomaticPayment, CurrencyKey, CurrencyOfCalculationBasis, CurrencyTypeAndValuationView, CustomerNumber, Department, DepreciationGroup, DepreciationKey, DetermineGroupingDefinition, DirectionOfFlow, DirectionOfTransaction, DisputeManagementDisputeInterfaceCategory, DistributionChannel, DistributionChannel, Division, Division, DocumentItemNumber, DocumentItemNumberReferingToTaxDocument, DocumentNumber, DocumentNumber, DocumentNumberForEarmarkedFunds, DocumentStatus, DocumentType, DunningArea, EarmarkedFundsDocumentItem, EcologicalClass, EcsEnvironment, EquityType, EvaluationGroup1, EvaluationGroup2, EvaluationGroup3, EvaluationGroup4, ExchangeRateType, ExerciseType, ExpensesKey, ExpenseTypeForGrantor, ExpiredUsefulLifeInPeriodsAtStartOfFiscalYear, ExpiredUsefulLifeInPeriodsDuringFyFromSdepStartDat, ExpiredUsefulLifeInYearsAtStartOfTheFiscalYear, ExternalAccount, ExternalGuidForMaterialField, ExternalReference, ExternalTradeId, FieldInParameter, FieldName, FieldToWhichTheSelectionConditionShouldApply, FinanceProject, FinancialManagementArea, FinancialTransaction, FinancialTransaction, FinancialTransactionType, FiscalPeriod, FixedAsset, FixedAssetIsNotLiableForTaxation, FlowType, FmPartnerBudgetPeriod, FmReceiverBudgetPeriod, FmSenderBudgetPeriod, FollowingCurrency, FunctionalArea, FunctionalArea16, FunctionalAreaForApcAccountAssignments, Fund, FundedProgram, FundForApcAccountAssignments, FundsCenter, FundsCenterForApcAccountAssignments, GeneralLedgerAccount, GeneralValuationClass, GlAccountNumberForPaymentCardReceivables, Grant, GrantForApcAccountAssignments, GrantorProgramProfile, GroupAsset, GuarantorOfFinancialTransaction, HedgeRequestId, HedgingClassification, Iban, IdentifierOfTheAccrualObject, IdentifierOfTheAccrualSubobject, IdForAccountDetails, InclusionExclusionCriterionSignForRangeTables, IndexSeriesForReplacementValues, IndexSeriesForReplacementValuesByAge, IndicatorForWithholdingTaxType, IndicatorIfTransferredDataIsComplete, InitialStageValue, InstructionKey1, InstructionKey2, InstructionKey3, InstructionKey4, InstructionKeyForDataMediumExchange, InsuranceCompanies, InsuranceIndexSeries, InsuranceRateFiAa, InterestCalculationMethod, InterestCalendar, InternalKeyForRealEstateObject, InternalOrder, InternalOrderType, InventoryCardNumber, InventoryNumber, InvestmentOrder, InvestmentSupportKey, InvoiceRefObjectKey, IsoCodeCurrency, IsoCodeForUnitOfMeasurement, IsoCurrencyCode, ItemNumberInReceiverSalesOrder, ItemNumberInSalesOrder, ItemNumberInSenderSalesOrder, ItemNumberOfPurchasingDocument, ItemNumberOfTheSdDocument, JibJibeClass, JibJibeSubclassA, JointVenture, JointVentureObjectType, KeyWhichIdentifiesAFlowInTheBapi, LandNumberForBe, LandRegisterEntrySequenceNumber, LandRegisterPage, LandRegisterVolume, LanguageKey, LanguageKey, LeadingCurrency, LeasePaymentCycle, LeasingCompany, LeasingType, LedgerGroup, LegalBasis, LengthOfLeaseInPeriods, LengthOfLeaseInYears, LevelNumber, LicensePlateNoOfVehicle, LicensePlateNumber, ListOfRespectedPaymentMethods, LogicalSystem, LogicalSystemFromWhichMessageOriginates, LogicalSystemOfSourceDocument, LogicalTransaction, LongFund, LongMaterialNumberForMaterialField, MainAssetNumber, MainAssetNumber12, MaintenanceOrder, MasterAgreement, MasterFixedAsset, MasterRecordInactive, MaterialNumber, MaterialNumber40, MaterialRelatedOrigin, Matnr, MessageClass, MessageNumber, MonthEndIndicatorForStartOfACalculationPeriod, MonthEndIndicatorForTheEndOfACalculationPeriod, MovementIndicator, Name1, Name2, Name3, Name4, NetworkNumberForAccountAssignment, NewOkofCode, NumberForReceiverProfitabilitySegment, NumberOfBaseDaysInACalculationPeriod, NumberOfDays, NumberOfRentalObject, ObjectKey, ObjectNumber, ObsoleteAccntAssignmentRefInFinAssetsManagement, ObsoleteHedgingClassification, OnBehalfOfCompanyCode, OperationActivityNumber, OrderItemNumber, OrderNumber, OrderPriceUnit, OriginalAssetThatWasTransferred, OriginalAssetThatWasTransferred4, OriginalOptionCategory, OriginalUsefulLifeInPeriods, OriginalUsefulLifeInYears, OriginGroupAsSubdivisionOfCostElement, ParameterName, ParameterToWhichTheSelectionConditionShouldApply, PartnerAccountNumber, PartnerBankDetails, PartnerBankType, PartnerCompanyId, PartnerFund, PartnerGrant, PartnerProfitCenter, PartnerProfitCenterForEliminationOfInternalBusiness, PartnerSegmentForSegmentalReporting, PayerPayee, PaymentAdvice, PaymentAdviceItem, PaymentAdviceType, PaymentCardsCardNumber, PaymentCardsCardType, PaymentCardsEntryMode, PaymentCardsMerchantIdAtTheClearingHouse, PaymentCardsPointOfReceiptForTheTransaction, PaymentCurrency, PaymentMethod, PaymentMethodSupplement, PaymentReferenceOfPaymentServiceProvider, PaymentServiceProvider, PaymentTypeForGrantor, Period, Period, PeriodInWhichFirstAcquisitionWasPosted, PersonnelNumber, PersonnelNumber, PersonResponsible, PlannedUsefulLifeInPeriods, PlannedUsefulLifeInYears, Plant, PlantForReceiverMaterial, PoBox, PoBoxPostalCode, PorReferenceNumber, PorSubscriberNumber, Portfolio, PostalCode, PostedOutputUnit, PostedUnitOfMeasure, PostingStatusOfFlow, PowerUnit, PowerUnitOfMeasureInIsoCode, PriceUnit, PrinterDestinationForCctrReport, PriorYearTransaction, ProductionVersionOfReceiverMaterial, ProductType, ProfitCenter, ProfitCenter, PropertyClassificationKey, PropertyIndicator, PurchaseOrderPriceUnitInIsoCode, PurchasingDocumentNumber, PutCallIndicator, RdAsset, RealDepreciationArea, RealEstateRecipientSettlementUnit, ReasonForEnvironmentalInvestment, ReasonForInvestment, ReasonForManualValuationOfNetAssets, ReasonForReversal, ReceiverAccountingIndicator, ReceiverActivityType, ReceiverBusinessProcess, ReceiverCostCenter, ReceiverCostObject, ReceiverFund, ReceiverGrant, ReceiverMaterial, ReceiverMaterial40, ReceiverNetwork, ReceiverOperation, ReceiverOrder, ReceiverProcurementProcess, ReceiverRunScheduleHeader, ReceiverSalesOrder, ReceiverWorkBreakdownStructureElement, ReceiverWorkItem, ReceivingContractInRealEstate, ReceivingFunctionalArea, ReceivingManagementContract, ReceivingResource, RecipientBuildingsRealEstate, RecipientBusinessEntityRealEstate, RecipientIncidentalExpensesKeyRealEstate, RecipientLeaseOutRealEstate, RecipientPropertyRealEstate, RecipientRentalUnitRealEstate, RecoveryIndicator, ReferenceDocumentNumber, ReferenceDocumentNumber35, ReferenceProcedure, Region, RepetitiveCode, ReportingCountryForDeliveryOfGoodsWithinTheEu, ReportKeyForDataMediumExchange, ReservationReason, ResultsAnalysisKey, RoutingNumberOfOperationsInTheOrder, SalesDocumentItemNumber, SalesDocumentType, SalesGroup, SalesOffice, SalesOrderNumber, SalesOrganization, SalesOrganization, SalesUnit, SalesUnitInIsoCode, SapClient, SegmentForSegmentalReporting, SelectionOperatorOptionForRangeTables, SelectionsForGetlistLowerLimitOfValueArea, SelectionsForGetlistUpperlimitOfValueArea, SenderAccountingIndicator, SenderActivityType, SenderBusinessProcess, SenderCostCenter, SenderCostObject, SenderFund, SenderGrant, SenderNetwork, SenderOperation, SenderOrder, SenderSalesOrder, SenderSettlementUnitRealEstate, SenderWorkBreakdownStructureElement, SenderWorkItem, SendingBuildingRealEstate, SendingBusinessEntityRealEstate, SendingContractRealEstate, SendingFunctionalArea, SendingIncidentalExpensesKeyRealEstate, SendingLeaseRealEstate, SendingManagementContract, SendingPropertyRealEstate, SendingRentalUnitRealEstate, SendingResource, SequentialNumberOfAccountAssignment, SerialNumber, ServiceChargeKey, ServiceIndicator, SettlementIndicator, SettlementUnit, ShortKeyForAHouseBank, SoldToParty, SortKey5, StandardHierarchyArea, StateCentralBankIndicator, StructureNameOfBapiTableExtension, SubBlockKey, SubnumberOfGroupAsset, SupplementaryInventorySpecifications, SupplierCountryIsoCode, SupplyingCountry, SwiftBicForInternationalPayments, TaxJurisdiction, TaxJurisdictionCodeJurisdictionForLowestLevelTax, TaxNumber1, TaxNumber2, TaxNumberOfTheNoticeOfAssessment, TaxOnSalesPurchasesCode, TechnicalCaseKey, TemplateActivityDependentAllocationToCostCenter, TemplateActivityIndependentAllocationToCostCenter, TemplateActStatKeyFigureCostCenterActivityType, TemplateForActivityDependentFormulaPlanning, TemplateForActivityIndependentFormulaPlanning, TerritorialCode, TerritorialCode3, TradedCurrency, Trader, TradingPartnerSBusinessArea, TransactionActivity, TransactionActivityCategory, TransactionCurrency, TransactionNumberOfFacility, TransactionReleaseReleaseStatus, TransactionType, TransportTaxExemptionCode, TransportTaxReductionCode, TransportType, TwoCharacterSapLanguageCode, TypeOfTheAccrualObject, TypeOfTheItemOfTheAccrualSubobject, UniqueReferenceToMandateForEachPayee, UnitOfEntry, UnitOfEntryInIsoCode, UnitOfWeightInIsoCode, UpdatedInformationInRelatedUserDataField, UsageOfTheConditionTable, UserName, UserResponsible, ValuationArea, ValuationType, VatRegistrationNumber, VehicleIdentificationNumber, VehiclePriceCategoryForTransportTax, Version, VersionNumberForMaterialField, VolumeUnit, VolumeUnitInIsoCode, WbsElementExternalKey, WbsElementInvestmentProjectExternalKey, WbsElementInvestmentProjectInternalKey, WeightsListOfPreciousMaterials, WeightUnit, WithholdingTaxCode, WorkBreakdownStructureElement, WorkBreakdownStructureElement8, YrsExpiredUpToFiscYrStartFromStartOfSpecDep

public abstract class StringBasedErpType<T extends StringBasedErpType<T>>
extends Object
implements ErpType<T>, Comparable<T>, StringRepresentableKey

Base class for string-based ERP types.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringBasedErpType.CharCasing The casing of the contained value to be used by a StringBasedErpType.
static class	StringBasedErpType.FillCharStrategy The strategy to be used to fill the String representation of a StringBasedErpType to the length specified by getMaxLength().

Constructor Summary

Constructors

Constructor and Description
StringBasedErpType(String value) Constructs a new string-based type.
StringBasedErpType(String value, StringBasedErpType.CharCasing charCasing) Constructs a new string-based type with a certain character casing and the english locale.
StringBasedErpType(String value, StringBasedErpType.CharCasing charCasing, Locale locale) Constructs a new string-based type with a certain character casing and the given locale.

Method Summary

Modifier and Type	Method and Description
int	compareTo(T other)
boolean	equals(Object o)
char	getFillChar()
abstract StringBasedErpType.FillCharStrategy	getFillCharStrategy()
String	getKeyAsString() Returns the String representation of this key.
abstract int	getMaxLength()
abstract Class<T>	getType()
String	getValue()
int	hashCode()
boolean	isDefault()
boolean	isEmpty()
String	toString()
String	toString(StringBasedErpType.FillCharStrategy strategy, char fillChar) Returns this value, filled according to the given FillCharStrategy with the give fillChar.
static <T extends StringBasedErpType<T>> com.google.common.base.Function<T,String>	transformToString(ErpTypeConverter<T> converter) Creates a function which transforms a given StringBasedErpType to its String representation.
static <T extends StringBasedErpType<T>> com.google.common.base.Function<String,T>	transformToType(ErpTypeConverter<T> converter) Creates a function which transforms a given String to its StringBasedErpType representation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sap.cloud.sdk.s4hana.serialization.ErpType

getTypeConverter

Constructor Detail

StringBasedErpType

public StringBasedErpType(String value)
                   throws IllegalArgumentException

Constructs a new string-based type.

Parameters:

value - The value of the type (not null). The given string is trimmed. An empty or trimmed empty value results in an empty instance of the string-based type.

Throws:

IllegalArgumentException - If the given value cannot be converted to an instance of this type, or the given parameter is null.

StringBasedErpType

public StringBasedErpType(String value,
                          StringBasedErpType.CharCasing charCasing)
                   throws IllegalArgumentException

Constructs a new string-based type with a certain character casing and the english locale.

Parameters:

value - The value of the type (not null). The given string is trimmed. An empty or trimmed empty value results in an empty instance of the string-based type.

charCasing - Defines the casing of characters within the string.

Throws:

IllegalArgumentException - If the given value cannot be converted to an instance of this type, or any of the given parameter is null.

StringBasedErpType

public StringBasedErpType(String value,
                          StringBasedErpType.CharCasing charCasing,
                          Locale locale)
                   throws IllegalArgumentException

Constructs a new string-based type with a certain character casing and the given locale.

Parameters:

value - The value of the type (not null). The given string is trimmed. An empty or trimmed empty value results in an empty instance of the string-based type.

charCasing - Defines the casing of characters within the string.

locale - The locale to be used to change the casing of value.

Throws:

IllegalArgumentException - If the given value cannot be converted to an instance of this type, or any of the given parameter is null.

Method Detail

getType

public abstract Class<T> getType()

Returns:

The class of the string-based ERP type.

getMaxLength

public abstract int getMaxLength()

Returns:

The maximum length of the string-based ERP type.

getFillCharStrategy

public abstract StringBasedErpType.FillCharStrategy getFillCharStrategy()

Returns:

The strategy of how the type should handle fill characters.

getFillChar

public char getFillChar()

Returns:

The character that is used to add or strip fill characters.

isEmpty

public final boolean isEmpty()

Returns:

true if the contained string value is empty, false otherwise.

isDefault

public final boolean isDefault()

Returns:

true if this instance represents the default SapClient.DEFAULT, false otherwise.

toString

public final String toString()

Overrides:

toString in class Object

toString

public final String toString(StringBasedErpType.FillCharStrategy strategy,
                             char fillChar)

Returns this value, filled according to the given FillCharStrategy with the give fillChar.

Parameters:

strategy - The strategy to be used to fill this value.

fillChar - The character to be used to fill this value.

Returns:

The value according to the given fill character strategy.

compareTo

public int compareTo(T other)

Specified by:

compareTo in interface Comparable<T extends StringBasedErpType<T>>

getKeyAsString

public String getKeyAsString()

Description copied from interface: StringRepresentableKey

Returns the String representation of this key.

Specified by:

getKeyAsString in interface StringRepresentableKey

Returns:

This key as a String.

transformToString

public static <T extends StringBasedErpType<T>> com.google.common.base.Function<T,String> transformToString(ErpTypeConverter<T> converter)

Creates a function which transforms a given StringBasedErpType to its String representation. This function handles null gracefully and returns null itself.

Type Parameters:

T - The type of the subclass to transform.

Parameters:

converter - The converter that should transform the concrete implementation of StringBasedErpType to String.

Returns:

A null-safe function transforming a StringBasedErpType to String.

transformToType

public static <T extends StringBasedErpType<T>> com.google.common.base.Function<String,T> transformToType(ErpTypeConverter<T> converter)

Creates a function which transforms a given String to its StringBasedErpType representation. This function handles null gracefully and returns null itself.

Type Parameters:

T - The type of the subclass to create.

Parameters:

converter - The converter that should transform the String representation to the concrete StringBasedErpType implementation.

Returns:

A null-safe function transforming a String to a StringBasedErpType.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getValue

public String getValue()