com.highdeal.hci
Interface XMLMarshallable

All Known Subinterfaces:
CrossReferenceableOp, InstanceInfo, IXMLMarshallable, MessageAuthentication, MessageOperation, OperationResult
All Known Implementing Classes:
AbstractParameterModel, AbstractPeriodObjectModel, AccessibleChargeModel, AccessModel, AccessSearchFilterModel, AccountEventRefillModel, AccountOperation, AccountOperation.AmountAssignment, AcquisitionException, AcquisitionResult, ActivateAllOp, ActivateAllResult, ActivateException, AdditionalInfoModel, AdditionalInfoModel, AdminCommandFailedResult, AdminParameterModel, AlreadyExistException, AmountAlertModel, Attribute, AttributeDescriptionModel, AttributeModificationModel, AttributeSet, AuditModel, AuthenticateUserOp, AuthenticateUserResult, AuthenticateUserResult.FailedAuthenticationModel, AuthenticationFailedException, AuthorizationModel, AuthorizationSearchFilterModel, BadMessageFormatException, BadTargetException, BaseChronologyModel, BatchChargeException, BatchChargeResult, BatchRatingGroupModel, BooleanModel, CannotInverseException, CatalogEntryModel, ChargeableItem, ChargeableItemDescriptionModel, ChargeableItemInfo, ChargeActivationModel, ChargeActivationModificationModel, ChargeActivationSearchFilterModel, ChargeComponentModel, ChargeConditionModel, ChargeDependencyModel, ChargeDependencySetModel, ChargedItem, ChargedItem.ChargedItemField, ChargedItemClassFieldModel, ChargedItemClassModel, ChargedItemMappingEntryModel, ChargedItemMappingModel, ChargedTransaction, ChargedTransactionSet, ChargedTransactionSet.ChargedTransactionSetEntry, ChargeModel, ChargeParameters, ChargeSnapshotHolderModel, ChargingContractActivateOp, ChargingContractInfo, ChargingContractSearchFilterModel, ChargingMappingModel, ChargingPlanDictionaryModel, ChargingPlanModel, ChargingProcessInfo, ChargingResult, CheckLimitResult, ChronologyModel, CleanupAllOp, CleanupAllResult, CleanupException, CleanupResult, ClearPrepaidAccountOp, ClearPrepaidAccountResult, ClientInfo, CommonMappingTableModel, CommonRangeTableModel, CommonRangeTableRevisionModel, ComponentProperty, ConstraintViolationException, CounterDescriptionModel, CounterModel, CounterSnapshotModel, CreateAccessOp, CreateAccessResult, CreateAuditOp, CreateAuditResult, CreateAuthorizationOp, CreateAuthorizationResult, CreateBatchRatingGroupOp, CreateBatchRatingGroupResult, CreateCatalogOp, CreateCatalogResult, CreateChargeComponentOp, CreateChargeComponentResult, CreateChargedItemClassOp, CreateChargedItemClassResult, CreateExportableItemMappingOp, CreateExportableItemMappingResult, CreateMappingTableClassOp, CreateMappingTableClassResult, CreateMappingTableOp, CreateMappingTableResult, CreateMappingTableRowOp, CreateMappingTableRowResult, CreateOfferOp, CreateOfferResult, CreatePricingMacroOp, CreatePricingMacroResult, CreateProductOp, CreateProductResult, CreateRangeTableClassOp, CreateRangeTableClassResult, CreateRangeTableOp, CreateRangeTableResult, CreateRoleOp, CreateRoleResult, CreateSubscriberAccountOp, CreateSubscriberAccountResult, CreateSubscriberMappingTableOp, CreateSubscriberMappingTableResult, CreateSubscriberMappingTableRowOp, CreateSubscriberMappingTableRowResult, CreateSubscriberRangeTableOp, CreateSubscriberRangeTableResult, CreateSubscriptionOp, CreateSubscriptionResult, CreateTierTableOp, CreateTierTableResult, CreateTranslationTableOp, CreateTranslationTableResult, CreateUserOp, CreateUserResult, CreditLimitBalanceModel, CurrenciesModel, CurrencyModel, CurrencyModel, CustomerManagementArea, CustomerManagementAreaListModel, DateModel, DefaultChargeActionModel, DefaultChargeModel, DefaultHCIException, DeleteAccessBulkOp, DeleteAccessBulkResult, DeleteAccessOp, DeleteAccessResult, DeleteAuditOp, DeleteAuditResult, DeleteAuthorizationOp, DeleteAuthorizationResult, DeleteBatchRatingGroupOp, DeleteBatchRatingGroupResult, DeleteCatalogFromOwnerOp, DeleteCatalogFromOwnerResult, DeleteCatalogOp, DeleteCatalogResult, DeleteChargeComponentOp, DeleteChargeComponentResult, DeleteChargedItemClassOp, DeleteChargedItemClassResult, DeleteExportableItemMappingOp, DeleteExportableItemMappingResult, DeleteFileToBulkLoadOp, DeleteFileToBulkLoadResult, DeleteMappingTableClassOp, DeleteMappingTableClassResult, DeleteMappingTableOp, DeleteMappingTableResult, DeleteMappingTableRowOp, DeleteMappingTableRowResult, DeleteOfferOp, DeleteOfferResult, DeletePricingMacroOp, DeletePricingMacroResult, DeleteProductOp, DeleteProductResult, DeleteRangeTableClassOp, DeleteRangeTableClassResult, DeleteRangeTableOp, DeleteRangeTableResult, DeleteRoleOp, DeleteRoleResult, DeleteSubscriberAccountOp, DeleteSubscriberAccountResult, DeleteSubscriberMappingTableOp, DeleteSubscriberMappingTableResult, DeleteSubscriberMappingTableRowOp, DeleteSubscriberMappingTableRowResult, DeleteSubscriberRangeTableOp, DeleteSubscriberRangeTableResult, DeleteSubscriptionBulkOp, DeleteSubscriptionBulkResult, DeleteSubscriptionOp, DeleteSubscriptionResult, DeleteTierTableOp, DeleteTierTableResult, DeleteTranslationTableOp, DeleteTranslationTableResult, DeleteUserOp, DeleteUserOperationFromAuditOp, DeleteUserOperationFromAuditResult, DeleteUserOperationFromFiltersOp, DeleteUserOperationFromFiltersResult, DeleteUserResult, DeleteUserSessionOp, DeleteUserSessionResult, DescriptionModel, Detail, DetailTemplateModel, DisabledFeatureException, DisconnectUserOp, DisconnectUserResult, DoesNotExistException, DurationModel, EmptyXMLNode, ExpirationAlertException, ExpirationAlertModel, ExportableItemMappingException, ExportableItemMappingFieldModel, ExportableItemMappingModel, ExportCurrenciesOp, ExportCurrenciesResult, ExportOp, ExportPublicHolidaysOp, ExportPublicHolidaysResult, ExportResult, ExportSubscriberDataOp, ExportSubscriberDataResult, ExternalAccountModel, ExternalChargeActionModel, FetchClientStatisticsException, FetchClientStatisticsOp, FetchClientStatisticsResult, FileEnvelope, FileToBulkLoad, FireExpirationAlertsOp, FireExpirationAlertsResult, ForbiddenChargeException, GetCurrentReratingSessionStatusOp, GetCurrentReratingSessionStatusResult, GetCustomerManagementAreaListOp, GetCustomerManagementAreaListResult, GetFilesToBulkLoadOp, GetFilesToBulkLoadResult, GetInstanceMapOp, GetInstanceMapResult, GetJCoDestinationListOp, GetJCoDestinationListResult, GetLogTracesOp, GetLogTracesResult, GetParametersOp, GetParametersResult, GetParameterValueOp, GetParameterValueResult, GetStatusOp, GetStatusResult, GetSubAccountSubscriptionCodesOp, GetSubAccountSubscriptionCodesResult, GetSystemStatusOp, GetSystemStatusResult, GetThreadDumpOp, GetThreadDumpResult, HCIModelAdapter, HolidayModel, ImportCurrenciesOp, ImportCurrenciesResult, ImportOp, ImportPublicHolidaysOp, ImportPublicHolidaysResult, ImportResult, ImportSubscriberDataOp, ImportSubscriberDataResult, InAttributeModel, IncompatibleOperationException, IndicatorPersistentAccessException, InMacroComponentModel, InMacroPropertyModel, InstanceInfoImpl, InstanceMap, InstanceProperty, InstanceStatus, InternalChargeActionModel, InvalidBulkModificationException, InvalidCreationErrorException, InvalidCreationException, InvalidDeletionErrorException, InvalidDeletionException, InvalidExportException, InvalidHolidayException, InvalidImportException, InvalidInstanceException, InvalidItemException, InvalidMaintainErrorException, InvalidModificationErrorException, InvalidModificationException, InvalidOperationErrorException, InvalidParameterValueException, InvalidPasswordException, InvalidSearchErrorException, InvalidSearchException, InvalidSubscriberAccountException, InvalidSubscriberDataExportErrorException, InvalidSubscriberDataImportErrorException, InvalidTaxException, ISO4217CurrenciesModel, ISO4217CurrencyModel, ListClientsOp, ListClientsResult, MacroComponentModel, MaintainCustomerManagementAreaListOp, MaintainCustomerManagementAreaListResult, MaintainMappingTableRowOp, MaintainMappingTableRowResult, MaintainSubscriberMappingTableRowOp, MaintainSubscriberMappingTableRowResult, MappingTableClassInColumnModel, MappingTableClassModel, MappingTableClassOutColumnModel, MappingTableClassSearchFilterModel, MappingTableColumnModel, MappingTableModel, MappingTableRowModel, MappingTableSearchFilterModel, MessageBody, MessageEnvelope, MessageHeader, MessageOperationAdapter, MessageOriginator, ModificationModel, ModifyAccessOp, ModifyAccessResult, ModifyAuditOp, ModifyAuditResult, ModifyAuthorizationOp, ModifyAuthorizationResult, ModifyBatchRatingGroupOp, ModifyBatchRatingGroupResult, ModifyCatalogOp, ModifyCatalogResult, ModifyChargeComponentOp, ModifyChargeComponentResult, ModifyChargedItemClassOp, ModifyChargedItemClassResult, ModifyExportableItemMappingOp, ModifyExportableItemMappingResult, ModifyMappingTableRowOp, ModifyMappingTableRowResult, ModifyOfferOp, ModifyOfferResult, ModifyPasswordOp, ModifyPasswordResult, ModifyPricingMacroOp, ModifyPricingMacroResult, ModifyProductOp, ModifyProductResult, ModifyRangeTableClassOp, ModifyRangeTableClassResult, ModifyRangeTableOp, ModifyRangeTableResult, ModifyRoleOp, ModifyRoleResult, ModifySubscriberAccountOp, ModifySubscriberAccountResult, ModifySubscriberMappingTableRowOp, ModifySubscriberMappingTableRowResult, ModifySubscriberRangeTableOp, ModifySubscriberRangeTableResult, ModifySubscriptionBulkOp, ModifySubscriptionBulkResult, ModifySubscriptionOp, ModifySubscriptionResult, ModifyTierTableOp, ModifyTierTableResult, ModifyTranslationTableOp, ModifyTranslationTableResult, ModifyUserOp, ModifyUserResult, NoTargetDefinedException, NotAuthorizedException, Notification, NumberModel, OfferConditionContextModel, OfferConditionModel, OfferContextModel, OfferModel, OneShotChargeModel, OneShotRateModel, OperationCanceledException, OperationFailureErrorException, OperationFailureException, OperationResultAdapter, OutAttributeModel, OutMacroPropertyModel, OutPropertyUpdateComponentModel, ParameterConcurrentAccessException, ParameterModel, ParameterOperation, ParameterOperationResult, ParameterSetModel, PeriodObjectModel, PingOp, PingResult, PnRObjectSet, PostRateException, PostRateResult, PreMacroComponentModel, PrepaidAccountModel, PrepaidTransactionFieldMappingModel, PrepaidTransactionMappingModel, PreRateException, PreRateResult, PreTableComponentModel, PreTierTableComponentModel, PricePlanModel, PricingMacroModel, ProductModel, Property, PropertyDescriptionModel, PropertyEntryModel, ProrataModel, PublicHolidaysModel, PurchaseOrder, PurgeAllowanceException, PurgeAllowancesOp, PurgeAllowancesResult, PurgeIdempotencyStorageOp, PurgeIdempotencyStorageResult, PurgeJobRecordOp, PurgeJobRecordResult, RangeTableClassModel, RangeTableClassOutColumnModel, RangeTableClassSearchFilterModel, RangeTableColumnModel, RangeTableModel, RangeTableRevisionModel, RangeTableRowModel, RangeTableRowPeriodObjectModel, RangeTableSearchFilterModel, RateComponentModel, RateModel, RecurringChargeModel, RecurringDateModel, RecurringRateModel, RefillPrepaidAccountOp, RefillPrepaidAccountResult, com.highdeal.refilllogic.hci.RefillRecurringRateModel, RefreshRatingInstancesOp, RefreshRatingInstancesResult, RefreshTaxCacheOp, RefreshTaxCacheResult, RefreshTransServTypeListOp, RefreshTransServTypeListResult, RefreshVatRulesCacheOp, RefreshVatRulesCacheResult, RerateBulkException, RerateBulkOp, RerateBulkResult, RerateSubscriptionException, ResetCachesOp, ResetCachesResult, ResetCreditLimitBalanceOp, ResetCreditLimitBalanceResult, ResetParameterValueOp, ResetParameterValueResult, ResponseItem, ResponseItem.ResponseItemField, RetryableDatabaseException, RoleModel, RoleSearchFilterModel, SearchAccessFromSubscriptionOp, SearchAccessFromSubscriptionResult, SearchAccessOp, SearchAccessResult, SearchAllBatchRatingGroupsOp, SearchAllBatchRatingGroupsResult, SearchAuditsOp, SearchAuditsResult, SearchAuthorizationOp, SearchAuthorizationResult, SearchAvailableTaxAreaListOp, SearchAvailableTaxAreaListResult, SearchAvailableTransServTypeListOp, SearchAvailableTransServTypeListResult, SearchCatalogOp, SearchCatalogResult, SearchChargeComponentByPricingMacroOp, SearchChargeComponentByPricingMacroResult, SearchChargeComponentByTierTableOp, SearchChargeComponentByTierTableResult, SearchChargeComponentByTranslationTableOp, SearchChargeComponentByTranslationTableResult, SearchChargeComponentOp, SearchChargeComponentResult, SearchChargedItemClassOp, SearchChargedItemClassResult, SearchCodeOp, SearchCodeResult, SearchExportableItemMappingOp, SearchExportableItemMappingResult, SearchExportableItemTemplateNamesOp, SearchExportableItemTemplateNamesResult, SearchExportableItemTemplateOp, SearchExportableItemTemplateResult, SearchFilterModel, SearchMappingTableClassOp, SearchMappingTableClassResult, SearchMappingTableOp, SearchMappingTableResult, SearchOfferByChargeComponentOp, SearchOfferByChargeComponentResult, SearchOfferOp, SearchOfferResult, SearchPricingMacroByPricingMacroOp, SearchPricingMacroByPricingMacroResult, SearchPricingMacroByTierTableOp, SearchPricingMacroByTierTableResult, SearchPricingMacroByTranslationTableOp, SearchPricingMacroByTranslationTableResult, SearchPricingMacroOp, SearchPricingMacroResult, SearchProductOp, SearchProductResult, SearchRangeTableClassOp, SearchRangeTableClassResult, SearchRangeTableOp, SearchRangeTableResult, SearchReratingInfosFromChargingContractOp, SearchReratingInfosFromChargingContractResult, SearchResult, SearchRoleOp, SearchRoleResult, SearchSubscriberAccountOp, SearchSubscriberAccountResult, SearchSubscriberMappingTableOp, SearchSubscriberMappingTableResult, SearchSubscriberRangeTableOp, SearchSubscriberRangeTableResult, SearchSubscriptionFromAccessOp, SearchSubscriptionFromAccessResult, SearchSubscriptionOp, SearchSubscriptionResult, SearchTierTableOp, SearchTierTableResult, SearchTranslationRowsOp, SearchTranslationRowsResult, SearchTranslationTableOp, SearchTranslationTableResult, SearchUserOp, SearchUserOperationFromAuditsOp, SearchUserOperationFromAuditsResult, SearchUserOperationFromFiltersOp, SearchUserOperationFromFiltersResult, SearchUserOperationOp, SearchUserOperationResult, SearchUserResult, SearchUserSessionOp, SearchUserSessionResult, SearchUserSessionResult.UserSessionModel, SearchVatRulesOp, SearchVatRulesResult, ServerErrorException, ServerFailureException, ServerManagementOp, ServerManagementResult, ServerShutdownOp, ServerShutdownResult, SessionOperationException, SetParameterValueOp, SetParameterValueResult, SimpleMessageAuthentication, SpecificFormulaModel, SpecificModificationModel, SQLConnectionAdminOp, SQLConnectionAdminResult, SQLConnectionsRefreshOp, SQLConnectionsRefreshResult, StartCacheWarmupOp, StartCacheWarmupResult, StartRateException, StartRateResult, StartSubscriptionReratingResult, StatelessPreRatingException, StatelessRateException, StatelessRateResult, StatelessRatingContext, StatelessRatingEvent, StatusModel, StopActivationOp, StopActivationResult, StopChargingContractActivationOp, StopCleanupOp, StopCleanupResult, StopPurgeAllowancesOp, StopPurgeAllowancesResult, StopRateException, StopRateResult, StopReratingSessionOp, StopReratingSessionResult, StringModel, SubscriberAccountModel, SubscriberAccountSearchFilterModel, SubscriberData, SubscriberMappingTableModel, SubscriberMappingTableSearchFilterModel, SubscriberRangeTableModel, SubscriberRangeTableRevisionModel, SubscriberRangeTableSearchFilterModel, SubscriptionContextModel, SubscriptionCounterSnapshotModel, SubscriptionModel, SubscriptionModificationModel, SubscriptionSearchFilterModel, SubscriptionSnapshotHolderModel, SubsReflect, SubsReflectDetail, SwitchDBFileDirectoriesOp, SwitchDBFileDirectoriesResult, SynchronizeExternalCurrenciesOp, SynchronizeExternalCurrenciesResult, SystemStatus, TaxArea, TaxDataModel, TaxDetailModel, TaxedAmount, TaxInfoModel, TaxParameterModel, TaxParameterSetModel, TierTableInstanceModel, TierTableInstanceSetModel, TierTableModel, TierTableOutAttributeModel, TierTableRowModel, TierTableSearchFilterModel, Transaction, TransactionClearingException, TransactionSet, TransactionTemplateModel, TranslateValueOp, TranslateValueResult, TranslationInstanceModel, TranslationInstanceSetModel, TranslationRowModel, TranslationTableModel, TranslationTableSearchFilterModel, TransServType, UniqueIdentifier, UnknownParameterException, UnlockChargingContractException, UnlockChargingContractOp, UnlockChargingContractResult, UnlockSubscriptionException, UnlockSubscriptionOp, UnlockSubscriptionResult, UpdateRateException, UpdateRateResult, UsageChargeModel, UsageRateModel, UserDefinedRecordModel, UserModel, UserOperationFilterModel, UserOperationModel, UserOperationSearchFilterModel, VatRuleModel, com.highdeal.pnr.hci.VersioningModifyOp, XMLNode

