com.pega.pegarules.pub.util

Interface SearchResult

public interface SearchResult

Data structure to hold search results for a single rule that matches the string search criteria.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAvailability() Retrieves availability information for a single rule that matches the search criteria
java.lang.String	getRuleClass() Retrieves the pxObjClass for a single rule that matches the search criteria
java.lang.String	getRuleInsKey() Retrieves the rule pzInsKey of a single rule that matches the search criteria
java.lang.String	getRuleInsName() Retrieves pzInsName for a single rule that matches the search criteria
java.lang.String	getRuleName() Retrieves pyRuleName for a single rule that matches the search criteria
java.lang.String	getRuleset() Retrieves the ruleset of a single rule that matches the search criteria
java.lang.String	getRulesetVersion() Retrieves the ruleset version of a single rule that matches the search criteria
java.lang.String	getScore() Retrieves the search score
java.lang.String	getUpdatedBy() Retrieves updated by information for a single rule that matches the search criteria
java.lang.String	getUpdatedOn() Retrieves updated on information for a single rule that matches the search criteria
java.lang.String	getWorkClass() Retrieves the pxObjClass for the work object that matches the search criteria
java.lang.String	getWorkCreatedOn() Retrieves the work object creation date that matches the search criteria
java.lang.String	getWorkId() Retrieves the pyID of the work object that matches the search criteria
java.lang.String	getWorkLabel() Retrieves the label of work object that matches the search criteria
java.lang.String	getWorkOriginator() Retrieves the originator for the work object that matches the search criteria
java.lang.String	getWorkStatus() Retrieves the status of the work object that matches the search criteria

Field Detail

VERSION

static final java.lang.String VERSION

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Method Detail

getScore

java.lang.String getScore()

Retrieves the search score

Returns:

result

getRuleset

java.lang.String getRuleset()

Retrieves the ruleset of a single rule that matches the search criteria

Returns:

String ruleset

getRulesetVersion

java.lang.String getRulesetVersion()

Retrieves the ruleset version of a single rule that matches the search criteria

Returns:

String ruleset version

getRuleInsKey

java.lang.String getRuleInsKey()

Retrieves the rule pzInsKey of a single rule that matches the search criteria

Returns:

String rule's instance key

getAvailability

java.lang.String getAvailability()

Retrieves availability information for a single rule that matches the search criteria

Returns:

Returns the availability.

getRuleInsName

java.lang.String getRuleInsName()

Retrieves pzInsName for a single rule that matches the search criteria

Returns:

Returns the ruleInsName.

getRuleName

java.lang.String getRuleName()

Retrieves pyRuleName for a single rule that matches the search criteria

Returns:

Returns the ruleName.

getUpdatedBy

java.lang.String getUpdatedBy()

Retrieves updated by information for a single rule that matches the search criteria

Returns:

Returns the updatedBy.

getUpdatedOn

java.lang.String getUpdatedOn()

Retrieves updated on information for a single rule that matches the search criteria

Returns:

Returns the updatedOn.

getRuleClass

java.lang.String getRuleClass()

Retrieves the pxObjClass for a single rule that matches the search criteria

Returns:

the pxObjClass of the matched record.

getWorkClass

java.lang.String getWorkClass()

Retrieves the pxObjClass for the work object that matches the search criteria

Returns:

the pxObjClass of the matched record.

getWorkCreatedOn

java.lang.String getWorkCreatedOn()

Retrieves the work object creation date that matches the search criteria

Returns:

the creation date of the work object.

getWorkId

java.lang.String getWorkId()

Retrieves the pyID of the work object that matches the search criteria

Returns:

the pyID of the matched record

getWorkLabel

java.lang.String getWorkLabel()

Retrieves the label of work object that matches the search criteria

Returns:

the value of the pyLabel property of the work object.

getWorkOriginator

java.lang.String getWorkOriginator()

Retrieves the originator for the work object that matches the search criteria

Returns:

the pyOrigUserID property of the work object.

getWorkStatus

java.lang.String getWorkStatus()

Retrieves the status of the work object that matches the search criteria

Returns:

the pyStatusWork property of the work object.