Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%SOAP] >  [MsgDescriptor]
Private  Storage   

abstract class %SOAP.MsgDescriptor extends %SOAP.Descriptor

Super class for generated classes that represent SOAP Service WebMethods.
This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class."

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1 2


Summary

Properties
%ResponseName

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
InvokeService ProcessHTTP XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType

Subclasses
%CSP.Monitor.Server.GetMatrix %CSP.Monitor.Server.MessageSearch %CSP.Monitor.Server.ResendDuplicatedMessage
%DeepSee.XMLA.Server.Discover %DeepSee.XMLA.Server.Execute %SOAP.RM.Service.CloseSequence
%SOAP.RM.Service.CreateSequence %SOAP.RM.Service.TerminateSequence %SOAP.WSSC.Service.RequestSecurityToken
%WebStress.Comms.Server.AnyTestsRunning %WebStress.Comms.Server.BuildCode %WebStress.Comms.Server.CheckDataValid
%WebStress.Comms.Server.CheckGeneratorIsRunning %WebStress.Comms.Server.CheckGeneratorRunStatus %WebStress.Comms.Server.DownloadData
%WebStress.Comms.Server.GetErrors %WebStress.Comms.Server.GetGenID %WebStress.Comms.Server.GetIterationData
%WebStress.Comms.Server.GetMaxRunNumber %WebStress.Comms.Server.GetRunData %WebStress.Comms.Server.ResetControlData
%WebStress.Comms.Server.StartDataTransfer %WebStress.Comms.Server.StartMonitor %WebStress.Comms.Server.StartProcs
%WebStress.Comms.Server.TestAuthenticate %WebStress.Comms.Server.TestStart %WebStress.Comms.Server.TestStop
%iKnow.Filters.FilterWSAPI.ClearCachedFilter %iKnow.Filters.FilterWSAPI.ClearCachedFilters %iKnow.Filters.FilterWSAPI.CreateAsString
%iKnow.Filters.FilterWSAPI.CreateGroupAsString %iKnow.Matching.DictionaryWSAPI.CreateDictionary %iKnow.Matching.DictionaryWSAPI.CreateDictionaryFormat
%iKnow.Matching.DictionaryWSAPI.CreateDictionaryItem %iKnow.Matching.DictionaryWSAPI.CreateDictionaryItemAndTerm %iKnow.Matching.DictionaryWSAPI.CreateDictionaryTerm
%iKnow.Matching.DictionaryWSAPI.CreateDictionaryTermFormat %iKnow.Matching.DictionaryWSAPI.CreateRegularExpression %iKnow.Matching.DictionaryWSAPI.DropAllDictionaryData
%iKnow.Matching.DictionaryWSAPI.DropDictionary %iKnow.Matching.DictionaryWSAPI.DropDictionaryItem %iKnow.Matching.DictionaryWSAPI.DropDictionaryTerm
%iKnow.Matching.DictionaryWSAPI.GetDictionaries %iKnow.Matching.DictionaryWSAPI.GetDictionaryCount %iKnow.Matching.DictionaryWSAPI.GetDictionaryId
%iKnow.Matching.DictionaryWSAPI.GetDictionaryItemIdByURI %iKnow.Matching.DictionaryWSAPI.GetDictionaryItems %iKnow.Matching.DictionaryWSAPI.GetDictionaryItemsAndTerms
%iKnow.Matching.DictionaryWSAPI.GetDictionaryTermsByItem %iKnow.Matching.DictionaryWSAPI.GetItemCount %iKnow.Matching.DictionaryWSAPI.GetItemsByName
%iKnow.Matching.DictionaryWSAPI.GetTermCount %iKnow.Matching.DictionaryWSAPI.GetTermCountByItem %iKnow.Matching.DictionaryWSAPI.GetTermElements
%iKnow.Matching.DictionaryWSAPI.GetTermsByName %iKnow.Matching.DictionaryWSAPI.HasDictionaries %iKnow.Matching.MatchingWSAPI.ClearLogs
%iKnow.Matching.MatchingWSAPI.GetDictionaryMatches %iKnow.Matching.MatchingWSAPI.GetDictionaryMatchesById %iKnow.Matching.MatchingWSAPI.GetErrors
%iKnow.Matching.MatchingWSAPI.GetMatchElements %iKnow.Matching.MatchingWSAPI.GetMatchesByCrcOcc %iKnow.Matching.MatchingWSAPI.GetMatchesByDictionaryItemId
%iKnow.Matching.MatchingWSAPI.GetMatchesByDictionaryItemURI %iKnow.Matching.MatchingWSAPI.GetMatchesByDictionaryTermId %iKnow.Matching.MatchingWSAPI.GetMatchesByEntOcc
%iKnow.Matching.MatchingWSAPI.GetMatchesByPath %iKnow.Matching.MatchingWSAPI.GetMatchesBySentence %iKnow.Matching.MatchingWSAPI.GetMatchesBySource
%iKnow.Matching.MatchingWSAPI.GetMatchesBySourceId %iKnow.Matching.MatchingWSAPI.GetSentenceIdForMatchTarget %iKnow.Matching.MatchingWSAPI.GetSourceIdForMatchTarget
%iKnow.Matching.MatchingWSAPI.GetTopItems %iKnow.Matching.MatchingWSAPI.GetTopMatchesByDictionaryItemId %iKnow.Matching.MatchingWSAPI.GetTopMatchesByDictionaryItemURI
%iKnow.Matching.MatchingWSAPI.GetTopSourcesByDictionary %iKnow.Matching.MatchingWSAPI.GetTopTermsByItemId %iKnow.Matching.MatchingWSAPI.GetTotalDictionaryScoresBySource
%iKnow.Matching.MatchingWSAPI.GetTotalDictionaryScoresBySourceId %iKnow.Matching.MatchingWSAPI.GetTotalItemScoresBySource %iKnow.Matching.MatchingWSAPI.GetTotalItemScoresBySourceId
%iKnow.Matching.MatchingWSAPI.InvalidateMatchingResults %iKnow.Matching.MatchingWSAPI.MatchSource %iKnow.Matching.MatchingWSAPI.MatchSources
%iKnow.Metrics.MetricWSAPI.GetMetricId %iKnow.Metrics.MetricWSAPI.GetMetrics %iKnow.Metrics.MetricWSAPI.GetTargets
%iKnow.Metrics.MetricWSAPI.GetTop %iKnow.Metrics.MetricWSAPI.GetValue %iKnow.Metrics.MetricWSAPI.SetValue
%iKnow.Queries.CcWSAPI.GetByEntities %iKnow.Queries.CcWSAPI.GetByEntityIds %iKnow.Queries.CcWSAPI.GetCountByEntities
%iKnow.Queries.CcWSAPI.GetCountByEntityIds %iKnow.Queries.CcWSAPI.GetCountBySource %iKnow.Queries.CcWSAPI.GetFrequency
%iKnow.Queries.CcWSAPI.GetId %iKnow.Queries.CcWSAPI.GetInverse %iKnow.Queries.CcWSAPI.GetSpread
%iKnow.Queries.CcWSAPI.GetValue %iKnow.Queries.CrcWSAPI.GetByEntities %iKnow.Queries.CrcWSAPI.GetByEntityIds
%iKnow.Queries.CrcWSAPI.GetByFilter %iKnow.Queries.CrcWSAPI.GetBySource %iKnow.Queries.CrcWSAPI.GetCountByDomain
%iKnow.Queries.CrcWSAPI.GetCountByEntities %iKnow.Queries.CrcWSAPI.GetCountByEntityIds %iKnow.Queries.CrcWSAPI.GetCountBySource
%iKnow.Queries.CrcWSAPI.GetFrequency %iKnow.Queries.CrcWSAPI.GetId %iKnow.Queries.CrcWSAPI.GetOccurrenceCountBySource
%iKnow.Queries.CrcWSAPI.GetOccurrencesBySource %iKnow.Queries.CrcWSAPI.GetSpread %iKnow.Queries.CrcWSAPI.GetTop
%iKnow.Queries.CrcWSAPI.GetValue %iKnow.Queries.EntityWSAPI.GetByFilter %iKnow.Queries.EntityWSAPI.GetBySource
%iKnow.Queries.EntityWSAPI.GetByStem %iKnow.Queries.EntityWSAPI.GetCountByDomain %iKnow.Queries.EntityWSAPI.GetCountBySource
%iKnow.Queries.EntityWSAPI.GetFrequency %iKnow.Queries.EntityWSAPI.GetId %iKnow.Queries.EntityWSAPI.GetLiteral
%iKnow.Queries.EntityWSAPI.GetNewBySource %iKnow.Queries.EntityWSAPI.GetOccurrenceAttributes %iKnow.Queries.EntityWSAPI.GetOccurrenceCountByDomain
%iKnow.Queries.EntityWSAPI.GetOccurrenceCountBySource %iKnow.Queries.EntityWSAPI.GetOccurrencesById %iKnow.Queries.EntityWSAPI.GetRelated
%iKnow.Queries.EntityWSAPI.GetRelatedById %iKnow.Queries.EntityWSAPI.GetRelatedCount %iKnow.Queries.EntityWSAPI.GetRelatedCountById
%iKnow.Queries.EntityWSAPI.GetSimilar %iKnow.Queries.EntityWSAPI.GetSimilarCounts %iKnow.Queries.EntityWSAPI.GetSpread
%iKnow.Queries.EntityWSAPI.GetStem %iKnow.Queries.EntityWSAPI.GetStemFrequency %iKnow.Queries.EntityWSAPI.GetStemId
%iKnow.Queries.EntityWSAPI.GetStemRepresentationForm %iKnow.Queries.EntityWSAPI.GetStemSpread %iKnow.Queries.EntityWSAPI.GetStemValue
%iKnow.Queries.EntityWSAPI.GetTop %iKnow.Queries.EntityWSAPI.GetTopBM25 %iKnow.Queries.EntityWSAPI.GetTopGroups
%iKnow.Queries.EntityWSAPI.GetTopTFIDF %iKnow.Queries.EntityWSAPI.GetValue %iKnow.Queries.EntityWSAPI.IsAttributed
%iKnow.Queries.EquivWSAPI.CreateSet %iKnow.Queries.EquivWSAPI.DefineTerms %iKnow.Queries.EquivWSAPI.DropSet
%iKnow.Queries.EquivWSAPI.GetTerms %iKnow.Queries.EquivWSAPI.RemoveTerms %iKnow.Queries.MetadataWSAPI.AddField
%iKnow.Queries.MetadataWSAPI.AddListOfValues %iKnow.Queries.MetadataWSAPI.AddLovValue %iKnow.Queries.MetadataWSAPI.CreateFilter
%iKnow.Queries.MetadataWSAPI.GetFieldId %iKnow.Queries.MetadataWSAPI.GetFieldValues %iKnow.Queries.MetadataWSAPI.GetFieldValuesById
%iKnow.Queries.MetadataWSAPI.GetFields %iKnow.Queries.MetadataWSAPI.GetLovValues %iKnow.Queries.MetadataWSAPI.GetLovs
%iKnow.Queries.MetadataWSAPI.GetMetaSpreadByEntities %iKnow.Queries.MetadataWSAPI.GetMetaSpreadByEntityIds %iKnow.Queries.MetadataWSAPI.GetMetaSpreadInternal
%iKnow.Queries.MetadataWSAPI.GetUniValue %iKnow.Queries.MetadataWSAPI.GetUniqueValueCount %iKnow.Queries.MetadataWSAPI.GetUniqueValues
%iKnow.Queries.MetadataWSAPI.GetUniqueValuesById %iKnow.Queries.MetadataWSAPI.GetValue %iKnow.Queries.MetadataWSAPI.GetValueById
%iKnow.Queries.MetadataWSAPI.GetValues %iKnow.Queries.MetadataWSAPI.GetValuesById %iKnow.Queries.MetadataWSAPI.RemoveField
%iKnow.Queries.MetadataWSAPI.RemoveFieldById %iKnow.Queries.MetadataWSAPI.SetValue %iKnow.Queries.MetadataWSAPI.SetValueById
%iKnow.Queries.MetadataWSAPI.UpdateField %iKnow.Queries.MetadataWSAPI.UpdateFieldById %iKnow.Queries.PathWSAPI.GetAttributes
%iKnow.Queries.PathWSAPI.GetByEntities %iKnow.Queries.PathWSAPI.GetByEntityIds %iKnow.Queries.PathWSAPI.GetBySource
%iKnow.Queries.PathWSAPI.GetCountByDomain %iKnow.Queries.PathWSAPI.GetCountByEntities %iKnow.Queries.PathWSAPI.GetCountByEntityIds
%iKnow.Queries.PathWSAPI.GetCountBySource %iKnow.Queries.PathWSAPI.GetEntities %iKnow.Queries.PathWSAPI.GetId
%iKnow.Queries.PathWSAPI.GetPathId %iKnow.Queries.PathWSAPI.GetSentenceId %iKnow.Queries.PathWSAPI.GetSourceId
%iKnow.Queries.PathWSAPI.GetValue %iKnow.Queries.SentenceWSAPI.GetAttributes %iKnow.Queries.SentenceWSAPI.GetByCrcIds
%iKnow.Queries.SentenceWSAPI.GetByCrcMask %iKnow.Queries.SentenceWSAPI.GetByCrcs %iKnow.Queries.SentenceWSAPI.GetByEntities
%iKnow.Queries.SentenceWSAPI.GetByEntityIds %iKnow.Queries.SentenceWSAPI.GetByPathIds %iKnow.Queries.SentenceWSAPI.GetBySource
%iKnow.Queries.SentenceWSAPI.GetCountByCrcIds %iKnow.Queries.SentenceWSAPI.GetCountByCrcMask %iKnow.Queries.SentenceWSAPI.GetCountByCrcs
%iKnow.Queries.SentenceWSAPI.GetCountByDomain %iKnow.Queries.SentenceWSAPI.GetCountByEntities %iKnow.Queries.SentenceWSAPI.GetCountByEntityIds
%iKnow.Queries.SentenceWSAPI.GetCountByPathIds %iKnow.Queries.SentenceWSAPI.GetCountBySource %iKnow.Queries.SentenceWSAPI.GetLanguage
%iKnow.Queries.SentenceWSAPI.GetNewBySource %iKnow.Queries.SentenceWSAPI.GetPartLiteral %iKnow.Queries.SentenceWSAPI.GetParts
%iKnow.Queries.SentenceWSAPI.GetPosition %iKnow.Queries.SentenceWSAPI.GetSourceId %iKnow.Queries.SentenceWSAPI.GetValue
%iKnow.Queries.SourceWSAPI.GetAttributes %iKnow.Queries.SourceWSAPI.GetByCrcIds %iKnow.Queries.SourceWSAPI.GetByCrcMask
%iKnow.Queries.SourceWSAPI.GetByCrcs %iKnow.Queries.SourceWSAPI.GetByDomain %iKnow.Queries.SourceWSAPI.GetByEntities
%iKnow.Queries.SourceWSAPI.GetByEntityIds %iKnow.Queries.SourceWSAPI.GetByEquivalentIds %iKnow.Queries.SourceWSAPI.GetByEquivalents
%iKnow.Queries.SourceWSAPI.GetByPathIds %iKnow.Queries.SourceWSAPI.GetCountByCrcIds %iKnow.Queries.SourceWSAPI.GetCountByCrcMask
%iKnow.Queries.SourceWSAPI.GetCountByCrcs %iKnow.Queries.SourceWSAPI.GetCountByDomain %iKnow.Queries.SourceWSAPI.GetCountByEntities
%iKnow.Queries.SourceWSAPI.GetCountByEntityIds %iKnow.Queries.SourceWSAPI.GetCountByPathIds %iKnow.Queries.SourceWSAPI.GetExternalId
%iKnow.Queries.SourceWSAPI.GetFullReference %iKnow.Queries.SourceWSAPI.GetLanguages %iKnow.Queries.SourceWSAPI.GetSimilar
%iKnow.Queries.SourceWSAPI.GetSourceId %iKnow.Queries.SourceWSAPI.GetSummary %iKnow.Queries.SourceWSAPI.GetSummaryDirect
%iKnow.Queries.SourceWSAPI.GetSummaryForText %iKnow.Queries.SourceWSAPI.GetTopLanguage %iKnow.Semantics.DominanceWSAPI.GetAggregateOverlaps
%iKnow.Semantics.DominanceWSAPI.GetBreakingSources %iKnow.Semantics.DominanceWSAPI.GetBySource %iKnow.Semantics.DominanceWSAPI.GetCountBySource
%iKnow.Semantics.DominanceWSAPI.GetCountBySourceInternal %iKnow.Semantics.DominanceWSAPI.GetDomainValue %iKnow.Semantics.DominanceWSAPI.GetOverlap
%iKnow.Semantics.DominanceWSAPI.GetOverlapDetails %iKnow.Semantics.DominanceWSAPI.GetProfileByDomain %iKnow.Semantics.DominanceWSAPI.GetProfileBySource
%iKnow.Semantics.DominanceWSAPI.GetProfileCountByDomain %iKnow.Semantics.DominanceWSAPI.GetProfileCountBySource %iKnow.Semantics.DominanceWSAPI.GetSourceValue
%iKnow.Semantics.DominanceWSAPI.GetSourcesByCorrelation %iKnow.Semantics.DominanceWSAPI.GetTop %iKnow.Semantics.DominanceWSAPI.GetTypicalSources
%iKnow.Semantics.ProximityWSAPI.GetClustersBySource %iKnow.Semantics.ProximityWSAPI.GetProfile %iKnow.Semantics.ProximityWSAPI.GetProfileById
%iKnow.Semantics.ProximityWSAPI.GetProfileBySource %iKnow.Semantics.ProximityWSAPI.GetProfileBySourceId %iKnow.Semantics.ProximityWSAPI.GetProfileForEntity
%iKnow.Utils.MaintenanceWSAPI.AddEntityToSkipList %iKnow.Utils.MaintenanceWSAPI.AddStringToSkipList %iKnow.Utils.MaintenanceWSAPI.AddUserDictionaryEntry
%iKnow.Utils.MaintenanceWSAPI.ClearSkipList %iKnow.Utils.MaintenanceWSAPI.CreateSkipList %iKnow.Utils.MaintenanceWSAPI.CreateUserDictionary
%iKnow.Utils.MaintenanceWSAPI.DropSkipList %iKnow.Utils.MaintenanceWSAPI.DropUserDictionary %iKnow.Utils.MaintenanceWSAPI.GetSkipListElements
%iKnow.Utils.MaintenanceWSAPI.GetSkipListId %iKnow.Utils.MaintenanceWSAPI.GetSkipLists %iKnow.Utils.MaintenanceWSAPI.GetUserDictionaries
%iKnow.Utils.MaintenanceWSAPI.GetUserDictionaryEntries %iKnow.Utils.MaintenanceWSAPI.GetUserDictionaryId %iKnow.Utils.MaintenanceWSAPI.HasSkipLists
%iKnow.Utils.MaintenanceWSAPI.RemoveEntityFromSkipList %iKnow.Utils.MaintenanceWSAPI.RemoveStringFromSkipList %iKnow.Utils.MaintenanceWSAPI.RemoveUserDictionaryEntry
%iKnow.Utils.MaintenanceWSAPI.SkipListContainsElement %iKnow.Utils.MaintenanceWSAPI.SkipListContainsString EnsLib.EDI.X12.Service.SOAPService.Send
EnsLib.ebXML.Service.SOAPService.Manifest

Parameters

• parameter XMLMSGDESCRIPTOR = 1;
Indicate that extra methods are to be generated for %XML.MsgDescriptor class.
This parameter is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this parameter.

Properties

• property %ResponseName as %String(XMLPROJECTION="NONE");
The name of the response to the SOAP operation being implemented.

Methods

• method InvokeService(%Service As %SOAP.WebService)
Execute Web Method represented by this class and XMLExport result. This method is invoked by the web service class. In turn, this method invokes:

  • OnPreWebMethod()
  • the web method
  • OnPostWebMethod()

Note that OnPostWebMethod() always gets run, even if there was an error.
• method ProcessHTTP() as %Status
Copy %request data to the properties of this class.

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.