API Docs for: 1.3.12
Show:

InquiryPacket Class

Data structure used to hold data relevant to a request to determine the competence of an individual. (hereafter, "Inquiry")

Methods

allChildPacketsUnknown

() Boolean

Returns true if all child packets have unknown results.

Returns:

Boolean:

allChildPacketsUnknown

() Boolean

Returns true if all child packets have unknown results.

Returns:

Boolean:

allEquivalentPacketsFalseOrUnknown

() Boolean

Returns true if all equivalent packets have the false or unknown result.

Returns:

Boolean:

allEquivalentPacketsTrueOrUnknown

() Boolean

Returns true if all equivalent packets have the true or unknown result.

Returns:

Boolean:

allEquivalentPacketsUnknown

() Boolean

Returns true if all equivalent packets have unknown results.

Returns:

Boolean:

allSubPacketsTrueOrUnknown

() Boolean

Returns true if all sub packets have the true or unknown result.

Returns:

Boolean:

anyChildPacketsAreFalse

() Boolean

Returns true if any child packets have false results.

Returns:

Boolean:

anyChildPacketsAreTrue

() Boolean

Returns true if any child packets have true results.

Returns:

Boolean:

anyChildPacketsAreUnknown

() Boolean

Returns true if any child packets have unknown results.

Returns:

Boolean:

anyIndeterminantChildPackets

() Boolean

Returns true if any child packets have an indeterminate result.

Returns:

Boolean:

Properties

ask

String function(string)

Callback if this inquiry requires additional information to proceed.

competency

EcCompetency[]

Competency that this packet is inquiring about. May be multiple competencies that are either collapsed due to an inference loop, or are equivalent to one another.

context

EcFramework

Framework that this inquiry is scoped to.

dateCreated

Number

Datetime representing when this packet was created.

equivalentPackets

InquiryPacket[]

Packets that are equivalent to this packet. May be used when equivalence is best represented with additional packets.

failure

Function(string)

Callback if this inquiry fails.

finished

Boolean

Set to true if this packet has completed processing.

hasCheckedAssertionsForCompetency

Boolean

Mark true when assertions have been retrieved for this packet.

hasCheckedRelationshipsForCompetency

Boolean

Mark true when relations have been processed for this packet.

hasCheckedRollupRulesForCompetency

Boolean

Mark true when rollup rules have been processed for this packet.

level

EcLevel[]

Level that the competency is being measured at. May have multiple levels referring to multiple competencies due to cycles or equivalence.

log

String

Local log for this inquiry packet.

negative

EcAssertion

Assertions (direct or indirect) that contribute to a negative result.

numberOfQueriesRunning

Integer

Async counter to keep track of number of unresolved processes.

positive

EcAssertion

Assertions (direct or indirect) that contribute to a positive result.

result

ResultType

Result as a ResultType. ResultType is an autogenerated Enum object, and result._name may match "TRUE", "FALSE", "UNKNOWN", "INDETERMINANT"

rule

String

Rollup Rule search string. (if IPType == ROLLUPRULE)

stageOneFinished

Boolean

Set to true if this packet has finished stage one.

subject

EcPk[]

One or more identifiers that identify an individual.

subPackets

InquiryPacket[]

Packets that assist in determining the state of this packet.

success

Function(InquiryPacket)

Callback when this and all child inquiries have successfully reached a conclusion.

type

IPType

Type of inquiry packet. Inquiry packets can represent relational logic, rollup logic or competencies.