ProximityWSAPI Class Reference

Inheritance diagram for ProximityWSAPI:

Collaboration diagram for ProximityWSAPI:

Static Public Member Functions
_.XML.DataSet	GetProfile (_.Library.Integer pDomainId, _.Library.String pEntity, _.Library.Integer pPage, _.Library.Integer pPageSize, _.Library.String pFilter, _.Library.ListOfDataTypes pSkipListIDs, _.Library.Boolean pUseStems)
_.XML.DataSet	GetProfileById (_.Library.Integer pDomainId, _.Library.Integer pEntUniId, _.Library.Integer pPage, _.Library.Integer pPageSize, _.Library.String pFilter, _.Library.ListOfDataTypes pSkipListIDs, _.Library.Boolean pUseStems)
	Returns the proximity profile for the entity represented by pEntUniId. More...
_.XML.DataSet	GetProfileBySource (_.Library.Integer pDomainId, _.Library.String pEntity, _.Library.String pExternalId, _.Library.Integer pPage, _.Library.Integer pPageSize)
	Returns the proximity profile for a given entity pEntity in source pExtId. More...
_.XML.DataSet	GetProfileBySourceId (_.Library.Integer pDomainId, _.Library.Integer pEntUniId, _.Library.Integer pSrcId, _.Library.Integer pPage, _.Library.Integer pPageSize)
	Returns the proximity profile for a given entity identified by pEntUniId in source pSrcId. More...

Static Public Attributes
	NAMESPACE = None

Detailed Description

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Semantics.ProximityAPI</class>, exposed as WebMethod methods.

See the classdocs for <class>iKnow.Semantics.ProximityAPI</class> for more information.

Member Function Documentation

GetProfile()

_.XML.DataSet GetProfile ( _.Library.Integer  pDomainId, _.Library.String  pEntity, _.Library.Integer  pPage, _.Library.Integer  pPageSize, _.Library.String  pFilter, _.Library.ListOfDataTypes  pSkipListIDs, _.Library.Boolean  pUseStems  )

static

Returns the proximity profile for the entity or list of entities supplied through

pEntity. This profile is calculated based on the aggregated distance to pEntity entries in all paths in the domain (when pFilter=""), optionally constrained to all paths in a specific set of sources (when pFilter!="").

When setting pUseStems to 1, for a domain that has stemming enabled, the scope of the profile will be expanded to include all actual forms of the supplied pEntity (which has to be provided as a base form (stem)!), and their combined proximity profiles will be grouped to the stem level again.

GetProfileById()

_.XML.DataSet GetProfileById ( _.Library.Integer  pDomainId, _.Library.Integer  pEntUniId, _.Library.Integer  pPage, _.Library.Integer  pPageSize, _.Library.String  pFilter, _.Library.ListOfDataTypes  pSkipListIDs, _.Library.Boolean  pUseStems  )

static

Returns the proximity profile for the entity represented by pEntUniId.

See also <method>GetProfile</method>

When setting pUseStems to 1, the value of pEntUniId will be interpreted as a stem ID.

GetProfileBySource()

_.XML.DataSet GetProfileBySource ( _.Library.Integer  pDomainId, _.Library.String  pEntity, _.Library.String  pExternalId, _.Library.Integer  pPage, _.Library.Integer  pPageSize  )

static

Returns the proximity profile for a given entity pEntity in source pExtId.

See also <method>GetProfile</method> for a broader set of options.

GetProfileBySourceId()

_.XML.DataSet GetProfileBySourceId ( _.Library.Integer  pDomainId, _.Library.Integer  pEntUniId, _.Library.Integer  pSrcId, _.Library.Integer  pPage, _.Library.Integer  pPageSize  )

static

Returns the proximity profile for a given entity identified by pEntUniId in source pSrcId.

See also <method>GetProfile</method> for a broader set of options.

Member Data Documentation

NAMESPACE

NAMESPACE = None

static

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Semantics.ProximityAPI</class>, exposed as WebMethod methods.

See the classdocs for <class>iKnow.Semantics.ProximityAPI</class> for more information.