public interface XMLMarshallable

This Java interface serves as a base for objects that can be marshalled and unmarshalled; Consider the Java subinterfaces and the Java classes that implement this interface.

The methods provided by this interface, define the processes of marshalling content trees into XML documents and vice-versa.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:complexType name="XMLMarshallable" abstract="true"/>


Method Summary
 void addCharacterData(java.lang.String cData)
          Adds character data to the content element.
 void addChild(java.lang.String tagName, XMLMarshallable child)
          Adds a child to the object, the child representing the marshallable object which must be added to the element.
 void marshal(XMLOutputter output)
          Gives an XML representation of this object, including its children.
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the element being processed.
 

Method Detail

setAttributes

void setAttributes(XMLAttributes atts)
Sets the attributes of the XML representation of the element being processed.

Parameters:
atts - The XML attributes of the current element

addChild

void addChild(java.lang.String tagName,
              XMLMarshallable child)
Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:
tagName - The name of tag for the child
child - The child to be added

addCharacterData

void addCharacterData(java.lang.String cData)
Adds character data to the content element.

Parameters:
cData - The character data to be added

marshal

void marshal(XMLOutputter output)
Gives an XML representation of this object, including its children.

Parameters:
output - The XML output to marshal the object into

Document Published: October 2015 (SAP CC 4.0 SP10 and Later)