[ { "__docId__": 1, "kind": "external", "name": "Infinity", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Infinity", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Infinity", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 2, "kind": "external", "name": "NaN", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NaN", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~NaN", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 3, "kind": "external", "name": "undefined", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~undefined", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 4, "kind": "external", "name": "null", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~null", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 5, "kind": "external", "name": "Object", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Object", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 6, "kind": "external", "name": "object", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~object", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 7, "kind": "external", "name": "Function", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Function", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 8, "kind": "external", "name": "function", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~function", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 9, "kind": "external", "name": "Boolean", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Boolean", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 10, "kind": "external", "name": "boolean", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~boolean", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 11, "kind": "external", "name": "Symbol", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Symbol", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 12, "kind": "external", "name": "Error", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Error", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 13, "kind": "external", "name": "EvalError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~EvalError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 14, "kind": "external", "name": "InternalError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/InternalError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~InternalError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 15, "kind": "external", "name": "RangeError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~RangeError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 16, "kind": "external", "name": "ReferenceError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~ReferenceError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 17, "kind": "external", "name": "SyntaxError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~SyntaxError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 18, "kind": "external", "name": "TypeError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~TypeError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 19, "kind": "external", "name": "URIError", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~URIError", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 20, "kind": "external", "name": "Number", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Number", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 21, "kind": "external", "name": "number", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~number", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 22, "kind": "external", "name": "Date", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Date", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 23, "kind": "external", "name": "String", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~String", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 24, "kind": "external", "name": "string", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~string", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 25, "kind": "external", "name": "RegExp", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~RegExp", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 26, "kind": "external", "name": "Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 27, "kind": "external", "name": "Int8Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Int8Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 28, "kind": "external", "name": "Uint8Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Uint8Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 29, "kind": "external", "name": "Uint8ClampedArray", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Uint8ClampedArray", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 30, "kind": "external", "name": "Int16Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Int16Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 31, "kind": "external", "name": "Uint16Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Uint16Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 32, "kind": "external", "name": "Int32Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Int32Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 33, "kind": "external", "name": "Uint32Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Uint32Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 34, "kind": "external", "name": "Float32Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Float32Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 35, "kind": "external", "name": "Float64Array", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Float64Array", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 36, "kind": "external", "name": "Map", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Map", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 37, "kind": "external", "name": "Set", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Set", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 38, "kind": "external", "name": "WeakMap", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~WeakMap", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 39, "kind": "external", "name": "WeakSet", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~WeakSet", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 40, "kind": "external", "name": "ArrayBuffer", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~ArrayBuffer", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 41, "kind": "external", "name": "DataView", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~DataView", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 42, "kind": "external", "name": "JSON", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~JSON", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 43, "kind": "external", "name": "Promise", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Promise", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 44, "kind": "external", "name": "Generator", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Generator", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 45, "kind": "external", "name": "GeneratorFunction", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/GeneratorFunction", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~GeneratorFunction", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 46, "kind": "external", "name": "Reflect", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Reflect", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Reflect", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 47, "kind": "external", "name": "Proxy", "externalLink": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy", "memberof": "src/.external-ecmascript.js", "static": true, "longname": "src/.external-ecmascript.js~Proxy", "access": "public", "description": "", "builtinExternal": true }, { "__docId__": 48, "kind": "file", "name": "src/PVBidContext.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/PVBidContext.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 49, "kind": "class", "name": "PVBidContext", "memberof": "src/PVBidContext.js", "static": true, "longname": "src/PVBidContext.js~PVBidContext", "access": "public", "export": true, "importPath": "pvbid-sdk/src/PVBidContext.js", "importStyle": "PVBidContext", "description": "", "lineNumber": 31, "unknown": [ { "tagName": "@class", "tagValue": "PVBid.PVBidContext" } ], "interface": false }, { "__docId__": 50, "kind": "constructor", "name": "constructor", "memberof": "src/PVBidContext.js~PVBidContext", "generator": false, "async": false, "static": false, "longname": "src/PVBidContext.js~PVBidContext#constructor", "access": "public", "description": "Creates an instance of PVBidContext.", "lineNumber": 38, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "config", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "config.token", "description": "The auth token to access account data.." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "https://api.pvbid.com/v2", "defaultRaw": "https://api.pvbid.com/v2", "name": "config.base_uri", "description": "" } ] }, { "__docId__": 51, "kind": "member", "name": "user", "memberof": "src/PVBidContext.js~PVBidContext", "static": false, "longname": "src/PVBidContext.js~PVBidContext#user", "access": "public", "description": "The current authorized user.\n{@link PVBidContext.loadAuthorizedUser} must get called first.", "lineNumber": 49, "type": { "nullable": null, "types": [ "User" ], "spread": false, "description": null } }, { "__docId__": 52, "kind": "member", "name": "_httpConfig", "memberof": "src/PVBidContext.js~PVBidContext", "static": false, "longname": "src/PVBidContext.js~PVBidContext#_httpConfig", "access": "private", "description": null, "lineNumber": 51, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 53, "kind": "member", "name": "_token", "memberof": "src/PVBidContext.js~PVBidContext", "static": false, "longname": "src/PVBidContext.js~PVBidContext#_token", "access": "private", "description": null, "lineNumber": 52, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 54, "kind": "member", "name": "repositories", "memberof": "src/PVBidContext.js~PVBidContext", "static": false, "longname": "src/PVBidContext.js~PVBidContext#repositories", "access": "public", "description": "A property that provides quick access to initialized repositories.", "lineNumber": 84, "params": [ { "nullable": null, "types": [ "ProjectRepository" ], "spread": false, "optional": false, "name": "projects", "description": "" }, { "nullable": null, "types": [ "BidRepository" ], "spread": false, "optional": false, "name": "bids", "description": "" }, { "nullable": null, "types": [ "ProjectStatusRepository" ], "spread": false, "optional": false, "name": "projectStatuses", "description": "" }, { "nullable": null, "types": [ "SnapshotRepository" ], "spread": false, "optional": false, "name": "snapshots", "description": "" }, { "nullable": null, "types": [ "AssemblyRepository" ], "spread": false, "optional": false, "name": "assemblies", "description": "" }, { "nullable": null, "types": [ "TagRepository" ], "spread": false, "optional": false, "name": "tags", "description": "" }, { "nullable": null, "types": [ "UserRepository" ], "spread": false, "optional": false, "name": "users", "description": "" }, { "nullable": null, "types": [ "LineItemRepository" ], "spread": false, "optional": false, "name": "lineItems", "description": "" }, { "nullable": null, "types": [ "MetricRepository" ], "spread": false, "optional": false, "name": "metrics", "description": "" }, { "nullable": null, "types": [ "FieldRepository" ], "spread": false, "optional": false, "name": "fields", "description": "" }, { "nullable": null, "types": [ "PredictionModelRepository" ], "spread": false, "optional": false, "name": "predictionModels", "description": "" }, { "nullable": null, "types": [ "IndustryWidePredictionModelRepository" ], "spread": false, "optional": false, "name": "industryWidePredictionModels", "description": "" }, { "nullable": null, "types": [ "DatatableRepository" ], "spread": false, "optional": false, "name": "datatables", "description": "" }, { "nullable": null, "types": [ "AssemblyDefRepository" ], "spread": false, "optional": false, "name": "assemblyDefs", "description": "" }, { "nullable": null, "types": [ "FieldDefRepository" ], "spread": false, "optional": false, "name": "fieldDefs", "description": "" }, { "nullable": null, "types": [ "MetricDefRepository" ], "spread": false, "optional": false, "name": "metricDefs", "description": "" }, { "nullable": null, "types": [ "LineItemDefRepository" ], "spread": false, "optional": false, "name": "lineItemDefs", "description": "" }, { "nullable": null, "types": [ "DatatableDefRepository" ], "spread": false, "optional": false, "name": "datatableDefs", "description": "" }, { "nullable": null, "types": [ "ComponentDefRepository" ], "spread": false, "optional": false, "name": "componentDefs", "description": "" }, { "nullable": null, "types": [ "ComponentGroupDefRepository" ], "spread": false, "optional": false, "name": "componentGroupDefs", "description": "" }, { "nullable": null, "types": [ "FieldGroupDefRepository" ], "spread": false, "optional": false, "name": "fieldGroupDefs", "description": "" }, { "nullable": null, "types": [ "DynamicGroupRepository" ], "spread": false, "optional": false, "name": "dynamicGroups", "description": "" } ], "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 55, "kind": "method", "name": "getProject", "memberof": "src/PVBidContext.js~PVBidContext", "generator": false, "async": true, "static": false, "longname": "src/PVBidContext.js~PVBidContext#getProject", "access": "public", "description": "Gets an initiated {@link Project} instance with included bids.", "lineNumber": 119, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "projectId", "description": "The project id in which to retrieve." }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "options.allowCache", "description": "Flags system to use cache if available." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.loadBidEntities", "description": "Flag to load the bid entities with the bids. If false, the entities may be loaded later with bid.load()." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 56, "kind": "method", "name": "getVirtualProjectClone", "memberof": "src/PVBidContext.js~PVBidContext", "generator": false, "async": false, "static": false, "longname": "src/PVBidContext.js~PVBidContext#getVirtualProjectClone", "access": "public", "description": "Create a virtual clone of a project.\nFor safety, any methods involving repositories or peristance are absent in the clone.", "lineNumber": 138, "params": [ { "nullable": null, "types": [ "Project" ], "spread": false, "optional": false, "name": "project", "description": "The project to make a virtual clone of." }, { "nullable": null, "types": [ "number[]" ], "spread": false, "optional": true, "name": "bidIds", "description": "Optionally limit the bids that will be cloned into the virtual project. Helps with performance." } ], "return": { "nullable": null, "types": [ "Project" ], "spread": false, "description": "" } }, { "__docId__": 57, "kind": "method", "name": "loadAuthorizedUser", "memberof": "src/PVBidContext.js~PVBidContext", "generator": false, "async": true, "static": false, "longname": "src/PVBidContext.js~PVBidContext#loadAuthorizedUser", "access": "public", "description": "Loads the authorized user for this context. Calling {@link PVBidContext.getProject} auto loads the authorized user.", "lineNumber": 147, "unknown": [ { "tagName": "@returns", "tagValue": " {Promise}" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 59, "kind": "file", "name": "src/ProjectLoader.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/ProjectLoader.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 60, "kind": "class", "name": "ProjectLoader", "memberof": "src/ProjectLoader.js", "static": true, "longname": "src/ProjectLoader.js~ProjectLoader", "access": "public", "export": true, "importPath": "pvbid-sdk/src/ProjectLoader.js", "importStyle": "ProjectLoader", "description": "This class serves to quickly load a {@link Project} instance with included {@link Bid}s", "lineNumber": 11, "unknown": [ { "tagName": "@class", "tagValue": "ProjectLoader" } ], "interface": false }, { "__docId__": 61, "kind": "constructor", "name": "constructor", "memberof": "src/ProjectLoader.js~ProjectLoader", "generator": false, "async": false, "static": false, "longname": "src/ProjectLoader.js~ProjectLoader#constructor", "access": "public", "description": "Creates an instance of ProjectLoader.", "lineNumber": 16, "params": [ { "nullable": null, "types": [ "PVBidContext" ], "spread": false, "optional": false, "name": "pvbidContext", "description": "" } ] }, { "__docId__": 62, "kind": "member", "name": "context", "memberof": "src/ProjectLoader.js~ProjectLoader", "static": false, "longname": "src/ProjectLoader.js~ProjectLoader#context", "access": "public", "description": null, "lineNumber": 17, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 63, "kind": "method", "name": "load", "memberof": "src/ProjectLoader.js~ProjectLoader", "generator": false, "async": true, "static": false, "longname": "src/ProjectLoader.js~ProjectLoader#load", "access": "public", "description": "Loads a project and bid instances.", "lineNumber": 28, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "projectId", "description": "The id of the project to be loaded" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "options", "description": "Loading options" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.loadBidEntities", "description": "Determines if the bids should be loaded with their entities. They can be loaded later with bid.load() if" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 64, "kind": "method", "name": "loadVirtualClone", "memberof": "src/ProjectLoader.js~ProjectLoader", "generator": false, "async": false, "static": false, "longname": "src/ProjectLoader.js~ProjectLoader#loadVirtualClone", "access": "public", "description": "Generate a new project instance based on the original data from the given project.\nFor safety, any methods involving repositories or persistance are absent in the clone.", "lineNumber": 69, "params": [ { "nullable": null, "types": [ "Project" ], "spread": false, "optional": false, "name": "project", "description": "The project instance to make a virtual clone of." }, { "nullable": null, "types": [ "number[]" ], "spread": false, "optional": false, "name": "bidIds", "description": "Optionally limit the bids that get cloned into the virtual project clone by giving their IDs here." } ], "return": { "nullable": null, "types": [ "Project" ], "spread": false, "description": "" } }, { "__docId__": 65, "kind": "method", "name": "_loadVirtualBids", "memberof": "src/ProjectLoader.js~ProjectLoader", "generator": false, "async": false, "static": false, "longname": "src/ProjectLoader.js~ProjectLoader#_loadVirtualBids", "access": "private", "description": "Generates virtual bid clones for the virtual project clone.", "lineNumber": 98, "params": [ { "nullable": null, "types": [ "Bid[]" ], "spread": false, "optional": false, "name": "originalBids", "description": "Bid instances from the original project" }, { "nullable": null, "types": [ "Project" ], "spread": false, "optional": false, "name": "virtualProject", "description": "The virtual project clone to attach bid clones too" } ], "return": { "nullable": null, "types": [ "Bid[]" ], "spread": false, "description": "Clones of the given bids" }, "ignore": true }, { "__docId__": 66, "kind": "file", "name": "src/domain/Assembly.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/Assembly.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 67, "kind": "class", "name": "Assembly", "memberof": "src/domain/Assembly.js", "static": true, "longname": "src/domain/Assembly.js~Assembly", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/Assembly.js", "importStyle": "Assembly", "description": "Assembly Class", "lineNumber": 7, "interface": false, "extends": [ "src/domain/BidEntity.js~BidEntity" ] }, { "__docId__": 68, "kind": "constructor", "name": "constructor", "memberof": "src/domain/Assembly.js~Assembly", "generator": false, "async": false, "static": false, "longname": "src/domain/Assembly.js~Assembly#constructor", "access": "public", "description": "Creates an instance of Assembly.", "lineNumber": 13, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "assemblyData", "description": "" }, { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ] }, { "__docId__": 69, "kind": "member", "name": "bid", "memberof": "src/domain/Assembly.js~Assembly", "static": false, "longname": "src/domain/Assembly.js~Assembly#bid", "access": "public", "description": "Reference to the bid that the assembly belongs to.", "lineNumber": 19, "type": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": null } }, { "__docId__": 70, "kind": "member", "name": "_data", "memberof": "src/domain/Assembly.js~Assembly", "static": false, "longname": "src/domain/Assembly.js~Assembly#_data", "access": "private", "description": null, "lineNumber": 20, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 71, "kind": "member", "name": "_fieldIdsKeyedByAnchor", "memberof": "src/domain/Assembly.js~Assembly", "static": false, "longname": "src/domain/Assembly.js~Assembly#_fieldIdsKeyedByAnchor", "access": "private", "description": null, "lineNumber": 21, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 72, "kind": "method", "name": "removeBidEntity", "memberof": "src/domain/Assembly.js~Assembly", "generator": false, "async": false, "static": false, "longname": "src/domain/Assembly.js~Assembly#removeBidEntity", "access": "public", "description": "Removes a bid entity from the assembly.", "lineNumber": 30, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "" }, { "nullable": null, "types": [ "number", "string" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": null }, { "__docId__": 74, "kind": "method", "name": "getFieldByAnchor", "memberof": "src/domain/Assembly.js~Assembly", "generator": false, "async": false, "static": false, "longname": "src/domain/Assembly.js~Assembly#getFieldByAnchor", "access": "public", "description": "Find a field by its anchor value. Returns undefined if a match is not found.", "lineNumber": 47, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "anchor", "description": "" } ], "return": { "nullable": null, "types": [ "Field", "undefined" ], "spread": false, "description": "" } }, { "__docId__": 75, "kind": "method", "name": "_keyFieldIdsByAnchor", "memberof": "src/domain/Assembly.js~Assembly", "generator": false, "async": false, "static": false, "longname": "src/domain/Assembly.js~Assembly#_keyFieldIdsByAnchor", "access": "private", "description": "Get the fields that have anchors keyed by their anchors", "lineNumber": 58, "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "Field IDs keyed by anchor value" }, "ignore": true, "params": [] }, { "__docId__": 76, "kind": "get", "name": "config", "memberof": "src/domain/Assembly.js~Assembly", "generator": false, "async": false, "static": false, "longname": "src/domain/Assembly.js~Assembly#config", "access": "public", "description": "", "lineNumber": 74, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 77, "kind": "get", "name": "definitionId", "memberof": "src/domain/Assembly.js~Assembly", "generator": false, "async": false, "static": false, "longname": "src/domain/Assembly.js~Assembly#definitionId", "access": "public", "description": "", "lineNumber": 81, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 78, "kind": "method", "name": "dirty", "memberof": "src/domain/Assembly.js~Assembly", "generator": false, "async": false, "static": false, "longname": "src/domain/Assembly.js~Assembly#dirty", "access": "public", "description": "Flags the assembly and corresponding bid as dirty and to be saved.", "lineNumber": 88, "params": [], "return": null }, { "__docId__": 79, "kind": "file", "name": "src/domain/Bid.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/Bid.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 80, "kind": "class", "name": "Bid", "memberof": "src/domain/Bid.js", "static": true, "longname": "src/domain/Bid.js~Bid", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/Bid.js", "importStyle": "Bid", "description": "Bids are self assessing classes representing the totality of a bid estimate.\nA bid contains collections of the following type of {@link BidEntity}s:\n{@link LineItem}, {@link Metric}, {@link Field}, {@link Component}, {@link Datatable},\n{@link Assembly}, {@link FieldGroup}, {@link ComponentGroup}.", "lineNumber": 21, "interface": false, "extends": [ "src/domain/BidEntity.js~BidEntity" ] }, { "__docId__": 81, "kind": "constructor", "name": "constructor", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#constructor", "access": "public", "description": "Creates an instance of Bid.", "lineNumber": 27, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "bidData", "description": "" }, { "nullable": null, "types": [ "BidService" ], "spread": false, "optional": false, "name": "bidService", "description": "" } ] }, { "__docId__": 82, "kind": "member", "name": "_isLoaded", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_isLoaded", "access": "private", "description": null, "lineNumber": 29, "undocument": true, "ignore": true, "type": { "types": [ "boolean" ] } }, { "__docId__": 83, "kind": "member", "name": "_calcRounds", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_calcRounds", "access": "private", "description": null, "lineNumber": 30, "undocument": true, "ignore": true, "type": { "types": [ "number" ] } }, { "__docId__": 84, "kind": "member", "name": "_data", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_data", "access": "private", "description": null, "lineNumber": 31, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 85, "kind": "member", "name": "_bidService", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_bidService", "access": "private", "description": null, "lineNumber": 32, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 86, "kind": "member", "name": "maxEvents", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#maxEvents", "access": "public", "description": null, "lineNumber": 33, "undocument": true, "type": { "types": [ "number" ] } }, { "__docId__": 87, "kind": "member", "name": "_cacheValues", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_cacheValues", "access": "private", "description": null, "lineNumber": 34, "undocument": true, "ignore": true, "type": { "types": [ "{}" ] } }, { "__docId__": 88, "kind": "member", "name": "entities", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#entities", "access": "public", "description": "", "lineNumber": 39, "type": { "nullable": null, "types": [ "BidEntityRelationsHelper" ], "spread": false, "description": null } }, { "__docId__": 89, "kind": "member", "name": "_indicativePricingHelper", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_indicativePricingHelper", "access": "private", "description": "", "lineNumber": 44, "type": { "nullable": null, "types": [ "IndicativePricingHelper" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 90, "kind": "member", "name": "_wattMetricDef", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_wattMetricDef", "access": "private", "description": null, "lineNumber": 45, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 91, "kind": "member", "name": "_totalKVACMetricDef", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_totalKVACMetricDef", "access": "private", "description": null, "lineNumber": 46, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 92, "kind": "member", "name": "_perf_start", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_perf_start", "access": "private", "description": null, "lineNumber": 49, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 93, "kind": "member", "name": "accountStoplightIndicator", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#accountStoplightIndicator", "access": "public", "description": null, "lineNumber": 53, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 94, "kind": "method", "name": "setPredictionService", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#setPredictionService", "access": "public", "description": "Sets the predictionType", "lineNumber": 59, "params": [ { "name": "predictionType", "types": [ "*" ] } ], "return": null }, { "__docId__": 95, "kind": "member", "name": "predictionType", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#predictionType", "access": "public", "description": null, "lineNumber": 60, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 96, "kind": "get", "name": "id", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#id", "access": "public", "description": "Persistent id of the bid.\nNOTE: id will soon be in alpha-numerical format", "lineNumber": 70, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 97, "kind": "get", "name": "type", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#type", "access": "public", "description": "Gets the type of bid entity.", "lineNumber": 79, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 98, "kind": "get", "name": "isActive", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isActive", "access": "public", "description": "Determines if the bid is active.", "lineNumber": 88, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 99, "kind": "get", "name": "isLoaded", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isLoaded", "access": "public", "description": "Determine if the full bid and all its entities are currently loaded.\nA bid cannot be edited or assessed until it is loaded.\nBid can be loaded with bid.load().", "lineNumber": 99, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 100, "kind": "set", "name": "isActive", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isActive", "access": "public", "description": "Sets the bid active state.", "lineNumber": 108, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 101, "kind": "get", "name": "laborHours", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#laborHours", "access": "public", "description": "", "lineNumber": 126, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 102, "kind": "get", "name": "cost", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#cost", "access": "public", "description": "", "lineNumber": 133, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 103, "kind": "set", "name": "cost", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#cost", "access": "public", "description": "Overrides bid cost. Overrides are distibuted proportionally to the included line items.", "lineNumber": 142, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 104, "kind": "get", "name": "tax", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#tax", "access": "public", "description": "Tax Property", "lineNumber": 157, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 105, "kind": "get", "name": "costWithTax", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#costWithTax", "access": "public", "description": "Cost including Tax", "lineNumber": 166, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 106, "kind": "get", "name": "costWithMarkup", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#costWithMarkup", "access": "public", "description": "Cost including Markup", "lineNumber": 175, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 107, "kind": "get", "name": "taxPercent", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#taxPercent", "access": "public", "description": "Tax Percent Property", "lineNumber": 184, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 108, "kind": "set", "name": "taxPercent", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#taxPercent", "access": "public", "description": "", "lineNumber": 191, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 109, "kind": "get", "name": "markup", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#markup", "access": "public", "description": "Markup Property", "lineNumber": 206, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 110, "kind": "set", "name": "markup", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#markup", "access": "public", "description": "", "lineNumber": 213, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 111, "kind": "get", "name": "marginPercent", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#marginPercent", "access": "public", "description": "", "lineNumber": 220, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 112, "kind": "set", "name": "marginPercent", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#marginPercent", "access": "public", "description": "", "lineNumber": 227, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 113, "kind": "get", "name": "markupPercent", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#markupPercent", "access": "public", "description": "", "lineNumber": 240, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 114, "kind": "set", "name": "markupPercent", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#markupPercent", "access": "public", "description": "", "lineNumber": 247, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 115, "kind": "get", "name": "price", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#price", "access": "public", "description": "", "lineNumber": 254, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 116, "kind": "set", "name": "price", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#price", "access": "public", "description": "", "lineNumber": 261, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 117, "kind": "get", "name": "actualCost", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#actualCost", "access": "public", "description": "", "lineNumber": 268, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 118, "kind": "set", "name": "actualCost", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#actualCost", "access": "public", "description": "", "lineNumber": 275, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 119, "kind": "get", "name": "actualHours", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#actualHours", "access": "public", "description": "", "lineNumber": 284, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 120, "kind": "set", "name": "actualHours", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#actualHours", "access": "public", "description": "", "lineNumber": 291, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 121, "kind": "get", "name": "createdAt", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#createdAt", "access": "public", "description": "", "lineNumber": 300, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 122, "kind": "get", "name": "updatedAt", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#updatedAt", "access": "public", "description": "", "lineNumber": 307, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 123, "kind": "get", "name": "watts", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#watts", "access": "public", "description": "", "lineNumber": 314, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 124, "kind": "method", "name": "getUncategorizedLineItems", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#getUncategorizedLineItems", "access": "public", "description": "Gets all the uncategorized Line Items by component group.", "lineNumber": 324, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "componentGroupId", "description": "The component group id." } ], "return": { "nullable": null, "types": [ "{[id: string]: LineItem}" ], "spread": false, "description": "Uncategorized Line Items keyed by ID." } }, { "__docId__": 125, "kind": "method", "name": "toggleActive", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#toggleActive", "access": "public", "description": "", "lineNumber": 348, "deprecated": "use isActive property.", "params": [], "return": null }, { "__docId__": 127, "kind": "method", "name": "_getTotalWatts", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#_getTotalWatts", "access": "private", "description": "Gets the total watts for the bid.", "lineNumber": 359, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 130, "kind": "method", "name": "getMarginPercent", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#getMarginPercent", "access": "public", "description": "Calculates and returns the Bid Margin Percent.", "lineNumber": 410, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 131, "kind": "method", "name": "includeTaxInMarkup", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#includeTaxInMarkup", "access": "public", "description": "Determines if markup should also be assessed on the tax.", "lineNumber": 422, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 132, "kind": "method", "name": "includeMarkupInTax", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#includeMarkupInTax", "access": "public", "description": null, "lineNumber": 430, "undocument": true, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 133, "kind": "method", "name": "_applyMarginPercentage", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#_applyMarginPercentage", "access": "private", "description": "Applies a user entered margin, back calcualting all line item markups to meet the margin.", "lineNumber": 441, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "newMarginPercent", "description": "" } ], "ignore": true, "return": null }, { "__docId__": 134, "kind": "method", "name": "_resetSubMargins", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#_resetSubMargins", "access": "private", "description": null, "lineNumber": 463, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 135, "kind": "method", "name": "resetMarkup", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#resetMarkup", "access": "public", "description": "Globally resets markup on all line items in the bid.", "lineNumber": 486, "params": [], "return": null }, { "__docId__": 136, "kind": "method", "name": "applySubMarginChange", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#applySubMarginChange", "access": "public", "description": "", "lineNumber": 497, "deprecated": true, "params": [], "return": null }, { "__docId__": 138, "kind": "method", "name": "clearCachedValues", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#clearCachedValues", "access": "public", "description": "Clear the locally cached values", "lineNumber": 510, "params": [], "return": null }, { "__docId__": 140, "kind": "method", "name": "assess", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#assess", "access": "public", "description": "Assess bid values. If bid values changes, the bid will be flagged as dirty and an \"updated\" event will fire.", "lineNumber": 524, "params": [ { "nullable": true, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "dependency", "description": "The calling dependency." }, { "nullable": true, "types": [ "boolean" ], "spread": false, "optional": true, "name": "forceUpdate", "description": "Force fires \"update\" event and flags bid as dirty." } ], "emits": [ { "types": [ "assessing" ], "description": "" }, { "types": [ "assessed" ], "description": "" }, { "types": [ "updated" ], "description": "" } ], "return": null }, { "__docId__": 142, "kind": "method", "name": "reassessAll", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#reassessAll", "access": "public", "description": "Reassess all {@link LineItem}s, {@link Fields}s, {@link Metrics}s, and {@ linkComponents}s.\nThis function checks {@link Bid.needsReassessment} first, to determine if reassessment is necessary.\nUse the force flag to reasses reguardless of necessity.", "lineNumber": 647, "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "forceReassessment", "description": "" } ], "return": null }, { "__docId__": 143, "kind": "method", "name": "needsReassessment", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#needsReassessment", "access": "public", "description": "Analyzes line items and components calculations. If the sum up correctly\nto match the bid, reassessment is considered unnecessary.", "lineNumber": 672, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 144, "kind": "method", "name": "_componentNeedsReassessment", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#_componentNeedsReassessment", "access": "private", "description": "Determines if components need to be reassessed by comparing bid results.", "lineNumber": 710, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "params": [ { "nullable": null, "types": [ "Component" ], "spread": false, "optional": false, "name": "component", "description": "The component to determine if needs reassessment." } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 145, "kind": "method", "name": "clearEntityBindings", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#clearEntityBindings", "access": "public", "description": "Removes all event listeners for the bid entities in a bid.\nIt does not remove any event listeners for the bid itself.", "lineNumber": 735, "params": [], "return": null }, { "__docId__": 148, "kind": "method", "name": "bind", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#bind", "access": "public", "description": "Binds all interconnected bid entity \"update\" events", "lineNumber": 758, "params": [], "return": null }, { "__docId__": 149, "kind": "method", "name": "_handleAssessmentCompleteEvent", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#_handleAssessmentCompleteEvent", "access": "private", "description": "", "lineNumber": 792, "listens": [ { "types": [ "assessed" ], "description": "" } ], "ignore": true, "params": [], "return": null }, { "__docId__": 150, "kind": "member", "name": "_perf_end", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_perf_end", "access": "private", "description": null, "lineNumber": 795, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 153, "kind": "method", "name": "getMarginOfError", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#getMarginOfError", "access": "public", "description": "Gets the margin of error for indicative pricing.", "lineNumber": 810, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 154, "kind": "method", "name": "getIndicativePrice", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#getIndicativePrice", "access": "public", "description": "Gets indicative price", "lineNumber": 821, "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "bidPrice", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "isLow", "description": "The lower or upper bounds (low | high)" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" } }, { "__docId__": 155, "kind": "method", "name": "isIndicativePricing", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isIndicativePricing", "access": "public", "description": "Determines if indicative pricing is enabled.", "lineNumber": 835, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 156, "kind": "method", "name": "exportData", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#exportData", "access": "public", "description": "Exports the bid's data to an object.", "lineNumber": 864, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "properties": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "NOTE: id will soon be in UUID format." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "cost", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "taxable_cost", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "labor_cost", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "labor_hours", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "price", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "margin_percent", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "markup", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "markup_percent", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "tax", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "tax_percent", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "price", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "actual_cost", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "actual_hours", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "watts", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "is_active", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "is_locked", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "created_at", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "updated_at", "description": "" } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 157, "kind": "method", "name": "exportDataWithEntities", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#exportDataWithEntities", "access": "public", "description": "Exports the bid data along with all of the bid entities included.", "lineNumber": 896, "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "Exported bid data with all its entities and their config objects." }, "params": [] }, { "__docId__": 158, "kind": "method", "name": "_omit", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#_omit", "access": "private", "description": "Returns new shallow copy of object with omitted properties", "lineNumber": 927, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "obj", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "blacklist", "description": "" } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 159, "kind": "method", "name": "pristine", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#pristine", "access": "public", "description": "Marks bid and all bid entities as clean.", "lineNumber": 942, "params": [], "return": null }, { "__docId__": 160, "kind": "member", "name": "_is_dirty", "memberof": "src/domain/Bid.js~Bid", "static": false, "longname": "src/domain/Bid.js~Bid#_is_dirty", "access": "private", "description": null, "lineNumber": 943, "undocument": true, "ignore": true, "type": { "types": [ "boolean" ] } }, { "__docId__": 161, "kind": "method", "name": "createSnapshot", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#createSnapshot", "access": "public", "description": "Creates a snapshot of current Bid data.", "lineNumber": 975, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise.} Returns a data object of the snapshot." } ], "params": [ { "nullable": true, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "" }, { "nullable": true, "types": [ "string" ], "spread": false, "optional": false, "name": "description", "description": "" } ], "properties": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "The snapshot id." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bid_id", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "description", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "is_auto", "description": "A flag to indicate the snapshot was generated automatically by the PVBid system." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "created_at", "description": "Example format: 2016-04-11T21:08:05+00:00" } ], "return": { "nullable": null, "types": [ "Promise." ], "spread": false, "description": "Returns a data object of the snapshot." } }, { "__docId__": 162, "kind": "method", "name": "isAssessable", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isAssessable", "access": "public", "description": "Determines if bid is in an \"assessable\" state. Factors include if the bid is as shell bid,\nif the bid is in read only mode, and if the bid has no validation issues.", "lineNumber": 985, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 163, "kind": "method", "name": "isShell", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isShell", "access": "public", "description": "Determines if is a shell bid. Shell bids are simple data stores for past bids\nthat can not be assesed. Shell bids do not have line items. Typically shell\nbids are created to import old bid data prior a companies using PVBid.", "lineNumber": 996, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 164, "kind": "method", "name": "isPredicted", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isPredicted", "access": "public", "description": "Determines if a bid property is predicted.", "lineNumber": 1006, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "property", "description": "The bid property" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 165, "kind": "method", "name": "hasNullDependency", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#hasNullDependency", "access": "public", "description": "Determines if a property depends on a null dependency somewhere in it's calculation", "lineNumber": 1022, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "property", "description": "The bid property name" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 166, "kind": "method", "name": "isUpdateable", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isUpdateable", "access": "public", "description": "Determines if bid is updatable by the user.\nThis method is deprecated. Use {@link Bid.isReadOnly} instead.", "lineNumber": 1042, "deprecated": true, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 167, "kind": "method", "name": "isReadOnly", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isReadOnly", "access": "public", "description": "Determines if bid can be modified by the user.\nConsiders if the bid is locked, if the project is closed, and the user permissions.", "lineNumber": 1052, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 168, "kind": "method", "name": "isLocked", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isLocked", "access": "public", "description": "Determines if the bid is locked.", "lineNumber": 1067, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 169, "kind": "method", "name": "canLock", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#canLock", "access": "public", "description": "Determines if bid can be locked by user.", "lineNumber": 1076, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 170, "kind": "method", "name": "canUnlock", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#canUnlock", "access": "public", "description": "Determines if bid can be unlocked by user.", "lineNumber": 1090, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 171, "kind": "method", "name": "lock", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#lock", "access": "public", "description": "Locks bid, forcing read-only mode for everyone. Bid must be unlocked before it can be modified again.\nThis function immediately saves the bid.\nWill return a rejected promise if the bid cannot be locked.", "lineNumber": 1106, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 172, "kind": "method", "name": "unlock", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#unlock", "access": "public", "description": "Unlocks bid, making it writable for those with permission.\nThis function immediately saves the bid.", "lineNumber": 1121, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 173, "kind": "method", "name": "load", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#load", "access": "public", "description": "Fully loads the bid with its entities (if not already loaded).", "lineNumber": 1137, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": " false", "defaultRaw": false, "name": "options.forceReload", "description": "Force the bid to reload even if the entities are already loaded." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": " false", "defaultRaw": false, "name": "options.skipSave", "description": "Saves the current project state before loading by default. Set this flag to skip." } ], "return": null }, { "__docId__": 174, "kind": "method", "name": "removeAssembly", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#removeAssembly", "access": "public", "description": "Removes assembly from a bid. A wrapper function for {@link BidService.removeAssembly}", "lineNumber": 1151, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "assemblyId", "description": "" } ], "return": { "types": [ "*" ] } }, { "__docId__": 175, "kind": "method", "name": "addAssemblies", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#addAssemblies", "access": "public", "description": "Adds assemblies to bid. A wrapper function for {@link BidService.addAssemblies}", "lineNumber": 1162, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "number[]" ], "spread": false, "optional": false, "name": "assemblyMapIds", "description": "An array of assembly mapping ids to add." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 176, "kind": "method", "name": "addDynamicGroup", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#addDynamicGroup", "access": "public", "description": "Adds Dynamic Groups to bid. A wrapper function for {@link BidService.addDynamicGroup}", "lineNumber": 1173, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "The title of the Dynamic Group to add" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 177, "kind": "method", "name": "recover", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#recover", "access": "public", "description": "Recovers bid to previous snapshot. An auto snapshot of the current state will be created.\nThis is a wrapper function for {@link BidService.recoverBid}", "lineNumber": 1185, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "snapshotId", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 178, "kind": "method", "name": "clone", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#clone", "access": "public", "description": "Clones the current bid and returns the cloned bid. The cloned bid is also added to the project automatically.", "lineNumber": 1195, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 179, "kind": "method", "name": "moveToProject", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#moveToProject", "access": "public", "description": " Moves a bid from its current project to another", "lineNumber": 1205, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise<*>}" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "project", "description": "" } ], "return": { "nullable": null, "types": [ "Promise<*>" ], "spread": false, "description": "" } }, { "__docId__": 180, "kind": "method", "name": "isValid", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#isValid", "access": "public", "description": "Determines if bid has valid dependency references and configurations..", "lineNumber": 1214, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 181, "kind": "method", "name": "validate", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#validate", "access": "public", "description": "Validates bid and returns a resultset of issues, if exists.", "lineNumber": 1226, "unknown": [ { "tagName": "@returns", "tagValue": "{object[]}" } ], "return": { "nullable": null, "types": [ "object[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 182, "kind": "method", "name": "delete", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#delete", "access": "public", "description": "Deletes bid. Wrapper function for {@link BidService.deleteBid}", "lineNumber": 1235, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 183, "kind": "method", "name": "addBidVariable", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#addBidVariable", "access": "public", "description": "Adds a new bid variable to the bid", "lineNumber": 1244, "throws": [ { "types": [ "Error" ], "description": "If bid is read only" } ], "params": [], "return": null }, { "__docId__": 184, "kind": "method", "name": "addLineItem", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#addLineItem", "access": "public", "description": "Adds a new line item to the bid. The added line item is uncategorized in all component groups.\nThis is a wrapper function for {@link BidService.addLineItem}", "lineNumber": 1273, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "New Line Item", "defaultRaw": "New Line Item", "name": "title", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "throws": [ { "types": [ "Error" ], "description": "If bid is read only" } ] }, { "__docId__": 185, "kind": "method", "name": "addMetric", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#addMetric", "access": "public", "description": "Adds a new metric to the bid.\nThis is a wrapper function for {@link BidService.addMetric}", "lineNumber": 1288, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "New Metric", "defaultRaw": "New Metric", "name": "title", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "throws": [ { "types": [ "Error" ], "description": "If bid is read only" } ] }, { "__docId__": 186, "kind": "method", "name": "addField", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#addField", "access": "public", "description": "Adds a new field to the bid.\nThis is a wrapper function for {@link BidService.addField}", "lineNumber": 1304, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "New Field", "defaultRaw": "New Field", "name": "title", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "number", "defaultRaw": "number", "name": "type", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "throws": [ { "types": [ "Error" ], "description": "If bid is read only" } ] }, { "__docId__": 187, "kind": "method", "name": "dirtyAll", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#dirtyAll", "access": "public", "description": "Flags all fields, metrics, lineItems, and components as dirty.", "lineNumber": 1314, "params": [], "return": null }, { "__docId__": 188, "kind": "method", "name": "getStoplightIndicator", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#getStoplightIndicator", "access": "public", "description": null, "lineNumber": 1329, "undocument": true, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ], "return": { "types": [ "*" ] } }, { "__docId__": 189, "kind": "method", "name": "updateStoplightIndicators", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#updateStoplightIndicators", "access": "public", "description": null, "lineNumber": 1374, "undocument": true, "params": [], "return": null }, { "__docId__": 191, "kind": "method", "name": "getWeightedNormalValues", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#getWeightedNormalValues", "access": "public", "description": " Calculates the weighted normal value given a set of distribution ranges.", "lineNumber": 1382, "unknown": [ { "tagName": "@returns", "tagValue": "{array} Array of weighted normal values" } ], "return": { "nullable": null, "types": [ "array" ], "spread": false, "description": "Array of weighted normal values" }, "params": [] }, { "__docId__": 192, "kind": "method", "name": "getWeightedNormalValue", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#getWeightedNormalValue", "access": "public", "description": " For each line item, get all of its weightedNormalValues\n return the sum of all line item's weightedNormalValues at distributionIndex", "lineNumber": 1408, "unknown": [ { "tagName": "@returns", "tagValue": "{T|null} weighted normal value" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "distributionIndex", "description": "" } ], "return": { "nullable": null, "types": [ "T", "null" ], "spread": false, "description": "weighted normal value" } }, { "__docId__": 193, "kind": "method", "name": "getPredictedValue", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": false, "static": false, "longname": "src/domain/Bid.js~Bid#getPredictedValue", "access": "public", "description": "Gets the predicted value of the bid by calculating the sum total of the predicted values for all line items", "lineNumber": 1447, "unknown": [ { "tagName": "@returns", "tagValue": "{sum|null}" } ], "return": { "nullable": null, "types": [ "sum", "null" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 194, "kind": "method", "name": "reassessAsync", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#reassessAsync", "access": "public", "description": "Helper method to re-assess the bid until price converges. Returns a promise that will resolve once the price has stabilized.", "lineNumber": 1465, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Resolves once the bid has been assessed twice in a row with the same price. Rejects if the price does not stabilize." }, "params": [] }, { "__docId__": 195, "kind": "method", "name": "_reassessAllAsync", "memberof": "src/domain/Bid.js~Bid", "generator": false, "async": true, "static": false, "longname": "src/domain/Bid.js~Bid#_reassessAllAsync", "access": "private", "description": "Recursively reassess the bid until the price stabilizes or a maximum number of attempts is reached.", "lineNumber": 1483, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "maxCount", "description": "Maximum number of recursion attempts allowed" }, { "nullable": null, "types": [ "[number]" ], "spread": false, "optional": false, "name": "currentCount", "description": "For tracking the number of iterations performed" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Whether or not the count is within the allowable max count range (determines a stable result)" }, "ignore": true }, { "__docId__": 196, "kind": "file", "name": "src/domain/BidEntity.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/BidEntity.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 197, "kind": "class", "name": "BidEntity", "memberof": "src/domain/BidEntity.js", "static": true, "longname": "src/domain/BidEntity.js~BidEntity", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/BidEntity.js", "importStyle": "BidEntity", "description": "A base class for all other bid entities to extend.", "lineNumber": 11, "unknown": [ { "tagName": "@class", "tagValue": "BidEntity" } ], "interface": false, "extends": [ "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter" ] }, { "__docId__": 198, "kind": "constructor", "name": "constructor", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#constructor", "access": "public", "description": null, "lineNumber": 12, "undocument": true }, { "__docId__": 199, "kind": "member", "name": "_data", "memberof": "src/domain/BidEntity.js~BidEntity", "static": false, "longname": "src/domain/BidEntity.js~BidEntity#_data", "access": "private", "description": "Internal data store for the bid entity.", "lineNumber": 19, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 200, "kind": "member", "name": "_eventTree", "memberof": "src/domain/BidEntity.js~BidEntity", "static": false, "longname": "src/domain/BidEntity.js~BidEntity#_eventTree", "access": "private", "description": null, "lineNumber": 24, "undocument": true, "ignore": true, "type": { "types": [ "{}" ] } }, { "__docId__": 201, "kind": "member", "name": "_saveChangeLogService", "memberof": "src/domain/BidEntity.js~BidEntity", "static": false, "longname": "src/domain/BidEntity.js~BidEntity#_saveChangeLogService", "access": "private", "description": null, "lineNumber": 30, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 202, "kind": "get", "name": "id", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#id", "access": "public", "description": "Gets the id of the bid entity.\nNOTE: Excluding Projects, all bid entity id's will soon be in UUID format", "lineNumber": 39, "type": { "nullable": null, "types": [ "number", "string" ], "spread": false, "description": null } }, { "__docId__": 203, "kind": "get", "name": "title", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#title", "access": "public", "description": "Gets the bid entity title.", "lineNumber": 48, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 204, "kind": "set", "name": "title", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#title", "access": "public", "description": "Sets the bid entity title. Flags bid entity as dirty.", "lineNumber": 57, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 205, "kind": "get", "name": "type", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#type", "access": "public", "description": "Gets the bid entity type.", "lineNumber": 69, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 206, "kind": "get", "name": "hasAssembly", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#hasAssembly", "access": "public", "description": "Determine if the entity is in an assembly", "lineNumber": 78, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 207, "kind": "method", "name": "isDirty", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#isDirty", "access": "public", "description": "Determines of bid entity is dirty.", "lineNumber": 87, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 208, "kind": "method", "name": "dirty", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#dirty", "access": "public", "description": "Flags the bid entity as dirty and to be saved.", "lineNumber": 94, "params": [], "return": null }, { "__docId__": 209, "kind": "member", "name": "_is_dirty", "memberof": "src/domain/BidEntity.js~BidEntity", "static": false, "longname": "src/domain/BidEntity.js~BidEntity#_is_dirty", "access": "private", "description": null, "lineNumber": 95, "undocument": true, "ignore": true, "type": { "types": [ "boolean" ] } }, { "__docId__": 210, "kind": "method", "name": "_postApply", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#_postApply", "access": "private", "description": "Dirty and emit", "lineNumber": 108, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "event", "description": "event to emit after dirtying" } ], "ignore": true, "return": null }, { "__docId__": 211, "kind": "method", "name": "pristine", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#pristine", "access": "public", "description": "Marks the bid entity as clean.", "lineNumber": 116, "params": [], "return": null }, { "__docId__": 213, "kind": "method", "name": "exportData", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#exportData", "access": "public", "description": "Exports the internal data for the bid entity.", "lineNumber": 126, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 214, "kind": "method", "name": "dependencies", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#dependencies", "access": "public", "description": "Gets all the dependencies that the bid entity relies on.", "lineNumber": 135, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]} Returns an array of bid entities." } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "Returns an array of bid entities." }, "params": [] }, { "__docId__": 215, "kind": "method", "name": "hasNullDependency", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#hasNullDependency", "access": "public", "description": "Determines if bid entity relies on a null or undefined dependency value", "lineNumber": 145, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "name": "field", "description": "Field property if other than 'value'" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 216, "kind": "method", "name": "_checkProperties", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#_checkProperties", "access": "private", "description": "Check the status of entity properties using a test method.", "lineNumber": 159, "params": [ { "nullable": null, "types": [ "Array" ], "spread": false, "optional": false, "name": "propsMap", "description": "Properties of the bid entity to check using testMethod.\n Each prop can be a string or a [testProp, outputProp] pair.\n The testProp is tested and if true, the outputProp is in the return array." }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "testMethod", "description": "Called to test the props" } ], "return": { "nullable": null, "types": [ "string[]" ], "spread": false, "description": "Array of properties that passed the test" }, "ignore": true }, { "__docId__": 217, "kind": "method", "name": "dependants", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#dependants", "access": "public", "description": "Gets an array of depndants that rely on the bid entity.", "lineNumber": 175, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]} Returns an array of bid entities." } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "Returns an array of bid entities." }, "params": [] }, { "__docId__": 218, "kind": "method", "name": "assess", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": false, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#assess", "access": "public", "description": "Assesses bid entity.", "lineNumber": 188, "params": [ { "nullable": true, "types": [ "BidEntity" ], "spread": false, "optional": true, "name": "dependency", "description": "The calling dependency." } ], "abstract": true, "emits": [ { "types": [ "assessing" ], "description": "Fires as assessment begins." }, { "types": [ "assessed" ], "description": "Fires when bid entity assessement is completed" }, { "types": [ "updated" ], "description": "Fires when the bid entity has changed." } ], "return": null }, { "__docId__": 219, "kind": "method", "name": "initSaveChangeLog", "memberof": "src/domain/BidEntity.js~BidEntity", "generator": false, "async": true, "static": false, "longname": "src/domain/BidEntity.js~BidEntity#initSaveChangeLog", "access": "public", "description": null, "lineNumber": 192, "undocument": true, "params": [ { "name": "originalValue", "types": [ "*" ] }, { "name": "newValue", "types": [ "*" ] }, { "name": "valueType", "types": [ "*" ] }, { "name": "entityProperty", "types": [ "*" ] }, { "name": "metaData", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 220, "kind": "file", "name": "src/domain/BidVariable.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/BidVariable.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 221, "kind": "class", "name": "BidVariable", "memberof": "src/domain/BidVariable.js", "static": true, "longname": "src/domain/BidVariable.js~BidVariable", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/BidVariable.js", "importStyle": "BidVariable", "description": "Bid Variable Class", "lineNumber": 6, "interface": false, "extends": [ "src/domain/BidEntity.js~BidEntity" ] }, { "__docId__": 222, "kind": "constructor", "name": "constructor", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#constructor", "access": "public", "description": "Creates an instance of BidVariable.", "lineNumber": 12, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "bidVariableData", "description": "" }, { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ] }, { "__docId__": 223, "kind": "member", "name": "bid", "memberof": "src/domain/BidVariable.js~BidVariable", "static": false, "longname": "src/domain/BidVariable.js~BidVariable#bid", "access": "public", "description": "Reference to the bid that the bid variable belongs to.", "lineNumber": 18, "type": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": null } }, { "__docId__": 224, "kind": "member", "name": "_data", "memberof": "src/domain/BidVariable.js~BidVariable", "static": false, "longname": "src/domain/BidVariable.js~BidVariable#_data", "access": "private", "description": null, "lineNumber": 19, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 225, "kind": "get", "name": "type", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#type", "access": "public", "description": "Gets the bid entity type. ", "lineNumber": 25, "type": { "types": [ "string" ] } }, { "__docId__": 226, "kind": "get", "name": "valueType", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#valueType", "access": "public", "description": "", "lineNumber": 32, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 227, "kind": "set", "name": "valueType", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#valueType", "access": "public", "description": "", "lineNumber": 39, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 228, "kind": "get", "name": "title", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#title", "access": "public", "description": "", "lineNumber": 47, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 229, "kind": "set", "name": "title", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#title", "access": "public", "description": "", "lineNumber": 54, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 230, "kind": "get", "name": "value", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#value", "access": "public", "description": "", "lineNumber": 62, "type": { "nullable": true, "types": [ "number", "string", "boolean" ], "spread": false, "description": null } }, { "__docId__": 231, "kind": "set", "name": "value", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#value", "access": "public", "description": "", "lineNumber": 69, "type": { "nullable": true, "types": [ "number", "string", "boolean" ], "spread": false, "description": null } }, { "__docId__": 232, "kind": "get", "name": "isReserved", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#isReserved", "access": "public", "description": "", "lineNumber": 80, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 233, "kind": "get", "name": "config", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#config", "access": "public", "description": "", "lineNumber": 87, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 234, "kind": "method", "name": "dependants", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#dependants", "access": "public", "description": "Gets an array of dependant bid entities that rely on the Bid Variable.", "lineNumber": 96, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]}" } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 235, "kind": "method", "name": "dirty", "memberof": "src/domain/BidVariable.js~BidVariable", "generator": false, "async": false, "static": false, "longname": "src/domain/BidVariable.js~BidVariable#dirty", "access": "public", "description": "Flags the bid variable and corresponding bid as dirty and to be saved.", "lineNumber": 103, "params": [], "return": null }, { "__docId__": 236, "kind": "file", "name": "src/domain/Component.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/Component.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 237, "kind": "class", "name": "Component", "memberof": "src/domain/Component.js", "static": true, "longname": "src/domain/Component.js~Component", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/Component.js", "importStyle": "Component", "description": "Component Class", "lineNumber": 14, "interface": false, "extends": [ "src/domain/BidEntity.js~BidEntity" ] }, { "__docId__": 238, "kind": "constructor", "name": "constructor", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#constructor", "access": "public", "description": "Creates an instance of Component.", "lineNumber": 20, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "componentData", "description": "structured component data" }, { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "The bid in which the component belongs to." } ] }, { "__docId__": 239, "kind": "member", "name": "bid", "memberof": "src/domain/Component.js~Component", "static": false, "longname": "src/domain/Component.js~Component#bid", "access": "public", "description": "Reference to the bid that the component belongs to.", "lineNumber": 26, "type": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": null } }, { "__docId__": 240, "kind": "member", "name": "_original", "memberof": "src/domain/Component.js~Component", "static": false, "longname": "src/domain/Component.js~Component#_original", "access": "private", "description": null, "lineNumber": 27, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 241, "kind": "member", "name": "_data", "memberof": "src/domain/Component.js~Component", "static": false, "longname": "src/domain/Component.js~Component#_data", "access": "private", "description": null, "lineNumber": 28, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 242, "kind": "member", "name": "_cacheValues", "memberof": "src/domain/Component.js~Component", "static": false, "longname": "src/domain/Component.js~Component#_cacheValues", "access": "private", "description": null, "lineNumber": 29, "undocument": true, "ignore": true, "type": { "types": [ "{}" ] } }, { "__docId__": 243, "kind": "member", "name": "industryDistributionRanges", "memberof": "src/domain/Component.js~Component", "static": false, "longname": "src/domain/Component.js~Component#industryDistributionRanges", "access": "public", "description": null, "lineNumber": 30, "undocument": true, "type": { "types": [ "number[]" ] } }, { "__docId__": 244, "kind": "member", "name": "accountStoplightIndicator", "memberof": "src/domain/Component.js~Component", "static": false, "longname": "src/domain/Component.js~Component#accountStoplightIndicator", "access": "public", "description": null, "lineNumber": 41, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 245, "kind": "member", "name": "industryStoplightIndicator", "memberof": "src/domain/Component.js~Component", "static": false, "longname": "src/domain/Component.js~Component#industryStoplightIndicator", "access": "public", "description": null, "lineNumber": 42, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 246, "kind": "method", "name": "setPredictionService", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#setPredictionService", "access": "public", "description": "Sets the cacheValues Array for this predictionType and the distribution ranges for the predictionType", "lineNumber": 48, "params": [ { "name": "predictionType", "types": [ "*" ] } ], "return": null }, { "__docId__": 247, "kind": "member", "name": "predictionType", "memberof": "src/domain/Component.js~Component", "static": false, "longname": "src/domain/Component.js~Component#predictionType", "access": "public", "description": null, "lineNumber": 49, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 248, "kind": "member", "name": "_distributionRanges", "memberof": "src/domain/Component.js~Component", "static": false, "longname": "src/domain/Component.js~Component#_distributionRanges", "access": "private", "description": null, "lineNumber": 53, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 250, "kind": "method", "name": "_invalidateCachedValues", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#_invalidateCachedValues", "access": "private", "description": "Clear the locally cached values", "lineNumber": 65, "ignore": true, "params": [], "return": null }, { "__docId__": 251, "kind": "get", "name": "cost", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#cost", "access": "public", "description": "The summed cost from the nested line items.", "lineNumber": 76, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 252, "kind": "set", "name": "cost", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#cost", "access": "public", "description": "", "lineNumber": 83, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 253, "kind": "get", "name": "taxableCost", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#taxableCost", "access": "public", "description": "The summed taxable cost from the nested line items.", "lineNumber": 98, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 254, "kind": "get", "name": "taxPercent", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#taxPercent", "access": "public", "description": "The average tax percentage from the nested line items.", "lineNumber": 107, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 255, "kind": "set", "name": "taxPercent", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#taxPercent", "access": "public", "description": "", "lineNumber": 114, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 256, "kind": "get", "name": "tax", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#tax", "access": "public", "description": "", "lineNumber": 127, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 257, "kind": "set", "name": "tax", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#tax", "access": "public", "description": "", "lineNumber": 134, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 258, "kind": "get", "name": "costWithTax", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#costWithTax", "access": "public", "description": "Cost With Tax", "lineNumber": 148, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 259, "kind": "get", "name": "costWithMarkup", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#costWithMarkup", "access": "public", "description": "Cost With Markup", "lineNumber": 156, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 260, "kind": "get", "name": "markup", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#markup", "access": "public", "description": "", "lineNumber": 163, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 261, "kind": "set", "name": "markup", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#markup", "access": "public", "description": "", "lineNumber": 170, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 262, "kind": "get", "name": "markupPercent", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#markupPercent", "access": "public", "description": "", "lineNumber": 177, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 263, "kind": "set", "name": "markupPercent", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#markupPercent", "access": "public", "description": "", "lineNumber": 184, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 264, "kind": "get", "name": "laborHours", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#laborHours", "access": "public", "description": "", "lineNumber": 191, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 265, "kind": "set", "name": "laborHours", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#laborHours", "access": "public", "description": "", "lineNumber": 198, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 266, "kind": "get", "name": "laborCost", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#laborCost", "access": "public", "description": "", "lineNumber": 211, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 267, "kind": "get", "name": "nonLaborCost", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#nonLaborCost", "access": "public", "description": "", "lineNumber": 218, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 268, "kind": "get", "name": "price", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#price", "access": "public", "description": "Price Property", "lineNumber": 226, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 269, "kind": "set", "name": "price", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#price", "access": "public", "description": "", "lineNumber": 233, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 270, "kind": "get", "name": "priceWatt", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#priceWatt", "access": "public", "description": "Price per watt", "lineNumber": 243, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 271, "kind": "set", "name": "priceWatt", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#priceWatt", "access": "public", "description": "", "lineNumber": 253, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 273, "kind": "get", "name": "costWatt", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#costWatt", "access": "public", "description": "Cost per watt", "lineNumber": 265, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 274, "kind": "set", "name": "costWatt", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#costWatt", "access": "public", "description": "", "lineNumber": 276, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 276, "kind": "get", "name": "config", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#config", "access": "public", "description": "", "lineNumber": 287, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 277, "kind": "get", "name": "actualCost", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#actualCost", "access": "public", "description": "", "lineNumber": 294, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 278, "kind": "set", "name": "actualCost", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#actualCost", "access": "public", "description": "", "lineNumber": 301, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 279, "kind": "get", "name": "actualCostConfidenceFactor", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#actualCostConfidenceFactor", "access": "public", "description": null, "lineNumber": 315, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 280, "kind": "get", "name": "actualHours", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#actualHours", "access": "public", "description": "", "lineNumber": 322, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 281, "kind": "set", "name": "actualHours", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#actualHours", "access": "public", "description": "", "lineNumber": 329, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 282, "kind": "get", "name": "actualHoursConfidenceFactor", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#actualHoursConfidenceFactor", "access": "public", "description": null, "lineNumber": 344, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 283, "kind": "get", "name": "baseAvg", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#baseAvg", "access": "public", "description": "", "lineNumber": 351, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 284, "kind": "get", "name": "wageAvg", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#wageAvg", "access": "public", "description": "", "lineNumber": 358, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 285, "kind": "get", "name": "burdenAvg", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#burdenAvg", "access": "public", "description": "", "lineNumber": 365, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 286, "kind": "get", "name": "quantityAvg", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#quantityAvg", "access": "public", "description": "", "lineNumber": 372, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 287, "kind": "get", "name": "perQuantityAvg", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#perQuantityAvg", "access": "public", "description": "", "lineNumber": 379, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 288, "kind": "get", "name": "componentGroupId", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#componentGroupId", "access": "public", "description": "Gets the component's group id.", "lineNumber": 388, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 289, "kind": "get", "name": "definitionId", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#definitionId", "access": "public", "description": "Gets the component's definition id.", "lineNumber": 398, "deprecated": "Definition ids will become obsolete in planned data structure upgrade.", "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 290, "kind": "get", "name": "isIncluded", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#isIncluded", "access": "public", "description": "Gets the included status of the component.\nA component is included if it has included line items.", "lineNumber": 408, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 291, "kind": "method", "name": "_apply", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#_apply", "access": "private", "description": "Applies a new value to the component and assesses if there is a change.", "lineNumber": 419, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean} Returns true if there is a change." } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "property", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "value", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "Returns true if there is a change." }, "ignore": true }, { "__docId__": 292, "kind": "method", "name": "_applyVirtualProperty", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#_applyVirtualProperty", "access": "private", "description": "Applies a new virtual property value to the component and returns true if there is a change.", "lineNumber": 438, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "property", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "value", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 293, "kind": "method", "name": "getVirtualPropertyValue", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#getVirtualPropertyValue", "access": "public", "description": "Get the value for the key in the component's properties object", "lineNumber": 470, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "key", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" } }, { "__docId__": 294, "kind": "method", "name": "_applyConfigFlags", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#_applyConfigFlags", "access": "private", "description": "Applies any changes to a config flag set", "lineNumber": 483, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "configProp", "description": "config property name" }, { "nullable": null, "types": [ "string[]" ], "spread": false, "optional": false, "name": "newFlags", "description": "flags to be set true" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "If there was a change or not" }, "ignore": true }, { "__docId__": 295, "kind": "method", "name": "_applyOverrides", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#_applyOverrides", "access": "private", "description": "Sets the override status for any props in the given array", "lineNumber": 497, "params": [ { "nullable": null, "types": [ "string[]" ], "spread": false, "optional": false, "name": "newOverrideProps", "description": "Overridden props from the assessment" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "Whether or not the overrides have changed" }, "ignore": true }, { "__docId__": 296, "kind": "method", "name": "assess", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#assess", "access": "public", "description": "Assess the component instance.", "lineNumber": 519, "emits": [ { "types": [ "assessing" ], "description": "" }, { "types": [ "assessed" ], "description": "" }, { "types": [ "updated" ], "description": "" } ], "params": [], "return": null }, { "__docId__": 297, "kind": "method", "name": "dependants", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#dependants", "access": "public", "description": "Gets a list of bid entities that relies on the component instance.", "lineNumber": 734, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]}" } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 298, "kind": "method", "name": "removeLineItem", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#removeLineItem", "access": "public", "description": "Removes a line item from the component.", "lineNumber": 743, "params": [ { "nullable": null, "types": [ "string", "number" ], "spread": false, "optional": false, "name": "lineItemId", "description": "" } ], "return": null }, { "__docId__": 299, "kind": "method", "name": "bind", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#bind", "access": "public", "description": "Binds the \"updated\" event for all dependant bid entities.", "lineNumber": 761, "params": [], "return": null }, { "__docId__": 300, "kind": "method", "name": "getSubComponents", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#getSubComponents", "access": "public", "description": "Gets an array of nested of subcomponents.", "lineNumber": 783, "return": { "nullable": null, "types": [ "Component[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 301, "kind": "method", "name": "getParent", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#getParent", "access": "public", "description": "Gets the component's parent component, if exists.", "lineNumber": 798, "unknown": [ { "tagName": "@returns", "tagValue": "{?Component}" } ], "return": { "nullable": true, "types": [ "Component" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 302, "kind": "method", "name": "getNestedLevel", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#getNestedLevel", "access": "public", "description": "Gets the level at which the component is nested: 0, 1, 2.", "lineNumber": 810, "unknown": [ { "tagName": "@returns", "tagValue": "{number}" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 303, "kind": "method", "name": "isParent", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#isParent", "access": "public", "description": "Determines of component is a top parent component, in which is not nested.", "lineNumber": 823, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 304, "kind": "method", "name": "isOverridden", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#isOverridden", "access": "public", "description": "Determine if any of the components children have been overridden", "lineNumber": 833, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "property", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 305, "kind": "method", "name": "getLineItems", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#getLineItems", "access": "public", "description": "Gets an array of nested line items.", "lineNumber": 849, "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "includeSubComponents", "description": "" } ], "return": { "nullable": null, "types": [ "array" ], "spread": false, "description": "Returns an array of line items in component." } }, { "__docId__": 306, "kind": "method", "name": "setIncludeStatus", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#setIncludeStatus", "access": "public", "description": "Sets the include status for all nested line items.", "lineNumber": 872, "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "isIncluded", "description": "" } ], "return": null }, { "__docId__": 307, "kind": "method", "name": "isPredicted", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#isPredicted", "access": "public", "description": "Check whether a given value is predicted or not", "lineNumber": 888, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "value", "description": "The value to check the prediction status of" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 308, "kind": "method", "name": "getStoplightIndicator", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#getStoplightIndicator", "access": "public", "description": null, "lineNumber": 894, "undocument": true, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ], "return": { "types": [ "*" ] } }, { "__docId__": 309, "kind": "method", "name": "updateStoplightIndicators", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#updateStoplightIndicators", "access": "public", "description": null, "lineNumber": 1036, "undocument": true, "params": [], "return": null }, { "__docId__": 312, "kind": "method", "name": "getWeightedNormalValues", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#getWeightedNormalValues", "access": "public", "description": " Calculates the weighted normal value given a set of distribution ranges.", "lineNumber": 1047, "unknown": [ { "tagName": "@returns", "tagValue": "{array} Array of weighted normal values" } ], "return": { "nullable": null, "types": [ "array" ], "spread": false, "description": "Array of weighted normal values" }, "params": [] }, { "__docId__": 313, "kind": "method", "name": "getWeightedNormalValue", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#getWeightedNormalValue", "access": "public", "description": " For each line item, get all of its weightedNormalValues\n return the sum of all line item's weightedNormalValues at distributionIndex", "lineNumber": 1068, "unknown": [ { "tagName": "@returns", "tagValue": "{T|null} weighted normal value" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "distributionIndex", "description": "" } ], "return": { "nullable": null, "types": [ "T", "null" ], "spread": false, "description": "weighted normal value" } }, { "__docId__": 314, "kind": "method", "name": "getPredictedValue", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#getPredictedValue", "access": "public", "description": "Gets the predicted value of the component by calculating the sum total of the predicted values for all line items", "lineNumber": 1102, "unknown": [ { "tagName": "@returns", "tagValue": "{sum|null}" } ], "return": { "nullable": null, "types": [ "sum", "null" ], "spread": false, "description": "" }, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ] }, { "__docId__": 315, "kind": "method", "name": "hasNullDependency", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#hasNullDependency", "access": "public", "description": "Checks if a component property relied on a null dependency at any point in calculation", "lineNumber": 1127, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "value", "description": "The property to check" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 316, "kind": "method", "name": "reset", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#reset", "access": "public", "description": "Resets all nested line items.", "lineNumber": 1136, "params": [], "return": null }, { "__docId__": 317, "kind": "method", "name": "_applyComponentValue", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#_applyComponentValue", "access": "private", "description": "Applies the component value change to the nested line items.", "lineNumber": 1154, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "property", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "oldValue", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "newValue", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "overrideAllLineItems", "description": "" } ], "ignore": true, "return": null }, { "__docId__": 318, "kind": "method", "name": "exportData", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#exportData", "access": "public", "description": "Exports component internal data structure.", "lineNumber": 1181, "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "alwaysIncludeConfig", "description": "Will include config object in export regardless of changed status." } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" } }, { "__docId__": 319, "kind": "method", "name": "dirty", "memberof": "src/domain/Component.js~Component", "generator": false, "async": false, "static": false, "longname": "src/domain/Component.js~Component#dirty", "access": "public", "description": "Flags the component and corresponding bid as dirty and to be saved.", "lineNumber": 1191, "params": [], "return": null }, { "__docId__": 320, "kind": "file", "name": "src/domain/ComponentGroup.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/ComponentGroup.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 321, "kind": "class", "name": "ComponentGroup", "memberof": "src/domain/ComponentGroup.js", "static": true, "longname": "src/domain/ComponentGroup.js~ComponentGroup", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/ComponentGroup.js", "importStyle": "ComponentGroup", "description": "Component Group Class", "lineNumber": 8, "unknown": [ { "tagName": "@class", "tagValue": "ComponentGroup" } ], "interface": false, "extends": [ "src/domain/BidEntity.js~BidEntity" ] }, { "__docId__": 322, "kind": "constructor", "name": "constructor", "memberof": "src/domain/ComponentGroup.js~ComponentGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/ComponentGroup.js~ComponentGroup#constructor", "access": "public", "description": "Creates an instance of ComponentGroup.", "lineNumber": 14, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "componentGroupData", "description": "" }, { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ] }, { "__docId__": 323, "kind": "member", "name": "bid", "memberof": "src/domain/ComponentGroup.js~ComponentGroup", "static": false, "longname": "src/domain/ComponentGroup.js~ComponentGroup#bid", "access": "public", "description": "Reference to the bid that the component group belongs to.", "lineNumber": 20, "type": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": null } }, { "__docId__": 324, "kind": "member", "name": "_data", "memberof": "src/domain/ComponentGroup.js~ComponentGroup", "static": false, "longname": "src/domain/ComponentGroup.js~ComponentGroup#_data", "access": "private", "description": "Internal data for bid entity.", "lineNumber": 26, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 325, "kind": "get", "name": "definitionId", "memberof": "src/domain/ComponentGroup.js~ComponentGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/ComponentGroup.js~ComponentGroup#definitionId", "access": "public", "description": null, "lineNumber": 29, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 326, "kind": "get", "name": "config", "memberof": "src/domain/ComponentGroup.js~ComponentGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/ComponentGroup.js~ComponentGroup#config", "access": "public", "description": "Config Getter.", "lineNumber": 37, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 327, "kind": "method", "name": "getComponents", "memberof": "src/domain/ComponentGroup.js~ComponentGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/ComponentGroup.js~ComponentGroup#getComponents", "access": "public", "description": "Retrieves the bid components that belong to the component group", "lineNumber": 47, "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "topLevelOnly", "description": "get only the top level components in the group" } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "components keyed by their reference" } }, { "__docId__": 328, "kind": "method", "name": "dirty", "memberof": "src/domain/ComponentGroup.js~ComponentGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/ComponentGroup.js~ComponentGroup#dirty", "access": "public", "description": "Flags the component group and corresponding bid as dirty and to be saved.", "lineNumber": 61, "params": [], "return": null }, { "__docId__": 329, "kind": "file", "name": "src/domain/Datatable.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/Datatable.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 330, "kind": "class", "name": "Datatable", "memberof": "src/domain/Datatable.js", "static": true, "longname": "src/domain/Datatable.js~Datatable", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/Datatable.js", "importStyle": "Datatable", "description": "Datatable Class", "lineNumber": 8, "unknown": [ { "tagName": "@class", "tagValue": "Datatable" } ], "interface": false, "extends": [ "src/domain/BidEntity.js~BidEntity" ] }, { "__docId__": 331, "kind": "constructor", "name": "constructor", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#constructor", "access": "public", "description": "Creates an instance of Datatable.", "lineNumber": 14, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "datatableData", "description": "" }, { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ] }, { "__docId__": 332, "kind": "member", "name": "bid", "memberof": "src/domain/Datatable.js~Datatable", "static": false, "longname": "src/domain/Datatable.js~Datatable#bid", "access": "public", "description": "Reference to the bid that the datatable belongs to.", "lineNumber": 20, "type": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": null } }, { "__docId__": 333, "kind": "member", "name": "_data", "memberof": "src/domain/Datatable.js~Datatable", "static": false, "longname": "src/domain/Datatable.js~Datatable#_data", "access": "private", "description": "Internal data store for the bid entity.", "lineNumber": 26, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null }, "ignore": true }, { "__docId__": 334, "kind": "member", "name": "_original", "memberof": "src/domain/Datatable.js~Datatable", "static": false, "longname": "src/domain/Datatable.js~Datatable#_original", "access": "private", "description": null, "lineNumber": 28, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 335, "kind": "member", "name": "_partValuesCache", "memberof": "src/domain/Datatable.js~Datatable", "static": false, "longname": "src/domain/Datatable.js~Datatable#_partValuesCache", "access": "private", "description": null, "lineNumber": 30, "undocument": true, "ignore": true, "type": { "types": [ "{}" ] } }, { "__docId__": 336, "kind": "get", "name": "definitionId", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#definitionId", "access": "public", "description": "Gets the datatables's definition id.", "lineNumber": 41, "deprecated": "Definition ids will become obsolete in planned data structure upgrade.", "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 337, "kind": "get", "name": "config", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#config", "access": "public", "description": "Gets the configuration information for the bid entity.", "lineNumber": 50, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 338, "kind": "get", "name": "columns", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#columns", "access": "public", "description": "Columns including any linked inventory data", "lineNumber": 59, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 339, "kind": "get", "name": "rows", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#rows", "access": "public", "description": "Rows including any linked inventory data", "lineNumber": 68, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 340, "kind": "get", "name": "inventoryLink", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#inventoryLink", "access": "public", "description": "Currently linked inventory type", "lineNumber": 89, "type": { "nullable": null, "types": [ "string", "null" ], "spread": false, "description": null } }, { "__docId__": 341, "kind": "method", "name": "getOptions", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#getOptions", "access": "public", "description": "Returns an array of the datatable row options based on the datatable key column.", "lineNumber": 102, "unknown": [ { "tagName": "@returns", "tagValue": " {object[]}" } ], "properties": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "The human readable title for the row. The title is from the key column." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "row_id", "description": "Contains the row id." } ], "return": { "nullable": null, "types": [ "object[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 342, "kind": "method", "name": "dependants", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#dependants", "access": "public", "description": "Gets a list of bid entities that relies on the datatable instance.", "lineNumber": 121, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]} " } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 343, "kind": "method", "name": "isDirty", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#isDirty", "access": "public", "description": "Determines if the datatable is has changed for it's original data.", "lineNumber": 130, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean} " } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 344, "kind": "method", "name": "dirty", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#dirty", "access": "public", "description": "Flags the datatable and corresponding bid as dirty and to be saved.", "lineNumber": 137, "params": [], "return": null }, { "__docId__": 345, "kind": "method", "name": "getValue", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#getValue", "access": "public", "description": "Retrieves a cell value.", "lineNumber": 149, "unknown": [ { "tagName": "@returns", "tagValue": "{?(string|number|boolean)}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "columnId", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "rowId", "description": "" } ], "return": { "nullable": true, "types": [ "string", "number", "boolean" ], "spread": false, "description": "" } }, { "__docId__": 346, "kind": "method", "name": "getColumnValues", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#getColumnValues", "access": "public", "description": "Gets a list of column values.", "lineNumber": 169, "unknown": [ { "tagName": "@returns", "tagValue": "{object[]}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "columnId", "description": "" } ], "properties": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "id", "description": "The row id for the value." }, { "nullable": true, "types": [ "string", "number", "boolean" ], "spread": false, "optional": false, "name": "value", "description": "" } ], "return": { "nullable": null, "types": [ "object[]" ], "spread": false, "description": "" } }, { "__docId__": 347, "kind": "method", "name": "findRowByExternalPartId", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#findRowByExternalPartId", "access": "public", "description": "Find the first row in the datatable which has the given vendor part linked.", "lineNumber": 186, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "vendorName", "description": "" }, { "nullable": null, "types": [ "string", "number" ], "spread": false, "optional": false, "name": "vendorPartId", "description": "" } ], "return": { "nullable": null, "types": [ "string", "undefined" ], "spread": false, "description": "The row ID of the row containing the matching part. Undefined if none found." } }, { "__docId__": 348, "kind": "method", "name": "reload", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": true, "static": false, "longname": "src/domain/Datatable.js~Datatable#reload", "access": "public", "description": "Reload the datatable. Should be done any time an inventory link ID is updated.", "lineNumber": 210, "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 352, "kind": "method", "name": "_getLinkedValues", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#_getLinkedValues", "access": "private", "description": "Generate the rows associated with the part", "lineNumber": 226, "params": [ { "nullable": null, "types": [ "object", "null" ], "spread": false, "optional": false, "name": "part", "description": "" } ], "return": { "nullable": null, "types": [ "string[]" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 353, "kind": "method", "name": "_cachePartValues", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#_cachePartValues", "access": "private", "description": "Cache the part value row by part id", "lineNumber": 245, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "key", "description": "Cache key (usually the Part ID)" }, { "nullable": null, "types": [ "string[]" ], "spread": false, "optional": false, "name": "values", "description": "stuff to put in cache" } ], "return": { "nullable": null, "types": [ "string[]" ], "spread": false, "description": "values" }, "ignore": true }, { "__docId__": 354, "kind": "method", "name": "_setLinkedColumns", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#_setLinkedColumns", "access": "private", "description": "Initialize the datatable with info about linked inventory data if applicable", "lineNumber": 253, "ignore": true, "params": [], "return": null }, { "__docId__": 355, "kind": "member", "name": "_pvlinkColumnIndex", "memberof": "src/domain/Datatable.js~Datatable", "static": false, "longname": "src/domain/Datatable.js~Datatable#_pvlinkColumnIndex", "access": "private", "description": null, "lineNumber": 255, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 356, "kind": "member", "name": "_linkedColumns", "memberof": "src/domain/Datatable.js~Datatable", "static": false, "longname": "src/domain/Datatable.js~Datatable#_linkedColumns", "access": "private", "description": null, "lineNumber": 257, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 357, "kind": "method", "name": "exportData", "memberof": "src/domain/Datatable.js~Datatable", "generator": false, "async": false, "static": false, "longname": "src/domain/Datatable.js~Datatable#exportData", "access": "public", "description": "Exports datatable to core structure.", "lineNumber": 273, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "alwaysIncludeConfig", "description": "Will include config object in export regardless of changed status." } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" } }, { "__docId__": 358, "kind": "file", "name": "src/domain/Field.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/Field.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 359, "kind": "class", "name": "Field", "memberof": "src/domain/Field.js", "static": true, "longname": "src/domain/Field.js~Field", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/Field.js", "importStyle": "Field", "description": "Field Class", "lineNumber": 9, "interface": false, "extends": [ "src/domain/BidEntity.js~BidEntity" ] }, { "__docId__": 360, "kind": "constructor", "name": "constructor", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#constructor", "access": "public", "description": "Creates an instance of Field.", "lineNumber": 15, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "fieldData", "description": "" }, { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ] }, { "__docId__": 361, "kind": "member", "name": "bid", "memberof": "src/domain/Field.js~Field", "static": false, "longname": "src/domain/Field.js~Field#bid", "access": "public", "description": "Reference to the bid that the field belongs to.", "lineNumber": 21, "type": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": null } }, { "__docId__": 362, "kind": "member", "name": "_data", "memberof": "src/domain/Field.js~Field", "static": false, "longname": "src/domain/Field.js~Field#_data", "access": "private", "description": null, "lineNumber": 22, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 363, "kind": "member", "name": "_original", "memberof": "src/domain/Field.js~Field", "static": false, "longname": "src/domain/Field.js~Field#_original", "access": "private", "description": null, "lineNumber": 23, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 364, "kind": "member", "name": "_autoPopulateService", "memberof": "src/domain/Field.js~Field", "static": false, "longname": "src/domain/Field.js~Field#_autoPopulateService", "access": "private", "description": null, "lineNumber": 24, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 365, "kind": "get", "name": "value", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#value", "access": "public", "description": "Gets value of the field.\nIf the field is of a list type, will return the associated datatable row id.", "lineNumber": 33, "type": { "nullable": null, "types": [ "string", "number", "boolean" ], "spread": false, "description": null } }, { "__docId__": 366, "kind": "set", "name": "value", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#value", "access": "public", "description": "Sets the field value. Marks field as dirty", "lineNumber": 64, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null }, "emits": [ { "types": [ "updated" ], "description": "" } ] }, { "__docId__": 367, "kind": "get", "name": "actualValue", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#actualValue", "access": "public", "description": "Returns the actual value of the field after the project has been completed and reviewed for reconciliation.", "lineNumber": 97, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 368, "kind": "set", "name": "actualValue", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#actualValue", "access": "public", "description": "Sets the actual value for reconciliation. Marks field as dirty.", "lineNumber": 105, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 369, "kind": "get", "name": "anchor", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#anchor", "access": "public", "description": "Returns the anchor identifier of the field.\nAnchors are a common global identifier that help identify similar fields across different assemblies.\nThey should be unique to their assembly.\nUsing anchors allow for greater automation potential.", "lineNumber": 119, "type": { "nullable": null, "types": [ "string", "null" ], "spread": false, "description": null } }, { "__docId__": 370, "kind": "get", "name": "fieldType", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#fieldType", "access": "public", "description": "Gets the field type.\nOptions: text, boolean, number, list", "lineNumber": 129, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 371, "kind": "get", "name": "definitionId", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#definitionId", "access": "public", "description": "Gets the field's definition id.", "lineNumber": 139, "deprecated": "Definition ids will become obsolete in planned data structure upgrade.", "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 372, "kind": "get", "name": "config", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#config", "access": "public", "description": "Gets the configuration information for the bid entity.", "lineNumber": 148, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 373, "kind": "get", "name": "isAutoSelected", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#isAutoSelected", "access": "public", "description": "Determines if the current value is the result of being auto populated due to the field's ruleset.", "lineNumber": 157, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 374, "kind": "method", "name": "assess", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#assess", "access": "public", "description": "Assess the field, determining if it should be auto populated.", "lineNumber": 169, "params": [ { "nullable": true, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "dependency", "description": "The calling dependency." } ], "emits": [ { "types": [ "assessing" ], "description": "Fires event before assessment." }, { "types": [ "assessed" ], "description": "Fires event after assessment." }, { "types": [ "updated" ], "description": "Fires event if the field has been changed during assessment." } ], "return": null }, { "__docId__": 375, "kind": "method", "name": "bind", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#bind", "access": "public", "description": "Binds the \"updated\" event for all dependant bid entities.", "lineNumber": 187, "params": [], "return": null }, { "__docId__": 376, "kind": "method", "name": "getAssembly", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#getAssembly", "access": "public", "description": "Get the field's assembly if it has one", "lineNumber": 203, "return": { "nullable": null, "types": [ "Assembly", "undefined" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 377, "kind": "method", "name": "setAssembly", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#setAssembly", "access": "public", "description": "Adds the field to an assembly.", "lineNumber": 213, "params": [ { "nullable": null, "types": [ "Assembly", "string" ], "spread": false, "optional": false, "name": "assembly", "description": "The assembly entity or an assembly ref id" } ], "return": { "nullable": null, "types": [ "Assembly" ], "spread": false, "description": "the new assembly setting" } }, { "__docId__": 378, "kind": "method", "name": "unsetAssembly", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#unsetAssembly", "access": "public", "description": "Removes any assembly reference from the field.", "lineNumber": 228, "return": { "nullable": null, "types": [ "void" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 379, "kind": "method", "name": "dependencies", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#dependencies", "access": "public", "description": "Returns all the dependencies that the field relies on.", "lineNumber": 238, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]}" } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 380, "kind": "method", "name": "referenceIsEmpty", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#referenceIsEmpty", "access": "public", "description": " Determines if a field has a dependency reference.", "lineNumber": 256, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 381, "kind": "method", "name": "dependants", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#dependants", "access": "public", "description": "Gets all the bid entities that relay on the field instance.", "lineNumber": 265, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]}" } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 382, "kind": "method", "name": "getDatatable", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#getDatatable", "access": "public", "description": "If the field has a fieldType of \"list\", getDatatable will return the\ndatatable instance that it relies on, otherwise will return null.", "lineNumber": 276, "unknown": [ { "tagName": "@returns", "tagValue": " {?Datatable}" } ], "return": { "nullable": true, "types": [ "Datatable" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 383, "kind": "method", "name": "getListOptions", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#getListOptions", "access": "public", "description": "Gets a list of options bound to a datatable.", "lineNumber": 289, "unknown": [ { "tagName": "@returns", "tagValue": "{object[]}" } ], "properties": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "row_id", "description": "The id of a datatable row. This value should to be applied to the {@link Field.value} to selelect specific row." } ], "return": { "nullable": null, "types": [ "object[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 384, "kind": "method", "name": "getSelectedOption", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#getSelectedOption", "access": "public", "description": "Gets the selected list option.", "lineNumber": 301, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "properties": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "row_id", "description": "The id of a datatable row." } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 385, "kind": "method", "name": "getSelectedOptionValue", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#getSelectedOptionValue", "access": "public", "description": "Gets the value of the selected field list based on the datatable column id.", "lineNumber": 316, "unknown": [ { "tagName": "@returns", "tagValue": "{?(string|number|boolean)}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "datatableColumnId", "description": "" } ], "return": { "nullable": true, "types": [ "string", "number", "boolean" ], "spread": false, "description": "" } }, { "__docId__": 386, "kind": "method", "name": "exportData", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#exportData", "access": "public", "description": "Exports internal data.", "lineNumber": 329, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "alwaysIncludeConfig", "description": "Will include config object in export regardless of changed status." } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" } }, { "__docId__": 387, "kind": "method", "name": "hasNullDependency", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#hasNullDependency", "access": "public", "description": "Determines if the field has any null or undefined dependencies", "lineNumber": 340, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 388, "kind": "method", "name": "isDirty", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#isDirty", "access": "public", "description": "Determines if instance is dirty.", "lineNumber": 349, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 389, "kind": "method", "name": "dirty", "memberof": "src/domain/Field.js~Field", "generator": false, "async": false, "static": false, "longname": "src/domain/Field.js~Field#dirty", "access": "public", "description": "Flags the field and corresponding bid as dirty and to be saved.", "lineNumber": 356, "params": [], "return": null }, { "__docId__": 390, "kind": "file", "name": "src/domain/FieldGroup.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/FieldGroup.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 391, "kind": "class", "name": "FieldGroup", "memberof": "src/domain/FieldGroup.js", "static": true, "longname": "src/domain/FieldGroup.js~FieldGroup", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/FieldGroup.js", "importStyle": "FieldGroup", "description": "Field Group Class", "lineNumber": 8, "interface": false, "extends": [ "src/domain/BidEntity.js~BidEntity" ] }, { "__docId__": 392, "kind": "constructor", "name": "constructor", "memberof": "src/domain/FieldGroup.js~FieldGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#constructor", "access": "public", "description": "Creates an instance of FieldGroup.", "lineNumber": 14, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "fieldGroupData", "description": "" }, { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ] }, { "__docId__": 393, "kind": "member", "name": "bid", "memberof": "src/domain/FieldGroup.js~FieldGroup", "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#bid", "access": "public", "description": "Reference to the bid that the field group belongs to.", "lineNumber": 20, "type": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": null } }, { "__docId__": 394, "kind": "member", "name": "_original", "memberof": "src/domain/FieldGroup.js~FieldGroup", "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#_original", "access": "private", "description": null, "lineNumber": 21, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 395, "kind": "member", "name": "_data", "memberof": "src/domain/FieldGroup.js~FieldGroup", "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#_data", "access": "private", "description": null, "lineNumber": 22, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 396, "kind": "get", "name": "config", "memberof": "src/domain/FieldGroup.js~FieldGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#config", "access": "public", "description": "Holds the Field Group configuration information.", "lineNumber": 29, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 397, "kind": "method", "name": "getFields", "memberof": "src/domain/FieldGroup.js~FieldGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#getFields", "access": "public", "description": "Retrieve the fields belonging to the group keyed by reference", "lineNumber": 38, "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 398, "kind": "method", "name": "getAssembly", "memberof": "src/domain/FieldGroup.js~FieldGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#getAssembly", "access": "public", "description": null, "lineNumber": 56, "undocument": true, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 399, "kind": "method", "name": "setAssembly", "memberof": "src/domain/FieldGroup.js~FieldGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#setAssembly", "access": "public", "description": "Adds the field group to an assembly.", "lineNumber": 66, "params": [ { "nullable": null, "types": [ "Assembly", "string" ], "spread": false, "optional": false, "name": "assembly", "description": "The assembly entity or an assembly ref id" } ], "return": { "nullable": null, "types": [ "Assembly" ], "spread": false, "description": "the new assembly setting" } }, { "__docId__": 400, "kind": "method", "name": "unsetAssembly", "memberof": "src/domain/FieldGroup.js~FieldGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#unsetAssembly", "access": "public", "description": "Removes any assembly reference from the field group.", "lineNumber": 82, "return": { "nullable": null, "types": [ "void" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 401, "kind": "method", "name": "isDirty", "memberof": "src/domain/FieldGroup.js~FieldGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#isDirty", "access": "public", "description": "Determines if the field group is changed for it's original data.", "lineNumber": 92, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 402, "kind": "method", "name": "dirty", "memberof": "src/domain/FieldGroup.js~FieldGroup", "generator": false, "async": false, "static": false, "longname": "src/domain/FieldGroup.js~FieldGroup#dirty", "access": "public", "description": "Flags the field group and corresponding bid as dirty and to be saved.", "lineNumber": 99, "params": [], "return": null }, { "__docId__": 403, "kind": "file", "name": "src/domain/LineItem.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/LineItem.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 404, "kind": "class", "name": "LineItem", "memberof": "src/domain/LineItem.js", "static": true, "longname": "src/domain/LineItem.js~LineItem", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/LineItem.js", "importStyle": "LineItem", "description": "Represents line item data.", "lineNumber": 25, "interface": false, "extends": [ "src/domain/BidEntity.js~BidEntity" ] }, { "__docId__": 405, "kind": "constructor", "name": "constructor", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#constructor", "access": "public", "description": "Creates an instance of LineItem.", "lineNumber": 31, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "entityData", "description": "" }, { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ] }, { "__docId__": 406, "kind": "member", "name": "bid", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#bid", "access": "public", "description": "Reference to the bid that the line item belongs to.", "lineNumber": 37, "type": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": null } }, { "__docId__": 407, "kind": "member", "name": "maxEvents", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#maxEvents", "access": "public", "description": null, "lineNumber": 38, "undocument": true, "type": { "types": [ "number" ] } }, { "__docId__": 408, "kind": "member", "name": "_originalConfig", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#_originalConfig", "access": "private", "description": null, "lineNumber": 39, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 409, "kind": "member", "name": "_hasConfigEverChanged", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#_hasConfigEverChanged", "access": "private", "description": null, "lineNumber": 40, "undocument": true, "ignore": true, "type": { "types": [ "boolean" ] } }, { "__docId__": 410, "kind": "member", "name": "_data", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#_data", "access": "private", "description": null, "lineNumber": 41, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 411, "kind": "member", "name": "_ruleService", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#_ruleService", "access": "private", "description": null, "lineNumber": 42, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 412, "kind": "member", "name": "_predictionService", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#_predictionService", "access": "private", "description": null, "lineNumber": 44, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 413, "kind": "member", "name": "_industryWidePredictionService", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#_industryWidePredictionService", "access": "private", "description": null, "lineNumber": 45, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 414, "kind": "member", "name": "_cacheValues", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#_cacheValues", "access": "private", "description": null, "lineNumber": 46, "undocument": true, "ignore": true, "type": { "types": [ "{}" ] } }, { "__docId__": 415, "kind": "member", "name": "_undefinedPropFlags", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#_undefinedPropFlags", "access": "private", "description": null, "lineNumber": 47, "undocument": true, "ignore": true, "type": { "types": [ "*[]" ] } }, { "__docId__": 416, "kind": "member", "name": "accountStoplightIndicator", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#accountStoplightIndicator", "access": "public", "description": null, "lineNumber": 49, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 417, "kind": "member", "name": "industryStoplightIndicator", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#industryStoplightIndicator", "access": "public", "description": null, "lineNumber": 50, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 418, "kind": "method", "name": "setPredictionService", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#setPredictionService", "access": "public", "description": "Sets the current prediction service being used as well as the distribution ranges.", "lineNumber": 56, "params": [ { "name": "serviceType", "types": [ "*" ] } ], "return": null }, { "__docId__": 419, "kind": "member", "name": "predictionType", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#predictionType", "access": "public", "description": null, "lineNumber": 57, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 420, "kind": "member", "name": "_currentPredictionService", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#_currentPredictionService", "access": "private", "description": null, "lineNumber": 61, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 421, "kind": "member", "name": "_distributionRanges", "memberof": "src/domain/LineItem.js~LineItem", "static": false, "longname": "src/domain/LineItem.js~LineItem#_distributionRanges", "access": "private", "description": null, "lineNumber": 62, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 424, "kind": "get", "name": "base", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#base", "access": "public", "description": "Base Property", "lineNumber": 76, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 425, "kind": "set", "name": "base", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#base", "access": "public", "description": "", "lineNumber": 83, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 428, "kind": "get", "name": "wage", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#wage", "access": "public", "description": "Wage Property", "lineNumber": 106, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 429, "kind": "set", "name": "wage", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#wage", "access": "public", "description": "", "lineNumber": 113, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 431, "kind": "get", "name": "isIncluded", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#isIncluded", "access": "public", "description": "Is Included Property", "lineNumber": 129, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 432, "kind": "set", "name": "isIncluded", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#isIncluded", "access": "public", "description": "", "lineNumber": 136, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 433, "kind": "get", "name": "isWeighted", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#isWeighted", "access": "public", "description": "Is Weighted Property - determines whether or not the contribution weight should be applied to the cost", "lineNumber": 151, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 434, "kind": "set", "name": "isWeighted", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#isWeighted", "access": "public", "description": "", "lineNumber": 161, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 435, "kind": "get", "name": "laborHours", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#laborHours", "access": "public", "description": "Labor Hours Property", "lineNumber": 176, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 436, "kind": "set", "name": "laborHours", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#laborHours", "access": "public", "description": "", "lineNumber": 183, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 438, "kind": "get", "name": "burden", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#burden", "access": "public", "description": "Burden Property", "lineNumber": 210, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 439, "kind": "set", "name": "burden", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#burden", "access": "public", "description": "", "lineNumber": 217, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 441, "kind": "get", "name": "workup", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#workup", "access": "public", "description": "", "lineNumber": 232, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 442, "kind": "get", "name": "scalar", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#scalar", "access": "public", "description": "Scalar Property", "lineNumber": 247, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 443, "kind": "get", "name": "perQuantity", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#perQuantity", "access": "public", "description": "Per Quantity Property", "lineNumber": 280, "deprecated": "Please use Scalar instead.", "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 444, "kind": "set", "name": "perQuantity", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#perQuantity", "access": "public", "description": "", "lineNumber": 288, "deprecated": "Please use Scalar instead.", "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 447, "kind": "get", "name": "escalator", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#escalator", "access": "public", "description": "Escalator Property", "lineNumber": 311, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 448, "kind": "set", "name": "escalator", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#escalator", "access": "public", "description": "", "lineNumber": 318, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 450, "kind": "get", "name": "quantity", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#quantity", "access": "public", "description": "Quantity Property", "lineNumber": 336, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 451, "kind": "set", "name": "quantity", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#quantity", "access": "public", "description": "", "lineNumber": 343, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 454, "kind": "get", "name": "multiplier", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#multiplier", "access": "public", "description": "", "lineNumber": 365, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 455, "kind": "set", "name": "multiplier", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#multiplier", "access": "public", "description": "", "lineNumber": 372, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 457, "kind": "get", "name": "cost", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#cost", "access": "public", "description": "Cost Property", "lineNumber": 391, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 458, "kind": "set", "name": "cost", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#cost", "access": "public", "description": "", "lineNumber": 398, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 460, "kind": "get", "name": "tax", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#tax", "access": "public", "description": "Tax Property", "lineNumber": 424, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 461, "kind": "set", "name": "tax", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#tax", "access": "public", "description": "", "lineNumber": 431, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 464, "kind": "get", "name": "costWithTax", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#costWithTax", "access": "public", "description": "Cost With Tax", "lineNumber": 456, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 465, "kind": "get", "name": "costWithMarkup", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#costWithMarkup", "access": "public", "description": "Cost With Markup", "lineNumber": 464, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 466, "kind": "get", "name": "ohp", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#ohp", "access": "public", "description": "OH&P Property (overhead and profit)", "lineNumber": 472, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 467, "kind": "set", "name": "ohp", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#ohp", "access": "public", "description": "", "lineNumber": 479, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 469, "kind": "get", "name": "taxPercent", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#taxPercent", "access": "public", "description": "Tax Percent Property", "lineNumber": 499, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 470, "kind": "set", "name": "taxPercent", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#taxPercent", "access": "public", "description": "", "lineNumber": 506, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 472, "kind": "get", "name": "markup", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#markup", "access": "public", "description": "Markup Property", "lineNumber": 526, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 473, "kind": "set", "name": "markup", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#markup", "access": "public", "description": "", "lineNumber": 533, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 475, "kind": "get", "name": "markupPercent", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#markupPercent", "access": "public", "description": "Markup Percent Property", "lineNumber": 550, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 476, "kind": "set", "name": "markupPercent", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#markupPercent", "access": "public", "description": "", "lineNumber": 557, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 478, "kind": "get", "name": "price", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#price", "access": "public", "description": "Price Property", "lineNumber": 576, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 479, "kind": "set", "name": "price", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#price", "access": "public", "description": "", "lineNumber": 583, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 481, "kind": "get", "name": "priceWatt", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#priceWatt", "access": "public", "description": "Price per watt", "lineNumber": 601, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 482, "kind": "set", "name": "priceWatt", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#priceWatt", "access": "public", "description": "", "lineNumber": 612, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 484, "kind": "get", "name": "costWatt", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#costWatt", "access": "public", "description": "Cost per watt", "lineNumber": 623, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 485, "kind": "set", "name": "costWatt", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#costWatt", "access": "public", "description": "", "lineNumber": 634, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 487, "kind": "get", "name": "definitionId", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#definitionId", "access": "public", "description": "Gets the line item's definition id.", "lineNumber": 646, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 488, "kind": "get", "name": "tags", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#tags", "access": "public", "description": "Gets the line items tags array", "lineNumber": 655, "type": { "nullable": null, "types": [ "Array" ], "spread": false, "description": null } }, { "__docId__": 489, "kind": "get", "name": "config", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#config", "access": "public", "description": "Config Property", "lineNumber": 663, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 490, "kind": "get", "name": "subtotal", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#subtotal", "access": "public", "description": "Gets Subtotal aka Initial Results.", "lineNumber": 672, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "type": { "types": [ "*" ] } }, { "__docId__": 491, "kind": "get", "name": "useComputedValueWhenAvailable", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#useComputedValueWhenAvailable", "access": "public", "description": "When using predictive pricing, should the computed value be used if it's available?", "lineNumber": 682, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 492, "kind": "set", "name": "useComputedValueWhenAvailable", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#useComputedValueWhenAvailable", "access": "public", "description": "Overrides the bid variable for the line item", "lineNumber": 693, "type": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": null } }, { "__docId__": 493, "kind": "method", "name": "override", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#override", "access": "public", "description": "", "lineNumber": 709, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "property", "description": "" }, { "nullable": null, "types": [ "number", "string", "boolean" ], "spread": false, "optional": false, "name": "value", "description": "" } ], "return": null }, { "__docId__": 494, "kind": "method", "name": "isOverridden", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#isOverridden", "access": "public", "description": "Determine if the line item or one of its properties is overridden", "lineNumber": 733, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "property", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 495, "kind": "method", "name": "isPredicted", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#isPredicted", "access": "public", "description": "Determines if the line item or a property is predicted by recursively checking the\n properties calculation dependencies prediction status.", "lineNumber": 748, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "name": "property", "description": "snake case property name" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 496, "kind": "method", "name": "resetProperty", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#resetProperty", "access": "public", "description": "Resets a specific line item member, remove override value.", "lineNumber": 783, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "property", "description": "" } ], "return": null }, { "__docId__": 497, "kind": "method", "name": "resetMarkup", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#resetMarkup", "access": "public", "description": "Resets the markup, removing user override inputs for markup and markup percent.", "lineNumber": 798, "params": [], "return": null }, { "__docId__": 498, "kind": "method", "name": "reset", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#reset", "access": "public", "description": "Resets the line item, removing all user override inputs.", "lineNumber": 809, "params": [], "return": null }, { "__docId__": 499, "kind": "method", "name": "isLabor", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#isLabor", "access": "public", "description": "Determines if the line item represents labor costs.", "lineNumber": 823, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 500, "kind": "method", "name": "setWorkupField", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#setWorkupField", "access": "public", "description": "Bind a field dependency to the workup", "lineNumber": 832, "params": [ { "nullable": null, "types": [ "Field" ], "spread": false, "optional": true, "defaultValue": "null", "defaultRaw": null, "name": "field", "description": "The field entity to bind to the workup. Must be a 'list' type field." } ], "return": null }, { "__docId__": 501, "kind": "method", "name": "assess", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#assess", "access": "public", "description": "Assess line item for changes.", "lineNumber": 861, "params": [ { "nullable": true, "types": [ "BidEntity" ], "spread": false, "optional": true, "name": "dependency", "description": "The calling dependency" }, { "nullable": true, "types": [ "boolean" ], "spread": false, "optional": true, "name": "forceUpdate", "description": "" } ], "emits": [ { "types": [ "assessing" ], "description": "fires event before assessement." }, { "types": [ "assessed" ], "description": "" }, { "types": [ "updated" ], "description": "" } ], "return": null }, { "__docId__": 502, "kind": "method", "name": "isDirty", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#isDirty", "access": "public", "description": "Determines if the line item is has changed for it's original data.", "lineNumber": 918, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 503, "kind": "method", "name": "dirty", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#dirty", "access": "public", "description": "Flags the line item and corresponding bid as dirty and to be saved.", "lineNumber": 925, "params": [], "return": null }, { "__docId__": 506, "kind": "method", "name": "bind", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#bind", "access": "public", "description": "Binds the \"updated\" event for all dependant bid entities.", "lineNumber": 938, "params": [], "return": null }, { "__docId__": 507, "kind": "method", "name": "getWorkup", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getWorkup", "access": "public", "description": null, "lineNumber": 949, "undocument": true, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 508, "kind": "method", "name": "_getWorkup", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getWorkup", "access": "private", "description": null, "lineNumber": 953, "undocument": true, "ignore": true, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 509, "kind": "method", "name": "dependencies", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#dependencies", "access": "public", "description": "Gets a list of bid entities that the line item instance relies on.", "lineNumber": 962, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]}" } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 510, "kind": "method", "name": "dependants", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#dependants", "access": "public", "description": "Gets dependant bid entities that rely on line item instance.", "lineNumber": 992, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]}" } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 511, "kind": "method", "name": "_bindLineItemDependencies", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_bindLineItemDependencies", "access": "private", "description": null, "lineNumber": 996, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 512, "kind": "method", "name": "_bindLineItemRuleDependencies", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_bindLineItemRuleDependencies", "access": "private", "description": null, "lineNumber": 1007, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 513, "kind": "method", "name": "_bindWorkupDependencies", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_bindWorkupDependencies", "access": "private", "description": null, "lineNumber": 1022, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 514, "kind": "method", "name": "_bindLineItemPredictionDependencies", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_bindLineItemPredictionDependencies", "access": "private", "description": "Bind the dependencies of the prediction models", "lineNumber": 1033, "ignore": true, "params": [], "return": { "types": [ "boolean" ] } }, { "__docId__": 515, "kind": "method", "name": "_bindPredictionBidVariables", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_bindPredictionBidVariables", "access": "private", "description": "Predictive pricing bid variable need to be explicitely bound to the line items since they are not\nincluded in the entity's dependencies.", "lineNumber": 1048, "ignore": true, "params": [], "return": null }, { "__docId__": 516, "kind": "method", "name": "_bindMarkupStrategy", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_bindMarkupStrategy", "access": "private", "description": "Bind to markup strategy variable", "lineNumber": 1068, "ignore": true, "params": [], "return": null }, { "__docId__": 517, "kind": "method", "name": "_bindTaxableLabor", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_bindTaxableLabor", "access": "private", "description": "Bind to taxable labor variable", "lineNumber": 1078, "ignore": true, "params": [], "return": null }, { "__docId__": 518, "kind": "method", "name": "_bindTaxProfit", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_bindTaxProfit", "access": "private", "description": null, "lineNumber": 1087, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 519, "kind": "method", "name": "assessWorkup", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#assessWorkup", "access": "public", "description": null, "lineNumber": 1094, "undocument": true, "params": [], "return": null }, { "__docId__": 520, "kind": "method", "name": "_applyProperty", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_applyProperty", "access": "private", "description": "", "lineNumber": 1109, "ignore": true, "params": [ { "name": "property", "types": [ "*" ] }, { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 521, "kind": "method", "name": "_applyConfigArray", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_applyConfigArray", "access": "private", "description": "Checks to see if the supplied array is different than the currently assigned value\nIf so, it updates the value", "lineNumber": 1125, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "whether the value was updated or not" }, "ignore": true, "params": [ { "name": "property", "types": [ "*" ] }, { "name": "arr", "types": [ "*" ] } ] }, { "__docId__": 522, "kind": "method", "name": "_applyConfig", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_applyConfig", "access": "private", "description": "", "lineNumber": 1135, "ignore": true, "params": [ { "name": "property", "types": [ "*" ] }, { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 523, "kind": "method", "name": "_applyMarkupChange", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_applyMarkupChange", "access": "private", "description": "", "lineNumber": 1148, "ignore": true, "params": [], "return": null }, { "__docId__": 524, "kind": "method", "name": "_reverseComputeLaborHours", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_reverseComputeLaborHours", "access": "private", "description": "", "lineNumber": 1161, "ignore": true, "params": [ { "name": "cost", "types": [ "*" ] }, { "name": "wage", "types": [ "*" ] }, { "name": "burden", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 525, "kind": "method", "name": "_applyPriceChange", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_applyPriceChange", "access": "private", "description": "Internal method to calculate a Unit price change.", "lineNumber": 1170, "ignore": true, "params": [], "return": null }, { "__docId__": 528, "kind": "method", "name": "_applyCostChange", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_applyCostChange", "access": "private", "description": "Internal method that recalculates a line item cost change.", "lineNumber": 1186, "ignore": true, "params": [], "return": null }, { "__docId__": 529, "kind": "method", "name": "_applyTaxPercentChange", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_applyTaxPercentChange", "access": "private", "description": null, "lineNumber": 1205, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 530, "kind": "method", "name": "_applyMarkupPercent", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_applyMarkupPercent", "access": "private", "description": null, "lineNumber": 1209, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 531, "kind": "method", "name": "_getExtraScalarDependencies", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getExtraScalarDependencies", "access": "private", "description": "Retrieves extra scalar dependency contracts.", "lineNumber": 1222, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 532, "kind": "method", "name": "_getExtraTagDependencies", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getExtraTagDependencies", "access": "private", "description": "Retrieves extra tag dependency contracts.", "lineNumber": 1233, "return": { "nullable": null, "types": [ "Array" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 533, "kind": "method", "name": "_getBaseValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getBaseValue", "access": "private", "description": "", "lineNumber": 1243, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 534, "kind": "method", "name": "_getWageValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getWageValue", "access": "private", "description": "", "lineNumber": 1255, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 535, "kind": "method", "name": "_getTaxableSubtotal", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getTaxableSubtotal", "access": "private", "description": null, "lineNumber": 1262, "undocument": true, "ignore": true, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 536, "kind": "method", "name": "_getIsIncludedValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getIsIncludedValue", "access": "private", "description": "Internally retrieves the non-cached computed IsIncluded value.", "lineNumber": 1271, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 537, "kind": "method", "name": "_getIsWeightedValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getIsWeightedValue", "access": "private", "description": "Internally retrieves the non-cached computed IsWeighted value.", "lineNumber": 1282, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 538, "kind": "method", "name": "_getLaborHoursValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getLaborHoursValue", "access": "private", "description": "Internally retrieves the non-cached computed Labor Hours value.", "lineNumber": 1293, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 539, "kind": "method", "name": "_getBurdenValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getBurdenValue", "access": "private", "description": "Internally retrieves the non-cached computed Burden value.", "lineNumber": 1333, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 540, "kind": "method", "name": "_getScalarValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getScalarValue", "access": "private", "description": "Internally retrieves the non-cached computed Scalar value.", "lineNumber": 1345, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 541, "kind": "method", "name": "_getTagValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getTagValue", "access": "private", "description": "Internally retrieves the non-cached Tag value.", "lineNumber": 1367, "return": { "nullable": null, "types": [ "string", "number", "boolean)[]" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 542, "kind": "method", "name": "_getPerQuantityValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getPerQuantityValue", "access": "private", "description": "Internally retrieves the non-cached computed Per Quantity value.", "lineNumber": 1387, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 543, "kind": "method", "name": "_getEscalatorValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getEscalatorValue", "access": "private", "description": "Internally retrieves the non-cached computed Escalator value.", "lineNumber": 1412, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 544, "kind": "method", "name": "_getOhpValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getOhpValue", "access": "private", "description": "Internally retrieves the non-cached computed OH&P value.", "lineNumber": 1424, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 545, "kind": "method", "name": "_getQuantityValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getQuantityValue", "access": "private", "description": "Internally retrieves the non-cached computed Quantity value.", "lineNumber": 1436, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 546, "kind": "method", "name": "_getCostValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getCostValue", "access": "private", "description": "", "lineNumber": 1454, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 547, "kind": "method", "name": "_getTaxValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getTaxValue", "access": "private", "description": "", "lineNumber": 1499, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 548, "kind": "method", "name": "_getTaxPercentValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getTaxPercentValue", "access": "private", "description": "", "lineNumber": 1519, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 549, "kind": "method", "name": "_getMarkupValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getMarkupValue", "access": "private", "description": "", "lineNumber": 1530, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 550, "kind": "method", "name": "_getMarkupPercentValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getMarkupPercentValue", "access": "private", "description": "", "lineNumber": 1554, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 551, "kind": "method", "name": "_getPriceValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getPriceValue", "access": "private", "description": "", "lineNumber": 1564, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 552, "kind": "method", "name": "_evaluateDependency", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_evaluateDependency", "access": "private", "description": "Gets the value for a dependency. If a dependency is undefined, it will be flagged in the config.undefined_prop_flags", "lineNumber": 1583, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "dependencyContract", "description": "The dependency contract" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "propName", "description": "The name of the line item prop that depends on this dependency.\n Needed so that it can be flagged if the dependency is null or flagged as undefined." } ], "return": { "nullable": null, "types": [ "number", "boolean", "undefined", "null" ], "spread": false, "description": "The resolved dependency value" }, "ignore": true }, { "__docId__": 553, "kind": "method", "name": "_invalidateCachedValues", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_invalidateCachedValues", "access": "private", "description": "Clear the locally cached values", "lineNumber": 1610, "ignore": true, "params": [], "return": null }, { "__docId__": 554, "kind": "method", "name": "_resetUndefinedPropFlags", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_resetUndefinedPropFlags", "access": "private", "description": "Reset the flags for props that rely on undefined dependencies in assessment", "lineNumber": 1619, "ignore": true, "params": [], "return": null }, { "__docId__": 556, "kind": "method", "name": "hasNullDependency", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#hasNullDependency", "access": "public", "description": "Determines if the field is dependent on null/undefined dependencies", "lineNumber": 1629, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "field", "description": "The field value in question" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 557, "kind": "method", "name": "_undefinedPropsIncludes", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_undefinedPropsIncludes", "access": "private", "description": "Checks if any of the given dependencies have been flagged as undefined during the assessment", "lineNumber": 1648, "params": [ { "nullable": null, "types": [ "...string" ], "spread": true, "optional": false, "name": "dependencies", "description": "Dependencies to check" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "Whether or not any of the given dependencies have relied on any numbers that were not fully defined" }, "ignore": true }, { "__docId__": 558, "kind": "method", "name": "_applyUndefinedPropFlags", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_applyUndefinedPropFlags", "access": "private", "description": "Determine if the undefined props flags have changed during the assesment. If so update the config var.", "lineNumber": 1660, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "Whether or not there has been a change" }, "ignore": true, "params": [] }, { "__docId__": 559, "kind": "method", "name": "_shouldPredict", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_shouldPredict", "access": "private", "description": "Determines whether a prediction should be used during assessment given the dependencies", "lineNumber": 1678, "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "propsToConsider", "description": "The required properties used in this calculation" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "Whether or not a predicted value should be used" }, "ignore": true }, { "__docId__": 560, "kind": "method", "name": "getPredictedCost", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getPredictedCost", "access": "public", "description": "Evaluates the cost prediction models for the line item.", "lineNumber": 1703, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "The predicted cost value" }, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ] }, { "__docId__": 561, "kind": "method", "name": "getPredictedLaborHours", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getPredictedLaborHours", "access": "public", "description": "Evaluates the labor hours prediction models for the line item.", "lineNumber": 1726, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "The predicted cost value" }, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ] }, { "__docId__": 562, "kind": "method", "name": "getPredictedCostExperimental", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getPredictedCostExperimental", "access": "public", "description": null, "lineNumber": 1745, "undocument": true, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ], "return": { "types": [ "*" ] } }, { "__docId__": 563, "kind": "method", "name": "getPredictedLaborHoursExperimental", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getPredictedLaborHoursExperimental", "access": "public", "description": null, "lineNumber": 1750, "undocument": true, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ], "return": { "types": [ "*" ] } }, { "__docId__": 564, "kind": "method", "name": "_getExperimentalPrediction", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getExperimentalPrediction", "access": "private", "description": null, "lineNumber": 1755, "undocument": true, "ignore": true, "params": [ { "name": "models", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 565, "kind": "method", "name": "_getStoplightIndicator", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_getStoplightIndicator", "access": "private", "description": "Returns a integer value indicating which distribution range a lineItem's cost falls\nReturns 0,1,2,3,4,5,6 or (this._distributionRanges.length) the value being the percent range that the current cost falls under.\nReturns -1 if the current cost is out of bounds and above (greater than) the predicted value.\nReturns -2 if the current cost is out of bounds and below (less than) the predicted value.\nReturns -3 if the line item has zero prediction models, a predicted value equal to zero or undefined,\nand undefined weightedNormalValues\nReturns -4 if the line item is predicted and not overwritten and the line item is excluded", "lineNumber": 1770, "unknown": [ { "tagName": "@returns", "tagValue": "{number}" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ] }, { "__docId__": 566, "kind": "method", "name": "updateStoplightIndicators", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#updateStoplightIndicators", "access": "public", "description": null, "lineNumber": 1841, "undocument": true, "params": [], "return": null }, { "__docId__": 569, "kind": "method", "name": "getWeightedNormalValues", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getWeightedNormalValues", "access": "public", "description": " Calculate the weighted normal value given a set of distribution ranges.", "lineNumber": 1850, "unknown": [ { "tagName": "@returns", "tagValue": "{array} Array of weighted normal values" } ], "return": { "nullable": null, "types": [ "array" ], "spread": false, "description": "Array of weighted normal values" }, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ] }, { "__docId__": 570, "kind": "method", "name": "getWeightedNormalValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getWeightedNormalValue", "access": "public", "description": " Calculates the weighted normal value at x range", "lineNumber": 1872, "unknown": [ { "tagName": "@returns", "tagValue": "{int|null} weighted normal value" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "range", "description": "" } ], "return": { "nullable": null, "types": [ "int", "null" ], "spread": false, "description": "weighted normal value" } }, { "__docId__": 571, "kind": "method", "name": "getWeightedLaborHours", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getWeightedLaborHours", "access": "public", "description": "Gets an array of the calculated weighted labor hours", "lineNumber": 1904, "unknown": [ { "tagName": "@returns", "tagValue": "{[]}" } ], "return": { "nullable": null, "types": [ "[]" ], "spread": false, "description": "" }, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ] }, { "__docId__": 572, "kind": "method", "name": "getWeightedLaborHourCost", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getWeightedLaborHourCost", "access": "public", "description": "Gets an array of the calculated weighted labor hour cost", "lineNumber": 1948, "unknown": [ { "tagName": "@returns", "tagValue": "{[]}" } ], "return": { "nullable": null, "types": [ "[]" ], "spread": false, "description": "" }, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ] }, { "__docId__": 573, "kind": "method", "name": "getPredictionModels", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getPredictionModels", "access": "public", "description": "Gets the prediction models for the current line item by type", "lineNumber": 1995, "unknown": [ { "tagName": "@returns", "tagValue": "{Object[]}" } ], "return": { "nullable": null, "types": [ "Object[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 574, "kind": "method", "name": "getPredictedValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getPredictedValue", "access": "public", "description": "Gets the predicted value for the line item based on type", "lineNumber": 2028, "unknown": [ { "tagName": "@returns", "tagValue": "{number}" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "params": [ { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ] }, { "__docId__": 575, "kind": "method", "name": "getValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getValue", "access": "public", "description": "Gets the line item's value. Either Cost or Labor Hours", "lineNumber": 2049, "unknown": [ { "tagName": "@returns", "tagValue": "{number}" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 576, "kind": "method", "name": "calculateStdDevSumR2", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#calculateStdDevSumR2", "access": "public", "description": "Calculates the sum of the r2 values from each model's ['standard_deviation'] object", "lineNumber": 2065, "unknown": [ { "tagName": "@returns", "tagValue": "{sumOfR2|null}" } ], "return": { "nullable": null, "types": [ "sumOfR2", "null" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 577, "kind": "method", "name": "calculateNormalError", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#calculateNormalError", "access": "public", "description": "Calculates the normal inverse based on a distribution range, a model's standard_deviation_error_mean and error", "lineNumber": 2102, "unknown": [ { "tagName": "@returns", "tagValue": "{float} The CDF - inverse normal distribution result" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "range", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "model", "description": "" } ], "return": { "nullable": null, "types": [ "float" ], "spread": false, "description": "The CDF - inverse normal distribution result" } }, { "__docId__": 578, "kind": "method", "name": "calculateNormalValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#calculateNormalValue", "access": "public", "description": "Calculates the normal value from the normal error", "lineNumber": 2125, "unknown": [ { "tagName": "@returns", "tagValue": "{number}" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "value", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "error", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" } }, { "__docId__": 579, "kind": "method", "name": "calculateWeightedNormalValue", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#calculateWeightedNormalValue", "access": "public", "description": "Calculates the weighted normal value from the current normal value and sumOfR2 and the next normal value and sumOfR2", "lineNumber": 2137, "unknown": [ { "tagName": "@returns", "tagValue": "{number}" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "currentModelNormalValue", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "currentModelSumR2", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "nextModelNormalValue", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "nextModelSumR2", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" } }, { "__docId__": 580, "kind": "method", "name": "calculateWeightedLaborCost", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#calculateWeightedLaborCost", "access": "public", "description": "Calculates the weighted labor hours cost.\nIf line item has a contribution weight, multiply the result by the contribution", "lineNumber": 2148, "unknown": [ { "tagName": "@returns", "tagValue": "{number}" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "weightedValue", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" } }, { "__docId__": 581, "kind": "method", "name": "applyContributionWeight", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#applyContributionWeight", "access": "public", "description": null, "lineNumber": 2170, "undocument": true, "params": [ { "name": "weightedNormalValues", "types": [ "*" ] }, { "name": "predictionType", "optional": true, "types": [ "string" ], "defaultRaw": "account", "defaultValue": "account" } ], "return": { "types": [ "*" ] } }, { "__docId__": 582, "kind": "method", "name": "exportData", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#exportData", "access": "public", "description": "Exports the line item's internal data structure.", "lineNumber": 2190, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "alwaysIncludeConfig", "description": "Flag to include config object regardless of whether it has changed or not. The config\n is always included if it has been modified but is omitted by to improve save performance\n if there have been no changes by default to improve save performance." } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" } }, { "__docId__": 583, "kind": "method", "name": "moveToComponent", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#moveToComponent", "access": "public", "description": "Moves line item to a new component and self removes from original component in the same {@link ComponentGroup}", "lineNumber": 2200, "params": [ { "nullable": null, "types": [ "Component" ], "spread": false, "optional": false, "name": "component", "description": "" } ], "return": null }, { "__docId__": 584, "kind": "method", "name": "components", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#components", "access": "public", "description": "Gets an array of components that the line item is under.\nA line item is either uncategorized or under one {@link Component} per {@link ComponentGroup}", "lineNumber": 2222, "unknown": [ { "tagName": "@returns", "tagValue": "{Component[]}" } ], "return": { "nullable": null, "types": [ "Component[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 585, "kind": "method", "name": "getAssembly", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#getAssembly", "access": "public", "description": "Get the line item's assembly if it has one", "lineNumber": 2235, "return": { "nullable": null, "types": [ "Assembly", "undefined" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 586, "kind": "method", "name": "setAssembly", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#setAssembly", "access": "public", "description": "Adds the line item to an assembly.", "lineNumber": 2245, "params": [ { "nullable": null, "types": [ "Assembly", "string" ], "spread": false, "optional": false, "name": "assembly", "description": "The assembly entity or an assembly ref id" } ], "return": { "nullable": null, "types": [ "Assembly" ], "spread": false, "description": "the new assembly setting" } }, { "__docId__": 587, "kind": "method", "name": "unsetAssembly", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#unsetAssembly", "access": "public", "description": "Removes any assembly reference from the line item.", "lineNumber": 2257, "return": { "nullable": null, "types": [ "void" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 588, "kind": "method", "name": "_removeFromDynamicGroups", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_removeFromDynamicGroups", "access": "private", "description": null, "lineNumber": 2262, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 589, "kind": "method", "name": "_removeFromComponents", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_removeFromComponents", "access": "private", "description": null, "lineNumber": 2271, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 590, "kind": "method", "name": "_removeFromAssembly", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": false, "static": false, "longname": "src/domain/LineItem.js~LineItem#_removeFromAssembly", "access": "private", "description": null, "lineNumber": 2277, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 591, "kind": "method", "name": "delete", "memberof": "src/domain/LineItem.js~LineItem", "generator": false, "async": true, "static": false, "longname": "src/domain/LineItem.js~LineItem#delete", "access": "public", "description": "Deletes line item.", "lineNumber": 2289, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 592, "kind": "file", "name": "src/domain/Metric.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/Metric.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 593, "kind": "class", "name": "Metric", "memberof": "src/domain/Metric.js", "static": true, "longname": "src/domain/Metric.js~Metric", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/Metric.js", "importStyle": "Metric", "description": "Metric Class", "lineNumber": 15, "unknown": [ { "tagName": "@class", "tagValue": "Metric" } ], "interface": false, "extends": [ "BidEntity" ] }, { "__docId__": 594, "kind": "constructor", "name": "constructor", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#constructor", "access": "public", "description": "Creates an instance of Metric.", "lineNumber": 21, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "metricData", "description": "" }, { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ] }, { "__docId__": 595, "kind": "member", "name": "bid", "memberof": "src/domain/Metric.js~Metric", "static": false, "longname": "src/domain/Metric.js~Metric#bid", "access": "public", "description": "Reference to the bid that the metric belongs to.", "lineNumber": 27, "type": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": null } }, { "__docId__": 596, "kind": "member", "name": "_data", "memberof": "src/domain/Metric.js~Metric", "static": false, "longname": "src/domain/Metric.js~Metric#_data", "access": "private", "description": null, "lineNumber": 28, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 597, "kind": "member", "name": "_original", "memberof": "src/domain/Metric.js~Metric", "static": false, "longname": "src/domain/Metric.js~Metric#_original", "access": "private", "description": null, "lineNumber": 29, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 598, "kind": "get", "name": "value", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#value", "access": "public", "description": "", "lineNumber": 35, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 599, "kind": "set", "name": "value", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#value", "access": "public", "description": "", "lineNumber": 42, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 600, "kind": "get", "name": "actualValue", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#actualValue", "access": "public", "description": "", "lineNumber": 57, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 601, "kind": "set", "name": "actualValue", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#actualValue", "access": "public", "description": "", "lineNumber": 64, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 602, "kind": "get", "name": "config", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#config", "access": "public", "description": "", "lineNumber": 76, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 603, "kind": "get", "name": "definitionId", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#definitionId", "access": "public", "description": "Gets the metrics's definition id.", "lineNumber": 86, "deprecated": "Definition ids will become obsolete in planned data structure upgrade.", "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 604, "kind": "method", "name": "_getBaseValue", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#_getBaseValue", "access": "private", "description": null, "lineNumber": 90, "undocument": true, "ignore": true, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 605, "kind": "method", "name": "_calculateMetricManipulations", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#_calculateMetricManipulations", "access": "private", "description": null, "lineNumber": 107, "undocument": true, "ignore": true, "params": [ { "name": "baseValue", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 606, "kind": "method", "name": "_calculateMetricManipulation", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#_calculateMetricManipulation", "access": "private", "description": null, "lineNumber": 118, "undocument": true, "ignore": true, "params": [ { "name": "metricManipulation", "types": [ "*" ] }, { "name": "baseValue", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 607, "kind": "method", "name": "_evaluateDependency", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#_evaluateDependency", "access": "private", "description": "Evaluates the dependency contract and tracks if a null evaluation was encountered", "lineNumber": 144, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "dependencyContract", "description": "Dependency Contract to evaluate" } ], "return": { "nullable": null, "types": [ "number", "null", "undefined" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 608, "kind": "member", "name": "_nullDependencyCount", "memberof": "src/domain/Metric.js~Metric", "static": false, "longname": "src/domain/Metric.js~Metric#_nullDependencyCount", "access": "private", "description": null, "lineNumber": 161, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 609, "kind": "method", "name": "hasNullDependency", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#hasNullDependency", "access": "public", "description": "Determines if the metric has any null dependencies", "lineNumber": 169, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 610, "kind": "method", "name": "reset", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#reset", "access": "public", "description": "Resets the metric, removing any override value.", "lineNumber": 176, "params": [], "return": null }, { "__docId__": 611, "kind": "method", "name": "dependencies", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#dependencies", "access": "public", "description": "Gets an array of bid entities that the metric relies on.", "lineNumber": 191, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]}" } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 612, "kind": "method", "name": "dependants", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#dependants", "access": "public", "description": "Gets an array of bid entities that rely on the metric", "lineNumber": 218, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]}" } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 613, "kind": "method", "name": "getAssembly", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#getAssembly", "access": "public", "description": "Get the metric assembly if it has one", "lineNumber": 227, "return": { "nullable": null, "types": [ "Assembly", "undefined" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 614, "kind": "method", "name": "setAssembly", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#setAssembly", "access": "public", "description": "Adds the metric to an assembly.", "lineNumber": 237, "params": [ { "nullable": null, "types": [ "Assembly", "string" ], "spread": false, "optional": false, "name": "assembly", "description": "The assembly entity or an assembly ref id" } ], "return": { "nullable": null, "types": [ "Assembly" ], "spread": false, "description": "the new assembly setting" } }, { "__docId__": 615, "kind": "method", "name": "unsetAssembly", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#unsetAssembly", "access": "public", "description": "Removes any assembly reference from the metric.", "lineNumber": 252, "return": { "nullable": null, "types": [ "void" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 616, "kind": "method", "name": "assess", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#assess", "access": "public", "description": "Assess metric for changes.", "lineNumber": 264, "emits": [ { "types": [ "assessing" ], "description": "fires event before assessement." }, { "types": [ "assessed" ], "description": "fires after assessment is complete." }, { "types": [ "updated" ], "description": "fires only if there has been a change." } ], "params": [], "return": null }, { "__docId__": 618, "kind": "method", "name": "bind", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#bind", "access": "public", "description": "Binds the \"updated\" event for all dependant bid entities.", "lineNumber": 298, "params": [], "return": null }, { "__docId__": 619, "kind": "method", "name": "isDirty", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#isDirty", "access": "public", "description": "Determines if metric instance is dirty.", "lineNumber": 329, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 620, "kind": "method", "name": "dirty", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#dirty", "access": "public", "description": "Flags the metric and corresponding bid as dirty and to be saved.", "lineNumber": 336, "params": [], "return": null }, { "__docId__": 621, "kind": "method", "name": "exportData", "memberof": "src/domain/Metric.js~Metric", "generator": false, "async": false, "static": false, "longname": "src/domain/Metric.js~Metric#exportData", "access": "public", "description": "Exports intermal metric data.", "lineNumber": 347, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "params": [ { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "alwaysIncludeConfig", "description": "Will include config object in export regardless of changed status." } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" } }, { "__docId__": 622, "kind": "file", "name": "src/domain/Project.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/Project.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 623, "kind": "class", "name": "Project", "memberof": "src/domain/Project.js", "static": true, "longname": "src/domain/Project.js~Project", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/Project.js", "importStyle": "Project", "description": "A Project contains multiple {@link Bid}s and summations\nof the bid results. Projects also have statuses\n(ie. open/closed/win/loss), and can have assigned users", "lineNumber": 12, "interface": false, "extends": [ "src/domain/BidEntity.js~BidEntity" ] }, { "__docId__": 624, "kind": "constructor", "name": "constructor", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#constructor", "access": "public", "description": "Creates an instance of Project.", "lineNumber": 18, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "entityData", "description": "" }, { "nullable": null, "types": [ "ProjectService" ], "spread": false, "optional": false, "name": "projectService", "description": "" } ] }, { "__docId__": 625, "kind": "member", "name": "_original", "memberof": "src/domain/Project.js~Project", "static": false, "longname": "src/domain/Project.js~Project#_original", "access": "private", "description": null, "lineNumber": 20, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 626, "kind": "member", "name": "_projectService", "memberof": "src/domain/Project.js~Project", "static": false, "longname": "src/domain/Project.js~Project#_projectService", "access": "private", "description": null, "lineNumber": 21, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 627, "kind": "member", "name": "_data", "memberof": "src/domain/Project.js~Project", "static": false, "longname": "src/domain/Project.js~Project#_data", "access": "private", "description": null, "lineNumber": 22, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 628, "kind": "member", "name": "_bids", "memberof": "src/domain/Project.js~Project", "static": false, "longname": "src/domain/Project.js~Project#_bids", "access": "private", "description": null, "lineNumber": 23, "undocument": true, "ignore": true, "type": { "types": [ "{}" ] } }, { "__docId__": 629, "kind": "member", "name": "_propertiesToSum", "memberof": "src/domain/Project.js~Project", "static": false, "longname": "src/domain/Project.js~Project#_propertiesToSum", "access": "private", "description": null, "lineNumber": 24, "undocument": true, "ignore": true, "type": { "types": [ "string[]" ] } }, { "__docId__": 630, "kind": "member", "name": "_perf_start", "memberof": "src/domain/Project.js~Project", "static": false, "longname": "src/domain/Project.js~Project#_perf_start", "access": "private", "description": null, "lineNumber": 26, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 631, "kind": "member", "name": "isChangeLoggerOn", "memberof": "src/domain/Project.js~Project", "static": false, "longname": "src/domain/Project.js~Project#isChangeLoggerOn", "access": "public", "description": null, "lineNumber": 29, "undocument": true, "type": { "types": [ "boolean" ] } }, { "__docId__": 632, "kind": "get", "name": "title", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#title", "access": "public", "description": null, "lineNumber": 32, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 633, "kind": "set", "name": "title", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#title", "access": "public", "description": null, "lineNumber": 36, "undocument": true }, { "__docId__": 634, "kind": "get", "name": "type", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#type", "access": "public", "description": "", "lineNumber": 46, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 635, "kind": "get", "name": "bids", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#bids", "access": "public", "description": "", "lineNumber": 53, "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 636, "kind": "get", "name": "laborHours", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#laborHours", "access": "public", "description": "Labor Hours Property", "lineNumber": 61, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 637, "kind": "get", "name": "cost", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#cost", "access": "public", "description": "Cost Property", "lineNumber": 69, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 638, "kind": "get", "name": "tax", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#tax", "access": "public", "description": "Tax Property", "lineNumber": 77, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 639, "kind": "get", "name": "taxPercent", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#taxPercent", "access": "public", "description": "Tax Percent Property", "lineNumber": 85, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 640, "kind": "get", "name": "markup", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#markup", "access": "public", "description": "Markup Property", "lineNumber": 93, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 641, "kind": "get", "name": "marginPercent", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#marginPercent", "access": "public", "description": "Margin Property", "lineNumber": 101, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 642, "kind": "get", "name": "markupPercent", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#markupPercent", "access": "public", "description": "Markup Percent Property", "lineNumber": 109, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 643, "kind": "get", "name": "price", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#price", "access": "public", "description": "Price Property", "lineNumber": 117, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 644, "kind": "get", "name": "createdAt", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#createdAt", "access": "public", "description": "", "lineNumber": 124, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 645, "kind": "get", "name": "updatedAt", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#updatedAt", "access": "public", "description": "", "lineNumber": 131, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 646, "kind": "get", "name": "closedAt", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#closedAt", "access": "public", "description": "", "lineNumber": 138, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 647, "kind": "get", "name": "reconciledAt", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#reconciledAt", "access": "public", "description": "", "lineNumber": 145, "type": { "nullable": null, "types": [ "string" ], "spread": false, "description": null } }, { "__docId__": 648, "kind": "get", "name": "users", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#users", "access": "public", "description": "", "lineNumber": 155, "properties": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "timezone", "description": "" } ], "type": { "nullable": null, "types": [ "Object[]" ], "spread": false, "description": null } }, { "__docId__": 649, "kind": "get", "name": "watts", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#watts", "access": "public", "description": "", "lineNumber": 162, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 650, "kind": "get", "name": "components", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#components", "access": "private", "description": "", "lineNumber": 171, "todo": [ "This should be removed." ], "unknown": [ { "tagName": "@readonly", "tagValue": "" } ], "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 651, "kind": "get", "name": "projectStatus", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#projectStatus", "access": "public", "description": "ProjectStatus Property", "lineNumber": 182, "properties": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "core_status", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "is_won", "description": "" } ], "type": { "nullable": null, "types": [ "object" ], "spread": false, "description": null } }, { "__docId__": 652, "kind": "set", "name": "projectStatus", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#projectStatus", "access": "public", "description": "", "lineNumber": 189, "type": { "nullable": null, "types": [ "{id:number, title:string, core_status:string, is_won:boolean}" ], "spread": false, "description": null } }, { "__docId__": 653, "kind": "get", "name": "context", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#context", "access": "public", "description": "", "lineNumber": 212, "type": { "nullable": null, "types": [ "PVBidContext" ], "spread": false, "description": null } }, { "__docId__": 654, "kind": "method", "name": "assess", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#assess", "access": "public", "description": "Assess project values by summing all active bids.", "lineNumber": 222, "emits": [ { "types": [ "assessing" ], "description": "" }, { "types": [ "assessed" ], "description": "" }, { "types": [ "updated" ], "description": "" } ], "params": [], "return": null }, { "__docId__": 655, "kind": "method", "name": "_calculateMargin", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#_calculateMargin", "access": "private", "description": null, "lineNumber": 241, "undocument": true, "ignore": true, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 656, "kind": "method", "name": "bind", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#bind", "access": "public", "description": "Binds the \"updated\" event for all dependant bids.", "lineNumber": 249, "params": [], "return": null }, { "__docId__": 657, "kind": "member", "name": "_perf_end", "memberof": "src/domain/Project.js~Project", "static": false, "longname": "src/domain/Project.js~Project#_perf_end", "access": "private", "description": null, "lineNumber": 251, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 659, "kind": "method", "name": "_bindToBid", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#_bindToBid", "access": "private", "description": null, "lineNumber": 256, "undocument": true, "ignore": true, "params": [ { "name": "bid", "types": [ "*" ] } ], "return": null }, { "__docId__": 660, "kind": "method", "name": "hasUser", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#hasUser", "access": "public", "description": "Determines if user is assigned to project", "lineNumber": 276, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "userId", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 661, "kind": "method", "name": "attachBid", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#attachBid", "access": "public", "description": "Attaches a {@link Bid} to the project and binds necessary events.", "lineNumber": 285, "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ], "return": null }, { "__docId__": 662, "kind": "method", "name": "detachBid", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#detachBid", "access": "public", "description": "Removes a {@link Bid} from the project and removes all bid event listeners.", "lineNumber": 301, "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ], "return": null }, { "__docId__": 663, "kind": "method", "name": "attachUser", "memberof": "src/domain/Project.js~Project", "generator": false, "async": true, "static": false, "longname": "src/domain/Project.js~Project#attachUser", "access": "public", "description": "Adds user to project.", "lineNumber": 319, "unknown": [ { "tagName": "@returns", "tagValue": " {Promise}" } ], "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "user", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 664, "kind": "method", "name": "detachUser", "memberof": "src/domain/Project.js~Project", "generator": false, "async": true, "static": false, "longname": "src/domain/Project.js~Project#detachUser", "access": "public", "description": "Removes user from project", "lineNumber": 339, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "userId", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 665, "kind": "method", "name": "createBid", "memberof": "src/domain/Project.js~Project", "generator": false, "async": true, "static": false, "longname": "src/domain/Project.js~Project#createBid", "access": "public", "description": "Creates a new bid and attaches and attaches it to the project.\nThis is a wrapper function for {@link ProjectService.createBid}", "lineNumber": 359, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 666, "kind": "method", "name": "_clearPortfolio", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#_clearPortfolio", "access": "private", "description": null, "lineNumber": 363, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 667, "kind": "method", "name": "save", "memberof": "src/domain/Project.js~Project", "generator": false, "async": true, "static": false, "longname": "src/domain/Project.js~Project#save", "access": "public", "description": "Saves project and underlying bids.", "lineNumber": 378, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "options.isAutoSave", "description": "Indicate if this save is the result of an auto-save" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "emits": [ { "types": [ "*" ], "description": "saving" }, { "types": [ "*" ], "description": "saved" } ] }, { "__docId__": 668, "kind": "method", "name": "logChanges", "memberof": "src/domain/Project.js~Project", "generator": false, "async": true, "static": false, "longname": "src/domain/Project.js~Project#logChanges", "access": "public", "description": null, "lineNumber": 385, "undocument": true, "params": [ { "name": "entityChangeData", "types": [ "*" ] } ], "return": null }, { "__docId__": 669, "kind": "method", "name": "exportData", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#exportData", "access": "public", "description": "Exports the project's data to an object.", "lineNumber": 416, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "properties": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "cost", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "taxable_cost", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "labor_cost", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "labor_hours", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "price", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "margin_percent", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "markup", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "markup_percent", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "tax", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "tax_percent", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "price", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "actual_cost", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "actual_hours", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "watts", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "created_at", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "updated_at", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "closed_at", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "reconciled_at", "description": "" } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 670, "kind": "method", "name": "clone", "memberof": "src/domain/Project.js~Project", "generator": false, "async": true, "static": false, "longname": "src/domain/Project.js~Project#clone", "access": "public", "description": "Clones project and underlying bids.", "lineNumber": 429, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "properties": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "The id of the new project." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 671, "kind": "method", "name": "enableAutoSave", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#enableAutoSave", "access": "public", "description": "Enables auto saving after project or bid changes occur.", "lineNumber": 440, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": true, "defaultValue": "5000", "defaultRaw": 5000, "name": "delay", "description": "The number of milliseconds to delay auto save. Minimum is 1000ms." } ], "emits": [ { "types": [ "*" ], "description": "saving" }, { "types": [ "*" ], "description": "saved" } ], "return": null }, { "__docId__": 672, "kind": "member", "name": "isAutoSaveOn", "memberof": "src/domain/Project.js~Project", "static": false, "longname": "src/domain/Project.js~Project#isAutoSaveOn", "access": "public", "description": null, "lineNumber": 445, "undocument": true, "type": { "types": [ "boolean" ] } }, { "__docId__": 673, "kind": "method", "name": "disableAutoSave", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#disableAutoSave", "access": "public", "description": "Disables auto saving when project or bid changes occur.", "lineNumber": 451, "params": [], "return": null }, { "__docId__": 675, "kind": "method", "name": "disableLoggingChanges", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#disableLoggingChanges", "access": "public", "description": null, "lineNumber": 456, "undocument": true, "params": [], "return": null }, { "__docId__": 677, "kind": "method", "name": "enableLoggingChanges", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#enableLoggingChanges", "access": "public", "description": null, "lineNumber": 460, "undocument": true, "params": [], "return": null }, { "__docId__": 679, "kind": "method", "name": "isClosed", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#isClosed", "access": "public", "description": "Determines if project is closed.", "lineNumber": 469, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 680, "kind": "method", "name": "isReconciled", "memberof": "src/domain/Project.js~Project", "generator": false, "async": false, "static": false, "longname": "src/domain/Project.js~Project#isReconciled", "access": "public", "description": "Determines if project is reconciled", "lineNumber": 478, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 681, "kind": "file", "name": "src/domain/User.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/User.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 682, "kind": "class", "name": "User", "memberof": "src/domain/User.js", "static": true, "longname": "src/domain/User.js~User", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/User.js", "importStyle": "User", "description": "", "lineNumber": 7, "unknown": [ { "tagName": "@class", "tagValue": "User" } ], "interface": false }, { "__docId__": 683, "kind": "constructor", "name": "constructor", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#constructor", "access": "public", "description": "Creates an instance of User.", "lineNumber": 12, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "userData", "description": "" } ] }, { "__docId__": 684, "kind": "member", "name": "_data", "memberof": "src/domain/User.js~User", "static": false, "longname": "src/domain/User.js~User#_data", "access": "private", "description": null, "lineNumber": 13, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 685, "kind": "member", "name": "_is_impersonating", "memberof": "src/domain/User.js~User", "static": false, "longname": "src/domain/User.js~User#_is_impersonating", "access": "private", "description": null, "lineNumber": 14, "undocument": true, "ignore": true, "type": { "types": [ "boolean" ] } }, { "__docId__": 686, "kind": "member", "name": "_has_industry_wide_predictions", "memberof": "src/domain/User.js~User", "static": false, "longname": "src/domain/User.js~User#_has_industry_wide_predictions", "access": "private", "description": null, "lineNumber": 15, "undocument": true, "ignore": true, "type": { "types": [ "boolean" ] } }, { "__docId__": 687, "kind": "get", "name": "id", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#id", "access": "public", "description": null, "lineNumber": 18, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 688, "kind": "get", "name": "accountId", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#accountId", "access": "public", "description": null, "lineNumber": 22, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 689, "kind": "get", "name": "name", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#name", "access": "public", "description": null, "lineNumber": 26, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 690, "kind": "get", "name": "email", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#email", "access": "public", "description": null, "lineNumber": 30, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 691, "kind": "get", "name": "timezone", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#timezone", "access": "public", "description": null, "lineNumber": 34, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 692, "kind": "get", "name": "industryWidePredictions", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#industryWidePredictions", "access": "public", "description": null, "lineNumber": 38, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 693, "kind": "method", "name": "roles", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#roles", "access": "public", "description": "Gets an array of user roles.", "lineNumber": 47, "unknown": [ { "tagName": "@returns", "tagValue": "{string[]}" } ], "return": { "nullable": null, "types": [ "string[]" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 694, "kind": "method", "name": "permissions", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#permissions", "access": "public", "description": null, "lineNumber": 51, "undocument": true, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 695, "kind": "method", "name": "can", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#can", "access": "public", "description": null, "lineNumber": 55, "undocument": true, "params": [ { "name": "permission", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 696, "kind": "method", "name": "hasRole", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#hasRole", "access": "public", "description": null, "lineNumber": 60, "undocument": true, "params": [ { "name": "roles", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 697, "kind": "method", "name": "isImpersonating", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#isImpersonating", "access": "public", "description": null, "lineNumber": 75, "undocument": true, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 698, "kind": "method", "name": "hasIndustryWidePredictions", "memberof": "src/domain/User.js~User", "generator": false, "async": false, "static": false, "longname": "src/domain/User.js~User#hasIndustryWidePredictions", "access": "public", "description": null, "lineNumber": 79, "undocument": true, "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 699, "kind": "file", "name": "src/domain/factories/BidFactory.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/factories/BidFactory.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 700, "kind": "class", "name": "BidFactory", "memberof": "src/domain/factories/BidFactory.js", "static": true, "longname": "src/domain/factories/BidFactory.js~BidFactory", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/factories/BidFactory.js", "importStyle": "BidFactory", "description": "Factory class to generate a {@link Bid} instance with internal bid entities.", "lineNumber": 20, "unknown": [ { "tagName": "@class", "tagValue": "BidFactory" } ], "interface": false }, { "__docId__": 701, "kind": "constructor", "name": "constructor", "memberof": "src/domain/factories/BidFactory.js~BidFactory", "generator": false, "async": false, "static": false, "longname": "src/domain/factories/BidFactory.js~BidFactory#constructor", "access": "public", "description": "Creates an instance of BidFactory.", "lineNumber": 24 }, { "__docId__": 702, "kind": "member", "name": "_entities", "memberof": "src/domain/factories/BidFactory.js~BidFactory", "static": false, "longname": "src/domain/factories/BidFactory.js~BidFactory#_entities", "access": "private", "description": null, "lineNumber": 25, "undocument": true, "ignore": true, "type": { "types": [ "string[]" ] } }, { "__docId__": 703, "kind": "method", "name": "create", "memberof": "src/domain/factories/BidFactory.js~BidFactory", "generator": false, "async": false, "static": false, "longname": "src/domain/factories/BidFactory.js~BidFactory#create", "access": "public", "description": "Creates a Bid object from bid data.", "lineNumber": 48, "unknown": [ { "tagName": "@returns", "tagValue": "{Bid}" } ], "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "bidData", "description": "" }, { "nullable": null, "types": [ "PVBidContext" ], "spread": false, "optional": false, "name": "context", "description": "" }, { "nullable": null, "types": [ "Project" ], "spread": false, "optional": false, "name": "project", "description": "" } ], "return": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": "" } }, { "__docId__": 704, "kind": "method", "name": "reload", "memberof": "src/domain/factories/BidFactory.js~BidFactory", "generator": false, "async": false, "static": false, "longname": "src/domain/factories/BidFactory.js~BidFactory#reload", "access": "public", "description": "Reloads a bids internal settings while keeping the Bid instance.", "lineNumber": 73, "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "bidData", "description": "" } ], "return": null }, { "__docId__": 705, "kind": "method", "name": "_hasAllEntities", "memberof": "src/domain/factories/BidFactory.js~BidFactory", "generator": false, "async": false, "static": false, "longname": "src/domain/factories/BidFactory.js~BidFactory#_hasAllEntities", "access": "private", "description": null, "lineNumber": 91, "undocument": true, "ignore": true, "params": [ { "name": "bidData", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 706, "kind": "method", "name": "_keyBidEntities", "memberof": "src/domain/factories/BidFactory.js~BidFactory", "generator": false, "async": false, "static": false, "longname": "src/domain/factories/BidFactory.js~BidFactory#_keyBidEntities", "access": "private", "description": "Keys all bid entities by their id.", "lineNumber": 105, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "bidData", "description": "" } ], "ignore": true, "return": null }, { "__docId__": 707, "kind": "method", "name": "_createBidEntities", "memberof": "src/domain/factories/BidFactory.js~BidFactory", "generator": false, "async": false, "static": false, "longname": "src/domain/factories/BidFactory.js~BidFactory#_createBidEntities", "access": "private", "description": "Creates the bid entity class for each bid entity data object.", "lineNumber": 119, "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "bidData", "description": "" } ], "ignore": true, "return": null }, { "__docId__": 708, "kind": "file", "name": "src/domain/scaffolding/FieldScaffolding.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/scaffolding/FieldScaffolding.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 709, "kind": "class", "name": "FieldScaffolding", "memberof": "src/domain/scaffolding/FieldScaffolding.js", "static": true, "longname": "src/domain/scaffolding/FieldScaffolding.js~FieldScaffolding", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/scaffolding/FieldScaffolding.js", "importStyle": "FieldScaffolding", "description": null, "lineNumber": 1, "undocument": true, "interface": false }, { "__docId__": 710, "kind": "method", "name": "create", "memberof": "src/domain/scaffolding/FieldScaffolding.js~FieldScaffolding", "generator": false, "async": false, "static": true, "longname": "src/domain/scaffolding/FieldScaffolding.js~FieldScaffolding.create", "access": "public", "description": "Gererates a default field data object.", "lineNumber": 11, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bidId", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "New Field", "defaultRaw": "New Field", "name": "title", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "number", "defaultRaw": "number", "name": "type", "description": "" } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" } }, { "__docId__": 711, "kind": "file", "name": "src/domain/scaffolding/LineItemScaffolding.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/scaffolding/LineItemScaffolding.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 712, "kind": "class", "name": "LineItemScaffolding", "memberof": "src/domain/scaffolding/LineItemScaffolding.js", "static": true, "longname": "src/domain/scaffolding/LineItemScaffolding.js~LineItemScaffolding", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/scaffolding/LineItemScaffolding.js", "importStyle": "LineItemScaffolding", "description": null, "lineNumber": 1, "undocument": true, "interface": false }, { "__docId__": 713, "kind": "method", "name": "create", "memberof": "src/domain/scaffolding/LineItemScaffolding.js~LineItemScaffolding", "generator": false, "async": false, "static": true, "longname": "src/domain/scaffolding/LineItemScaffolding.js~LineItemScaffolding.create", "access": "public", "description": "Gererates a default line item data object.", "lineNumber": 10, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bidId", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "New Line Item", "defaultRaw": "New Line Item", "name": "title", "description": "" } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" } }, { "__docId__": 714, "kind": "file", "name": "src/domain/scaffolding/MetricScaffolding.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/scaffolding/MetricScaffolding.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 715, "kind": "class", "name": "MetricScaffolding", "memberof": "src/domain/scaffolding/MetricScaffolding.js", "static": true, "longname": "src/domain/scaffolding/MetricScaffolding.js~MetricScaffolding", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/scaffolding/MetricScaffolding.js", "importStyle": "MetricScaffolding", "description": null, "lineNumber": 1, "undocument": true, "interface": false }, { "__docId__": 716, "kind": "method", "name": "create", "memberof": "src/domain/scaffolding/MetricScaffolding.js~MetricScaffolding", "generator": false, "async": false, "static": true, "longname": "src/domain/scaffolding/MetricScaffolding.js~MetricScaffolding.create", "access": "public", "description": "Gererates a default metric data object.", "lineNumber": 10, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bidId", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "New Metric", "defaultRaw": "New Metric", "name": "title", "description": "" } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" } }, { "__docId__": 717, "kind": "file", "name": "src/domain/services/BidEntityAssemblyService.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/BidEntityAssemblyService.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 718, "kind": "function", "name": "getEntityAssemblyRefId", "memberof": "src/domain/services/BidEntityAssemblyService.js", "generator": false, "async": false, "static": true, "longname": "src/domain/services/BidEntityAssemblyService.js~getEntityAssemblyRefId", "access": "public", "export": false, "importPath": "pvbid-sdk/src/domain/services/BidEntityAssemblyService.js", "importStyle": null, "description": "Determine the entity's assembly ref id if it has one", "lineNumber": 7, "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "entity", "description": "" } ], "return": { "nullable": null, "types": [ "string", "undefined" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 719, "kind": "function", "name": "getAssemblyRefId", "memberof": "src/domain/services/BidEntityAssemblyService.js", "generator": false, "async": false, "static": true, "longname": "src/domain/services/BidEntityAssemblyService.js~getAssemblyRefId", "access": "public", "export": false, "importPath": "pvbid-sdk/src/domain/services/BidEntityAssemblyService.js", "importStyle": null, "description": "Determine the assembly's ref_id", "lineNumber": 17, "params": [ { "nullable": null, "types": [ "Assembly" ], "spread": false, "optional": false, "name": "assembly", "description": "" } ], "return": { "nullable": null, "types": [ "string" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 720, "kind": "function", "name": "setEntityAssemblyRefId", "memberof": "src/domain/services/BidEntityAssemblyService.js", "generator": false, "async": false, "static": true, "longname": "src/domain/services/BidEntityAssemblyService.js~setEntityAssemblyRefId", "access": "public", "export": false, "importPath": "pvbid-sdk/src/domain/services/BidEntityAssemblyService.js", "importStyle": null, "description": "Set the assembly ref for the given entity", "lineNumber": 31, "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "entity", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "assemblyRefId", "description": "" } ], "return": { "nullable": null, "types": [ "BidEntity" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 721, "kind": "function", "name": "hasAssembly", "memberof": "src/domain/services/BidEntityAssemblyService.js", "generator": false, "async": false, "static": true, "longname": "src/domain/services/BidEntityAssemblyService.js~hasAssembly", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/BidEntityAssemblyService.js", "importStyle": "{hasAssembly}", "description": "Determine if the entity has an assembly", "lineNumber": 44, "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "entity", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 722, "kind": "function", "name": "getAssembly", "memberof": "src/domain/services/BidEntityAssemblyService.js", "generator": false, "async": false, "static": true, "longname": "src/domain/services/BidEntityAssemblyService.js~getAssembly", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/BidEntityAssemblyService.js", "importStyle": "{getAssembly}", "description": "Get the entities assembly if it has one", "lineNumber": 54, "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "entity", "description": "" } ], "return": { "nullable": null, "types": [ "Assembly", "undefined" ], "spread": false, "description": "" } }, { "__docId__": 723, "kind": "function", "name": "setAssembly", "memberof": "src/domain/services/BidEntityAssemblyService.js", "generator": false, "async": false, "static": true, "longname": "src/domain/services/BidEntityAssemblyService.js~setAssembly", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/BidEntityAssemblyService.js", "importStyle": "{setAssembly}", "description": "Set the entity's assembly reference. Omitting or passing null for the assembly will UNSET the assembly reference", "lineNumber": 68, "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "entity", "description": "" }, { "nullable": null, "types": [ "Assembly", "string" ], "spread": false, "optional": true, "name": "assembly", "description": "The assembly reference id OR the assembly entity." } ], "return": { "nullable": null, "types": [ "BidEntity" ], "spread": false, "description": "" } }, { "__docId__": 724, "kind": "file", "name": "src/domain/services/BidEntityRelationsHelper.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/BidEntityRelationsHelper.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 725, "kind": "class", "name": "BidEntityRelationsHelper", "memberof": "src/domain/services/BidEntityRelationsHelper.js", "static": true, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/BidEntityRelationsHelper.js", "importStyle": "BidEntityRelationsHelper", "description": "Helper class to manage all bid entities in a bid.", "lineNumber": 9, "unknown": [ { "tagName": "@class", "tagValue": "BidEntityRelationsHelper" } ], "interface": false }, { "__docId__": 726, "kind": "constructor", "name": "constructor", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#constructor", "access": "public", "description": "Creates an instance of BidEntityRelationsHelper.", "lineNumber": 14, "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ] }, { "__docId__": 727, "kind": "member", "name": "bid", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#bid", "access": "public", "description": "", "lineNumber": 18, "type": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": null } }, { "__docId__": 728, "kind": "member", "name": "_types", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#_types", "access": "private", "description": null, "lineNumber": 19, "undocument": true, "ignore": true, "type": { "types": [ "string[]" ] } }, { "__docId__": 729, "kind": "method", "name": "fields", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#fields", "access": "public", "description": "Gets a field entity by id. If no id is passed, will return an of object of keyed fields by their id..", "examples": [ "Example of returned keyed object.\n{\n \"92\" : ,\n \"103\" : \n}" ], "lineNumber": 44, "unknown": [ { "tagName": "@returns", "tagValue": "{?(Field|Object.)}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": true, "types": [ "Field", "Object." ], "spread": false, "description": "" } }, { "__docId__": 730, "kind": "method", "name": "fieldGroups", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#fieldGroups", "access": "public", "description": "Gets a field group entity by id. If no id is passed, will return an of object of keyed field groups by their id..", "examples": [ "Example of returned keyed object.\n{\n \"92\" : ,\n \"103\" : \n}" ], "lineNumber": 60, "unknown": [ { "tagName": "@returns", "tagValue": "{?(FieldGroup|Object.)}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": true, "types": [ "FieldGroup", "Object." ], "spread": false, "description": "" } }, { "__docId__": 731, "kind": "method", "name": "metrics", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#metrics", "access": "public", "description": "Gets a metric entity by id. If no id is passed, will return an of object of keyed metrics by their id..", "examples": [ "Example of returned keyed object.\n{\n \"92\" : ,\n \"103\" : \n}" ], "lineNumber": 76, "unknown": [ { "tagName": "@returns", "tagValue": "{?(Metric|Object.)}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": true, "types": [ "Metric", "Object." ], "spread": false, "description": "" } }, { "__docId__": 732, "kind": "method", "name": "lineItems", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#lineItems", "access": "public", "description": "Gets a line item entity by id. If no id is passed, will return an of object of keyed line items by their id..", "examples": [ "Example of returned keyed object.\n{\n \"92\" : ,\n \"103\" : \n}" ], "lineNumber": 92, "unknown": [ { "tagName": "@returns", "tagValue": "{?(LineItem|Object.)}" } ], "params": [ { "nullable": true, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": true, "types": [ "LineItem", "Object." ], "spread": false, "description": "" } }, { "__docId__": 733, "kind": "method", "name": "datatables", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#datatables", "access": "public", "description": "Gets a datatable entity by id. If no id is passed, will return an of object of keyed datatables by their id..", "examples": [ "Example of returned keyed object.\n{\n \"92\" : ,\n \"103\" : \n}" ], "lineNumber": 108, "unknown": [ { "tagName": "@returns", "tagValue": "{?(Datatable|Object.)}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": true, "types": [ "Datatable", "Object." ], "spread": false, "description": "" } }, { "__docId__": 734, "kind": "method", "name": "assemblies", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#assemblies", "access": "public", "description": "Gets an assembly entity by id. If no id is passed, will return an of object of keyed assemblies by their id..", "examples": [ "Example of returned keyed object.\n{\n \"92\" : ,\n \"103\" : \n}" ], "lineNumber": 124, "unknown": [ { "tagName": "@returns", "tagValue": "{?(Assembly|Object.)}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": true, "types": [ "Assembly", "Object." ], "spread": false, "description": "" } }, { "__docId__": 735, "kind": "method", "name": "variables", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#variables", "access": "public", "description": "Gets a bid variable entity by id. If no id is passed, will return an object of keyed bid variables by their id.", "examples": [ "Example of returned keyed object.\n{\n \"xyg4\" : ,\n \"burden\" : \n}" ], "lineNumber": 140, "unknown": [ { "tagName": "@returns", "tagValue": "{?(Component|Object.)}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "name": "id", "description": "The id of the component to retrieve." } ], "return": { "nullable": true, "types": [ "Component", "Object." ], "spread": false, "description": "" } }, { "__docId__": 736, "kind": "method", "name": "components", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#components", "access": "public", "description": "Gets a component entity by id. If no id is passed, will return an object of keyed components by their id.", "examples": [ "Example of returned keyed object.\n{\n \"92\" : ,\n \"103\" : \n}" ], "lineNumber": 156, "unknown": [ { "tagName": "@returns", "tagValue": "{?(Component|Object.)}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": true, "name": "id", "description": "The id of the component to retrieve." } ], "return": { "nullable": true, "types": [ "Component", "Object." ], "spread": false, "description": "" } }, { "__docId__": 737, "kind": "method", "name": "componentGroups", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#componentGroups", "access": "public", "description": "Gets a component group entity by id. If no id is passed, will return an of object of keyed component groups by their id..", "examples": [ "Example of returned keyed object.\n{\n \"92\" : ,\n \"103\" : \n}" ], "lineNumber": 172, "unknown": [ { "tagName": "@returns", "tagValue": "{?(ComponentGroup|Object.)}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": true, "types": [ "ComponentGroup", "Object." ], "spread": false, "description": "" } }, { "__docId__": 738, "kind": "method", "name": "dynamicGroups", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#dynamicGroups", "access": "public", "description": "Gets a dynamic group entity by id. If no id is passed, will return an of object of keyed dynamic groups by their id.", "examples": [ "Example of returned keyed object.\n{\n \"92\" : ,\n \"103\" : \n}" ], "lineNumber": 188, "unknown": [ { "tagName": "@returns", "tagValue": "{?(DynamicGroup|Object.)}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": true, "types": [ "DynamicGroup", "Object." ], "spread": false, "description": "" } }, { "__docId__": 739, "kind": "method", "name": "assemblyMaps", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#assemblyMaps", "access": "public", "description": "Gets a assembly map entity by id. If no id is passed, will return an object of keyed assembly maps by their id.", "examples": [ "Example of returned keyed object.\n{\n \"92\" : ,\n \"103\" : \n}" ], "lineNumber": 204, "unknown": [ { "tagName": "@returns", "tagValue": "{?(AssemblyMap|Object.)}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": true, "name": "id", "description": "The id of the assembly map to retrieve." } ], "return": { "nullable": true, "types": [ "AssemblyMap", "Object." ], "spread": false, "description": "" } }, { "__docId__": 740, "kind": "method", "name": "getDependency", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#getDependency", "access": "public", "description": "Gets a bid entity by a dependency contract.", "examples": [ "Example a dependency contract.\n{\n \"type\" : ,\n \"bid_entity_id\" : ,\n \"field\" : \n}" ], "lineNumber": 224, "unknown": [ { "tagName": "@returns", "tagValue": "{?BidEntity} Returns the bid entity requested determined by the dependency contract." } ], "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "dependencyContract", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "dependencyContract.type", "description": "The type of bid entity, ie: line_item, metric, field, component, component_group, assembly, etc" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "dependencyContract.bid_entity_id", "description": "The id of the bid entity. Note, this will eventual be converted to simply \"id\"." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "dependencyContract.field", "description": "The bid entity property that holds the needed value." } ], "return": { "nullable": true, "types": [ "BidEntity" ], "spread": false, "description": "Returns the bid entity requested determined by the dependency contract." } }, { "__docId__": 741, "kind": "method", "name": "getDependencyValue", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#getDependencyValue", "access": "public", "description": "Gets the value of a bid entity by a dependency contract.", "lineNumber": 254, "unknown": [ { "tagName": "@returns", "tagValue": "{string|number|boolean} Returns the bid entity value." } ], "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "dependencyContract", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "dependencyContract.type", "description": "The type of bid entity, ie: line_item, metric, field, component, compnent_group, assembly, etc" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "dependencyContract.bid_entity_id", "description": "The id of the bid entity. Note, this will eventual be converted to simply \"id\"." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "dependencyContract.field", "description": "The bid entity property that holds the needed value." } ], "return": { "nullable": null, "types": [ "string", "number", "boolean" ], "spread": false, "description": "Returns the bid entity value." } }, { "__docId__": 742, "kind": "method", "name": "isDependencyFullyDefined", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#isDependencyFullyDefined", "access": "public", "description": "Checks if the dependency used an undefined dependency value when evaluating\n(dependencies may evaluate to a number even if they rely on an undefined value somewhere in the calc)", "lineNumber": 294, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "dependencyContract", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "If the dependency is fully defined / not relient on any unefined dependencies" } }, { "__docId__": 743, "kind": "method", "name": "getFieldValue", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#getFieldValue", "access": "public", "description": null, "lineNumber": 305, "undocument": true, "params": [ { "name": "field", "types": [ "*" ] }, { "name": "dataColumnId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 744, "kind": "method", "name": "getBidEntitiesByDefId", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#getBidEntitiesByDefId", "access": "public", "description": "Get bid entities by a definition id", "lineNumber": 321, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The type of bid entity ('metric'|'field'|'line_item'|'datatable'|'component')" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "defId", "description": "The definition id to lookup by" } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "list of bid entities with the given def id" } }, { "__docId__": 745, "kind": "method", "name": "getDependants", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#getDependants", "access": "public", "description": "Gets all the dependants for a bid bid entity.", "lineNumber": 342, "unknown": [ { "tagName": "@returns", "tagValue": "[BidEntity[]]" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The type of bid enity. IE. line_item, field, metric, component, etc." }, { "nullable": null, "types": [ "int" ], "spread": false, "optional": false, "name": "id", "description": "The id of the bid entity." } ], "return": { "nullable": null, "types": [ "*" ], "spread": false, "description": "[BidEntity[]]" } }, { "__docId__": 746, "kind": "method", "name": "getBidEntity", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#getBidEntity", "access": "public", "description": "Gets a bid entity by type and id.", "lineNumber": 370, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "" }, { "nullable": null, "types": [ "number", "string" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": null, "types": [ "BidEntity" ], "spread": false, "description": "" } }, { "__docId__": 747, "kind": "method", "name": "getCollection", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#getCollection", "access": "public", "description": "Returns the full collection of bid entites by type. Returned is a keyed object by the bid entity id.", "lineNumber": 391, "unknown": [ { "tagName": "@returns", "tagValue": "{object}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "" } ], "return": { "nullable": null, "types": [ "object" ], "spread": false, "description": "" } }, { "__docId__": 748, "kind": "method", "name": "getComponentByDefId", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#getComponentByDefId", "access": "public", "description": "Gets a component by their core definition id. Note, this function will be removed once", "lineNumber": 405, "unknown": [ { "tagName": "@returns", "tagValue": "{Component}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "defId", "description": "" } ], "return": { "nullable": null, "types": [ "Component" ], "spread": false, "description": "" } }, { "__docId__": 749, "kind": "member", "name": "_componentsKeyedByDefinitionId", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#_componentsKeyedByDefinitionId", "access": "private", "description": null, "lineNumber": 407, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 750, "kind": "method", "name": "getDatatableByDefId", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#getDatatableByDefId", "access": "public", "description": "Gets a datatable by definition id", "lineNumber": 420, "unknown": [ { "tagName": "@returns", "tagValue": "{Datatable}" } ], "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "defId", "description": "" } ], "return": { "nullable": null, "types": [ "Datatable" ], "spread": false, "description": "" } }, { "__docId__": 751, "kind": "member", "name": "_datatablesKeyedByDefinitionId", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#_datatablesKeyedByDefinitionId", "access": "private", "description": null, "lineNumber": 422, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 752, "kind": "method", "name": "dependencyExists", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#dependencyExists", "access": "public", "description": "Determines if dependency exists basd on the dependency contract.", "lineNumber": 436, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "dependencyContract", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "dependencyContract.type", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "dependencyContract.bid_entity_id", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "dependencyContract.field", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 753, "kind": "method", "name": "bidEntityExists", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#bidEntityExists", "access": "public", "description": "Determines if bid entity exists based on type and id.", "lineNumber": 454, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "" }, { "nullable": null, "types": [ "number", "string" ], "spread": false, "optional": false, "name": "id", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 754, "kind": "method", "name": "searchByTitle", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#searchByTitle", "access": "public", "description": "Searches and returns an array of bid entities by their title.\nResults are case-insensitive.", "lineNumber": 468, "unknown": [ { "tagName": "@returns", "tagValue": "{BidEntity[]}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "The type of bid entity to search for: line_item, field, metric, component, assembly, etc." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "query", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "false", "defaultRaw": false, "name": "exactMatch", "description": "By default, the search will match any title that contains the search term. If this flag is set to true, the title search will perform a case-insensitive exact match" } ], "return": { "nullable": null, "types": [ "BidEntity[]" ], "spread": false, "description": "" } }, { "__docId__": 755, "kind": "method", "name": "parseBoolean", "memberof": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidEntityRelationsHelper.js~BidEntityRelationsHelper#parseBoolean", "access": "public", "description": null, "lineNumber": 479, "undocument": true, "params": [ { "name": "value", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 756, "kind": "file", "name": "src/domain/services/BidService.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/BidService.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 757, "kind": "class", "name": "BidService", "memberof": "src/domain/services/BidService.js", "static": true, "longname": "src/domain/services/BidService.js~BidService", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/BidService.js", "importStyle": "BidService", "description": "", "lineNumber": 16, "unknown": [ { "tagName": "@class", "tagValue": "BidService" } ], "interface": false }, { "__docId__": 758, "kind": "constructor", "name": "constructor", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidService.js~BidService#constructor", "access": "public", "description": "Creates an instance of BidService.", "lineNumber": 21, "params": [ { "nullable": null, "types": [ "PVBidContext" ], "spread": false, "optional": false, "name": "context", "description": "" } ] }, { "__docId__": 759, "kind": "member", "name": "context", "memberof": "src/domain/services/BidService.js~BidService", "static": false, "longname": "src/domain/services/BidService.js~BidService#context", "access": "public", "description": null, "lineNumber": 22, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 760, "kind": "member", "name": "repositories", "memberof": "src/domain/services/BidService.js~BidService", "static": false, "longname": "src/domain/services/BidService.js~BidService#repositories", "access": "public", "description": null, "lineNumber": 23, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 761, "kind": "method", "name": "clone", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#clone", "access": "public", "description": "Clones bid returning an initialized {@link Bid}", "lineNumber": 32, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 762, "kind": "method", "name": "moveBidToProject", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#moveBidToProject", "access": "public", "description": "Moves a bid to a project by first detaching the bid from its original project,\n then moves the bid to a given project by attaching the project id to the bid.\n\n Reassessing the projects after moving.", "lineNumber": 53, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise<*>}" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "originalBid", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "project", "description": "" } ], "return": { "nullable": null, "types": [ "Promise<*>" ], "spread": false, "description": "" } }, { "__docId__": 763, "kind": "method", "name": "addLineItem", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#addLineItem", "access": "public", "description": "Adds a new line item to the bid. The added line item is uncategorized in all component groups.", "lineNumber": 73, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "New Line Item", "defaultRaw": "New Line Item", "name": "title", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 764, "kind": "method", "name": "addMetric", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#addMetric", "access": "public", "description": "Adds a new metric to the bid.", "lineNumber": 94, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "New Metric", "defaultRaw": "New Metric", "name": "title", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 765, "kind": "method", "name": "addField", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#addField", "access": "public", "description": "Adds a new field to the bid.", "lineNumber": 118, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "New Field", "defaultRaw": "New Field", "name": "title", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "number", "defaultRaw": "number", "name": "type", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 766, "kind": "method", "name": "addDynamicGroup", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#addDynamicGroup", "access": "public", "description": "Adds a new Dynamic Group to the Bid.", "lineNumber": 141, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "\"New Dynamic Group\"", "defaultRaw": "New Dynamic Group", "name": "title", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 767, "kind": "method", "name": "createSnapshot", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#createSnapshot", "access": "public", "description": "Creates a snapshot of the current bid.", "lineNumber": 171, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise.}" } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" }, { "nullable": true, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "Title of the snapshot" }, { "nullable": true, "types": [ "string" ], "spread": false, "optional": false, "name": "description", "description": "Description of the snapshot." } ], "properties": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "The snapshot id." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "title", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bid_id", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "description", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "is_auto", "description": "A flag to indicate the snapshot was generated automatically by the PVBid system." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "created_at", "description": "Example format: 2016-04-10T21:08:05+00:00" } ], "return": { "nullable": null, "types": [ "Promise." ], "spread": false, "description": "" } }, { "__docId__": 768, "kind": "method", "name": "validate", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidService.js~BidService#validate", "access": "public", "description": "Validates bid structure and references.", "lineNumber": 189, "unknown": [ { "tagName": "@returns", "tagValue": "{object[]} Returns an array of validation errors." } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ], "return": { "nullable": null, "types": [ "object[]" ], "spread": false, "description": "Returns an array of validation errors." } }, { "__docId__": 769, "kind": "method", "name": "removeAssembly", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#removeAssembly", "access": "public", "description": "Removes assembly from a bid.", "lineNumber": 200, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "assemblyId", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 770, "kind": "method", "name": "addAssemblies", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#addAssemblies", "access": "public", "description": "Adds assemblies to bid.", "lineNumber": 217, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise} Array of created bid entities" } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" }, { "nullable": null, "types": [ "number[]" ], "spread": false, "optional": false, "name": "assemblyMapIds", "description": "An array of assembly mapping ids to add." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Array of created bid entities" } }, { "__docId__": 771, "kind": "method", "name": "recoverBid", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#recoverBid", "access": "public", "description": "Recovers a bid from a snapshot. An auto snapshot of the current state will be created.", "lineNumber": 239, "unknown": [ { "tagName": "@returns", "tagValue": " {Promise}" } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "snapshotId", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 772, "kind": "method", "name": "deleteBid", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#deleteBid", "access": "public", "description": "Deletes bid.", "lineNumber": 256, "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 773, "kind": "method", "name": "reload", "memberof": "src/domain/services/BidService.js~BidService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/BidService.js~BidService#reload", "access": "public", "description": "Reload a bid with all of its entities while maintaining the same instance.", "lineNumber": 272, "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ], "return": { "nullable": null, "types": [ "Bid" ], "spread": false, "description": "" } }, { "__docId__": 774, "kind": "file", "name": "src/domain/services/BidValidator.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/BidValidator.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 775, "kind": "class", "name": "BidValidator", "memberof": "src/domain/services/BidValidator.js", "static": true, "longname": "src/domain/services/BidValidator.js~BidValidator", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/BidValidator.js", "importStyle": "BidValidator", "description": "Validates a bid structure and dependencies.", "lineNumber": 9, "unknown": [ { "tagName": "@class", "tagValue": "BidValidator" } ], "interface": false }, { "__docId__": 776, "kind": "constructor", "name": "constructor", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#constructor", "access": "public", "description": "Creates an instance of BidValidator.", "lineNumber": 13 }, { "__docId__": 777, "kind": "member", "name": "_bid", "memberof": "src/domain/services/BidValidator.js~BidValidator", "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_bid", "access": "private", "description": null, "lineNumber": 14, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 778, "kind": "member", "name": "_testResults", "memberof": "src/domain/services/BidValidator.js~BidValidator", "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testResults", "access": "private", "description": null, "lineNumber": 15, "undocument": true, "ignore": true, "type": { "types": [ "*[]" ] } }, { "__docId__": 779, "kind": "method", "name": "validate", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#validate", "access": "public", "description": "Validates a bid return an array of issues, if any exists.", "lineNumber": 24, "unknown": [ { "tagName": "@returns", "tagValue": "{object[]} Returns an array of validation errors." } ], "params": [ { "nullable": null, "types": [ "Bid" ], "spread": false, "optional": false, "name": "bid", "description": "" } ], "return": { "nullable": null, "types": [ "object[]" ], "spread": false, "description": "Returns an array of validation errors." } }, { "__docId__": 782, "kind": "method", "name": "_baseEntityTest", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_baseEntityTest", "access": "private", "description": null, "lineNumber": 36, "undocument": true, "ignore": true, "params": [ { "name": "bidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 783, "kind": "method", "name": "_runLineItemTests", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_runLineItemTests", "access": "private", "description": null, "lineNumber": 52, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 784, "kind": "method", "name": "_runFieldTests", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_runFieldTests", "access": "private", "description": null, "lineNumber": 85, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 785, "kind": "method", "name": "_runFieldGroupTests", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_runFieldGroupTests", "access": "private", "description": null, "lineNumber": 99, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 786, "kind": "method", "name": "_runMetricTests", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_runMetricTests", "access": "private", "description": null, "lineNumber": 110, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 787, "kind": "method", "name": "_runComponentTests", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_runComponentTests", "access": "private", "description": null, "lineNumber": 122, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 788, "kind": "method", "name": "_runDynamicGroupTests", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_runDynamicGroupTests", "access": "private", "description": null, "lineNumber": 133, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 789, "kind": "method", "name": "_runAssemblyTest", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_runAssemblyTest", "access": "private", "description": null, "lineNumber": 143, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 790, "kind": "method", "name": "_testAll", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testAll", "access": "private", "description": null, "lineNumber": 210, "undocument": true, "ignore": true, "params": [], "return": null }, { "__docId__": 791, "kind": "method", "name": "_testIsFieldAssignedToGroup", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testIsFieldAssignedToGroup", "access": "private", "description": null, "lineNumber": 221, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 792, "kind": "method", "name": "_testListFieldHasDatatable", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testListFieldHasDatatable", "access": "private", "description": null, "lineNumber": 234, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 793, "kind": "method", "name": "_testMetricFormulaReferences", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testMetricFormulaReferences", "access": "private", "description": null, "lineNumber": 246, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 794, "kind": "method", "name": "_testMetricManipulations", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testMetricManipulations", "access": "private", "description": null, "lineNumber": 261, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 795, "kind": "method", "name": "_testLineItemRuleCompleteness", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testLineItemRuleCompleteness", "access": "private", "description": null, "lineNumber": 300, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "rule", "types": [ "*" ] } ], "return": null }, { "__docId__": 796, "kind": "method", "name": "_testLineItemRuleFormula", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testLineItemRuleFormula", "access": "private", "description": null, "lineNumber": 358, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "rule", "types": [ "*" ] } ], "return": null }, { "__docId__": 797, "kind": "method", "name": "_testLineItemScalarFormulaReferences", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testLineItemScalarFormulaReferences", "access": "private", "description": null, "lineNumber": 374, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 798, "kind": "method", "name": "_testLineItemWorkup", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testLineItemWorkup", "access": "private", "description": null, "lineNumber": 399, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 799, "kind": "method", "name": "_testLineItemWorkupFieldType", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testLineItemWorkupFieldType", "access": "private", "description": null, "lineNumber": 423, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "fieldId", "types": [ "*" ] } ], "return": null }, { "__docId__": 800, "kind": "method", "name": "_testLineItemRuleListField", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testLineItemRuleListField", "access": "private", "description": null, "lineNumber": 437, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "rule", "types": [ "*" ] } ], "return": null }, { "__docId__": 801, "kind": "method", "name": "_testForLiDupesInComponentGroups", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testForLiDupesInComponentGroups", "access": "private", "description": "Test Line Items are not used more than once within a Component Group", "lineNumber": 446, "ignore": true, "params": [], "return": null }, { "__docId__": 802, "kind": "method", "name": "_testDependencyExistence", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testDependencyExistence", "access": "private", "description": null, "lineNumber": 487, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "dependencyContract", "types": [ "*" ] }, { "name": "dependencyKey", "types": [ "*" ] } ], "return": null }, { "__docId__": 803, "kind": "method", "name": "_testAssemblyExistence", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testAssemblyExistence", "access": "private", "description": null, "lineNumber": 497, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 804, "kind": "method", "name": "_testUnconvertedRuleDefinitionId", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testUnconvertedRuleDefinitionId", "access": "private", "description": null, "lineNumber": 506, "undocument": true, "ignore": true, "params": [ { "name": "lineItem", "types": [ "*" ] }, { "name": "dependencyContract", "types": [ "*" ] }, { "name": "dependencyKey", "types": [ "*" ] }, { "name": "rule", "types": [ "*" ] } ], "return": null }, { "__docId__": 805, "kind": "method", "name": "_testDependencyAssemblySafeGuard", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testDependencyAssemblySafeGuard", "access": "private", "description": null, "lineNumber": 516, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "dependencyContract", "types": [ "*" ] }, { "name": "dependencyKey", "types": [ "*" ] } ], "return": null }, { "__docId__": 806, "kind": "method", "name": "_testReferencedLineItemExists", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testReferencedLineItemExists", "access": "private", "description": null, "lineNumber": 539, "undocument": true, "ignore": true, "params": [ { "name": "lineItemId", "types": [ "*" ] }, { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 807, "kind": "method", "name": "_testReferencedComponentExists", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testReferencedComponentExists", "access": "private", "description": null, "lineNumber": 550, "undocument": true, "ignore": true, "params": [ { "name": "componentId", "types": [ "*" ] }, { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "errorType", "types": [ "*" ] } ], "return": null }, { "__docId__": 808, "kind": "method", "name": "_testReferencedDynamicGroupExists", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testReferencedDynamicGroupExists", "access": "private", "description": null, "lineNumber": 561, "undocument": true, "ignore": true, "params": [ { "name": "groupId", "types": [ "*" ] }, { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 809, "kind": "method", "name": "_testComponentReferences", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testComponentReferences", "access": "private", "description": null, "lineNumber": 572, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 810, "kind": "method", "name": "_testDynamicGroupReferences", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testDynamicGroupReferences", "access": "private", "description": null, "lineNumber": 602, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 811, "kind": "method", "name": "_testFieldGroupReferences", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testFieldGroupReferences", "access": "private", "description": null, "lineNumber": 628, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] } ], "return": null }, { "__docId__": 812, "kind": "method", "name": "_testLineItemDatatableLink", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testLineItemDatatableLink", "access": "private", "description": null, "lineNumber": 638, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "dependencyContract", "types": [ "*" ] }, { "name": "dependencyKey", "types": [ "*" ] } ], "return": null }, { "__docId__": 813, "kind": "method", "name": "_testEmptyField", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testEmptyField", "access": "private", "description": null, "lineNumber": 663, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "dependencyContract", "types": [ "*" ] }, { "name": "dependencyKey", "types": [ "*" ] } ], "return": null }, { "__docId__": 814, "kind": "method", "name": "_testDatatableKey", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_testDatatableKey", "access": "private", "description": null, "lineNumber": 675, "undocument": true, "ignore": true, "params": [ { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "dependencyContract", "types": [ "*" ] }, { "name": "dependencyKey", "types": [ "*" ] } ], "return": null }, { "__docId__": 815, "kind": "method", "name": "_isValidDatatableKey", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_isValidDatatableKey", "access": "private", "description": null, "lineNumber": 696, "undocument": true, "ignore": true, "params": [ { "name": "datatableId", "types": [ "*" ] }, { "name": "key", "types": [ "*" ] }, { "name": "isColumn", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 816, "kind": "method", "name": "_getAssemblyTitle", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_getAssemblyTitle", "access": "private", "description": null, "lineNumber": 718, "undocument": true, "ignore": true, "params": [ { "name": "assemblyId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 817, "kind": "method", "name": "_logIssue", "memberof": "src/domain/services/BidValidator.js~BidValidator", "generator": false, "async": false, "static": false, "longname": "src/domain/services/BidValidator.js~BidValidator#_logIssue", "access": "private", "description": null, "lineNumber": 723, "undocument": true, "ignore": true, "params": [ { "name": "type", "types": [ "*" ] }, { "name": "sourceBidEntity", "types": [ "*" ] }, { "name": "dependencyContract", "types": [ "*" ] }, { "name": "meta", "types": [ "*" ] } ], "return": null }, { "__docId__": 818, "kind": "file", "name": "src/domain/services/EntityChangeLogService.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/EntityChangeLogService.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 819, "kind": "class", "name": "EntityChangeLogService", "memberof": "src/domain/services/EntityChangeLogService.js", "static": true, "longname": "src/domain/services/EntityChangeLogService.js~EntityChangeLogService", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/EntityChangeLogService.js", "importStyle": "EntityChangeLogService", "description": null, "lineNumber": 1, "undocument": true, "interface": false }, { "__docId__": 820, "kind": "constructor", "name": "constructor", "memberof": "src/domain/services/EntityChangeLogService.js~EntityChangeLogService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/EntityChangeLogService.js~EntityChangeLogService#constructor", "access": "public", "description": null, "lineNumber": 2, "undocument": true }, { "__docId__": 821, "kind": "member", "name": "entity", "memberof": "src/domain/services/EntityChangeLogService.js~EntityChangeLogService", "static": false, "longname": "src/domain/services/EntityChangeLogService.js~EntityChangeLogService#entity", "access": "public", "description": null, "lineNumber": 3, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 822, "kind": "method", "name": "saveChangeLog", "memberof": "src/domain/services/EntityChangeLogService.js~EntityChangeLogService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/EntityChangeLogService.js~EntityChangeLogService#saveChangeLog", "access": "public", "description": null, "lineNumber": 6, "undocument": true, "params": [ { "name": "originalValue", "types": [ "*" ] }, { "name": "newValue", "types": [ "*" ] }, { "name": "valueType", "types": [ "*" ] }, { "name": "entityProperty", "types": [ "*" ] }, { "name": "metaData", "types": [ "*" ] } ], "return": null }, { "__docId__": 823, "kind": "file", "name": "src/domain/services/FieldAutoPopulateService.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/FieldAutoPopulateService.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 824, "kind": "class", "name": "FieldAutoPopulateService", "memberof": "src/domain/services/FieldAutoPopulateService.js", "static": true, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/FieldAutoPopulateService.js", "importStyle": "FieldAutoPopulateService", "description": "", "lineNumber": 7, "unknown": [ { "tagName": "@class", "tagValue": "FieldAutoPopulateService" } ], "interface": false }, { "__docId__": 825, "kind": "constructor", "name": "constructor", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#constructor", "access": "public", "description": "Creates an instance of FieldAutoPopulateService.", "lineNumber": 12, "params": [ { "nullable": null, "types": [ "Field" ], "spread": false, "optional": false, "name": "field", "description": "" } ] }, { "__docId__": 826, "kind": "member", "name": "_field", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_field", "access": "private", "description": null, "lineNumber": 13, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 827, "kind": "method", "name": "shouldAutoPopulate", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#shouldAutoPopulate", "access": "public", "description": "Determines if field should auto populate.", "lineNumber": 21, "unknown": [ { "tagName": "@returns", "tagValue": "" } ], "params": [], "return": { "types": [ "*" ] } }, { "__docId__": 828, "kind": "method", "name": "autoPopulate", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#autoPopulate", "access": "public", "description": "Auto populates the field value based on its configuration.", "lineNumber": 28, "params": [], "return": null }, { "__docId__": 829, "kind": "method", "name": "_shouldAutoSelect", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_shouldAutoSelect", "access": "private", "description": "Determines if field should auto select its value.", "lineNumber": 45, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 830, "kind": "method", "name": "_shouldAutoFill", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_shouldAutoFill", "access": "private", "description": "Determines if field should auto fill its value.", "lineNumber": 64, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 831, "kind": "method", "name": "_shouldAutoToggleBoolean", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_shouldAutoToggleBoolean", "access": "private", "description": "Determines if field should auto toggle is value", "lineNumber": 79, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true, "params": [] }, { "__docId__": 832, "kind": "method", "name": "_autoToggleBoolean", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_autoToggleBoolean", "access": "private", "description": " Auto Toggles a boolean field when a dependency is referenced.", "lineNumber": 92, "ignore": true, "params": [], "return": null }, { "__docId__": 833, "kind": "method", "name": "_autoFill", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_autoFill", "access": "private", "description": "Auto fills the field based on the field rules.", "lineNumber": 225, "ignore": true, "params": [], "return": null }, { "__docId__": 834, "kind": "member", "name": "_nullDependencyCount", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_nullDependencyCount", "access": "private", "description": null, "lineNumber": 226, "undocument": true, "ignore": true, "type": { "types": [ "number" ] } }, { "__docId__": 835, "kind": "method", "name": "_autoSelect", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_autoSelect", "access": "private", "description": "Auto selects a field list option based on field rules.", "lineNumber": 313, "ignore": true, "params": [], "return": null }, { "__docId__": 837, "kind": "method", "name": "_evaluateDependency", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_evaluateDependency", "access": "private", "description": "Evaluates the contracts value and tracks if the dependency is null or has a null dependency itself", "lineNumber": 390, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "dependencyContract", "description": "The dependency contract to evaluate" } ], "return": { "nullable": null, "types": [ "number", "null", "undefined" ], "spread": false, "description": "The evaluated value of the dependency contract" }, "ignore": true }, { "__docId__": 839, "kind": "method", "name": "_filterLessThan", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_filterLessThan", "access": "private", "description": null, "lineNumber": 400, "undocument": true, "ignore": true, "params": [ { "name": "rowValues", "types": [ "*" ] }, { "name": "dependencyValue", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 840, "kind": "method", "name": "_filterGreaterThan", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_filterGreaterThan", "access": "private", "description": null, "lineNumber": 407, "undocument": true, "ignore": true, "params": [ { "name": "rowValues", "types": [ "*" ] }, { "name": "dependencyValue", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 841, "kind": "method", "name": "_filterBetween", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_filterBetween", "access": "private", "description": null, "lineNumber": 414, "undocument": true, "ignore": true, "params": [ { "name": "rowValues", "types": [ "*" ] }, { "name": "dependencyValueA", "types": [ "*" ] }, { "name": "dependencyValueB", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 842, "kind": "method", "name": "_filterEqual", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_filterEqual", "access": "private", "description": null, "lineNumber": 426, "undocument": true, "ignore": true, "params": [ { "name": "rowValues", "types": [ "*" ] }, { "name": "dependencyValueA", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 843, "kind": "method", "name": "_filterClosest", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_filterClosest", "access": "private", "description": null, "lineNumber": 433, "undocument": true, "ignore": true, "params": [ { "name": "rowValues", "types": [ "*" ] }, { "name": "dependencyValueA", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 844, "kind": "method", "name": "_setDefaultBooleanValue", "memberof": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/FieldAutoPopulateService.js~FieldAutoPopulateService#_setDefaultBooleanValue", "access": "private", "description": null, "lineNumber": 454, "undocument": true, "ignore": true, "params": [ { "name": "booleanValue", "types": [ "*" ] } ], "return": null }, { "__docId__": 845, "kind": "file", "name": "src/domain/services/IndicativePricingHelper.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/IndicativePricingHelper.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 846, "kind": "class", "name": "IndicativePricingHelper", "memberof": "src/domain/services/IndicativePricingHelper.js", "static": true, "longname": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/IndicativePricingHelper.js", "importStyle": "IndicativePricingHelper", "description": null, "lineNumber": 3, "undocument": true, "interface": false }, { "__docId__": 847, "kind": "constructor", "name": "constructor", "memberof": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 848, "kind": "member", "name": "bid", "memberof": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper", "static": false, "longname": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper#bid", "access": "public", "description": null, "lineNumber": 5, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 849, "kind": "method", "name": "getMarginOfError", "memberof": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper#getMarginOfError", "access": "public", "description": "Gets the margin of error for indicative pricing.", "lineNumber": 12, "return": { "nullable": null, "types": [ "int" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 850, "kind": "member", "name": "_marginOfErrorMetric", "memberof": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper", "static": false, "longname": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper#_marginOfErrorMetric", "access": "private", "description": null, "lineNumber": 14, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 852, "kind": "method", "name": "getIndicativePrice", "memberof": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper#getIndicativePrice", "access": "public", "description": "Gets indicative price", "lineNumber": 36, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bidPrice", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bidCost", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "isLow", "description": "The lower or upper bounds (low | high)" }, { "nullable": null, "types": [ "int" ], "spread": false, "optional": false, "name": "marginOfError", "description": "" }, { "nullable": null, "types": [ "array" ], "spread": false, "optional": false, "name": "weightedValues", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" } }, { "__docId__": 853, "kind": "method", "name": "isIndicativePricing", "memberof": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper#isIndicativePricing", "access": "public", "description": "Determines if indicative pricing is enabled.", "lineNumber": 53, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 854, "kind": "member", "name": "_indicativePricingField", "memberof": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper", "static": false, "longname": "src/domain/services/IndicativePricingHelper.js~IndicativePricingHelper#_indicativePricingField", "access": "private", "description": null, "lineNumber": 55, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 856, "kind": "file", "name": "src/domain/services/IndustryWidePredictionService.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/IndustryWidePredictionService.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 857, "kind": "class", "name": "IndustryWidePredictionService", "memberof": "src/domain/services/IndustryWidePredictionService.js", "static": true, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/IndustryWidePredictionService.js", "importStyle": "IndustryWidePredictionService", "description": null, "lineNumber": 6, "undocument": true, "interface": false }, { "__docId__": 858, "kind": "constructor", "name": "constructor", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#constructor", "access": "public", "description": "Constructor", "lineNumber": 11, "params": [ { "nullable": null, "types": [ "LineItem" ], "spread": false, "optional": false, "name": "lineItem", "description": "" } ] }, { "__docId__": 859, "kind": "member", "name": "lineItem", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#lineItem", "access": "public", "description": null, "lineNumber": 12, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 860, "kind": "member", "name": "bid", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#bid", "access": "public", "description": null, "lineNumber": 17, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 861, "kind": "member", "name": "industryWidePredictionModels", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#industryWidePredictionModels", "access": "public", "description": null, "lineNumber": 31, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 862, "kind": "member", "name": "lineItemDefs", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#lineItemDefs", "access": "public", "description": null, "lineNumber": 32, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 863, "kind": "member", "name": "predictionModel", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#predictionModel", "access": "public", "description": null, "lineNumber": 45, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 864, "kind": "member", "name": "models", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#models", "access": "public", "description": null, "lineNumber": 54, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 865, "kind": "member", "name": "distributionRanges", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#distributionRanges", "access": "public", "description": null, "lineNumber": 57, "undocument": true, "type": { "types": [ "number[]" ] } }, { "__docId__": 866, "kind": "member", "name": "zFactor", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#zFactor", "access": "public", "description": null, "lineNumber": 69, "undocument": true, "type": { "types": [ "number" ] } }, { "__docId__": 867, "kind": "member", "name": "predictionType", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#predictionType", "access": "public", "description": null, "lineNumber": 71, "undocument": true, "type": { "types": [ "string" ] } }, { "__docId__": 868, "kind": "member", "name": "_canUsePatch", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_canUsePatch", "access": "private", "description": null, "lineNumber": 76, "undocument": true, "ignore": true, "type": { "types": [ "{\"ignoreNullDependency\": *, \"nonNumericResult\": *, \"dependencyAssemblyContext\": *}" ] } }, { "__docId__": 869, "kind": "method", "name": "_getFilteredModels", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_getFilteredModels", "access": "private", "description": "Retrieves a filtered list of prediction models", "lineNumber": 89, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "filterByType", "description": "'cost' or 'labor_hours' the type of models to retrieve" } ], "return": { "nullable": null, "types": [ "object[]" ], "spread": false, "description": "List of models filtered by the filterType" }, "ignore": true }, { "__docId__": 870, "kind": "method", "name": "hasPredictionModels", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#hasPredictionModels", "access": "public", "description": "Determine if the line item has any prediction models", "lineNumber": 98, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 871, "kind": "method", "name": "getDistributionRanges", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#getDistributionRanges", "access": "public", "description": "Returns the distribution ranges", "lineNumber": 107, "return": { "nullable": null, "types": [ "number[]" ], "spread": false, "description": "The distribution ranges" }, "params": [] }, { "__docId__": 872, "kind": "method", "name": "getCostPredictionModels", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#getCostPredictionModels", "access": "public", "description": "Retrieves a list of cost prediction models", "lineNumber": 116, "return": { "nullable": null, "types": [ "Object[]" ], "spread": false, "description": "cost prediction models" }, "params": [] }, { "__docId__": 873, "kind": "method", "name": "getLaborPredictionModels", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#getLaborPredictionModels", "access": "public", "description": "Retrieves a list of labor prediction models", "lineNumber": 125, "return": { "nullable": null, "types": [ "Object[]" ], "spread": false, "description": "labor prediction models" }, "params": [] }, { "__docId__": 874, "kind": "method", "name": "getContributionWeight", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#getContributionWeight", "access": "public", "description": "Retrieves the contribution weight for the line item", "lineNumber": 134, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "The contribution weight" }, "params": [] }, { "__docId__": 875, "kind": "method", "name": "_getWeightedAvg", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_getWeightedAvg", "access": "private", "description": "Gets average model value weighted by r2 for the given evaluated models", "lineNumber": 147, "params": [ { "nullable": null, "types": [ "EvaluatedModel[]" ], "spread": false, "optional": false, "name": "evaluatedModels", "description": "The evaluated model object. Must include the model's evaluated 'value' and 'r2'" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "Weighted average" }, "ignore": true }, { "__docId__": 876, "kind": "method", "name": "_getWeightedBoundsAvg", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_getWeightedBoundsAvg", "access": "private", "description": null, "lineNumber": 162, "undocument": true, "ignore": true, "params": [ { "name": "evaluatedModels", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 877, "kind": "method", "name": "_getExperimentalWeightedAvg", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_getExperimentalWeightedAvg", "access": "private", "description": "Get the weighted average result of the prediction models based on scaled r2", "lineNumber": 195, "params": [ { "nullable": null, "types": [ "EvaluatedModel[]" ], "spread": false, "optional": false, "name": "evaluatedModels", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 878, "kind": "method", "name": "_getModelDependencyValue", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_getModelDependencyValue", "access": "private", "description": "Evaluates a prediction model dependency. Returns null if it cannot be evaluated.", "lineNumber": 213, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "modelDependency", "description": "A prediction model dependency" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "modelDependency.type", "description": "The type of dependency. Either 'field' or 'metric'" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "modelDependency.definition_id", "description": "The definition id of the dependency" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "modelDependency.field", "description": "The dependencies value field. Typically 'value'" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "isBaseModel", "description": "Whether or not this is the base model for the line item.\n If it is, the value should be given even if the dependency is not fully defined." } ], "return": { "nullable": null, "types": [ "number", "null" ], "spread": false, "description": "The evaluated value of the dependency" }, "ignore": true }, { "__docId__": 879, "kind": "method", "name": "_getModelDependency", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_getModelDependency", "access": "private", "description": "Get the dependency used by the prediction model", "lineNumber": 228, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "definitionId", "description": "" } ], "return": { "nullable": null, "types": [ "object", "undefined" ], "spread": false, "description": "bid entity" }, "ignore": true }, { "__docId__": 880, "kind": "method", "name": "_canUseDependency", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_canUseDependency", "access": "private", "description": "Determine if the entity should be used to evaluate a prediction model.\nBecause of the need to maintain the integrity of old estimates,\n a date check is used here to ensure only prediction models generated\n after the fix date get the fix", "lineNumber": 252, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "entity", "description": "" }, { "nullable": true, "types": [ "object" ], "spread": false, "optional": false, "name": "field", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 881, "kind": "method", "name": "_isInBounds", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_isInBounds", "access": "private", "description": "Determines whether the given value is within the given range (including a 15% factor)\nRange is defined as the lowest and highest values in the dataset for the given model", "lineNumber": 265, "params": [ { "nullable": null, "types": [ "number[]" ], "spread": false, "optional": false, "name": "bounds", "description": "the upper and lower bounds" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "value", "description": "the value to be evaluated" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "Whether or not the value is in bounds" }, "ignore": true }, { "__docId__": 882, "kind": "typedef", "name": "EvaluatedModel", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "static": true, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService.EvaluatedModel", "access": "public", "description": "", "properties": [ { "nullable": null, "types": [ "number", "null" ], "spread": false, "optional": false, "name": "value", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "isInBounds", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "r2", "description": "" } ], "type": { "types": [ "Object" ], "optional": false, "name": "EvaluatedModel" } }, { "__docId__": 883, "kind": "method", "name": "evaluateModel", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#evaluateModel", "access": "public", "description": "Evaluates a single prediction model", "lineNumber": 287, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "model", "description": "A prediction model to evaluate" } ], "return": { "nullable": null, "types": [ "EvaluatedModel" ], "spread": false, "description": "The result of evaluating the model" } }, { "__docId__": 884, "kind": "method", "name": "evaluateModels", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#evaluateModels", "access": "public", "description": "Evaluates all the given models and returns a weighted average of the significant results", "lineNumber": 380, "params": [ { "nullable": null, "types": [ "object[]" ], "spread": false, "optional": false, "name": "models", "description": "The models to evaluate" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "The weighted avg of evaluating the given models" } }, { "__docId__": 885, "kind": "method", "name": "evaluateModelsExperimental", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#evaluateModelsExperimental", "access": "public", "description": "Evaluate the models using an experimental weighting", "lineNumber": 406, "params": [ { "nullable": null, "types": [ "object[]" ], "spread": false, "optional": false, "name": "models", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" } }, { "__docId__": 886, "kind": "method", "name": "_getEvaluatedModels", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_getEvaluatedModels", "access": "private", "description": "Evaluate the given models in order of descending r2 value.", "lineNumber": 418, "params": [ { "nullable": null, "types": [ "object[]" ], "spread": false, "optional": false, "name": "models", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": true, "defaultValue": "5", "defaultRaw": 5, "name": "limit", "description": "The maximum number of models to evaluate" } ], "return": { "nullable": null, "types": [ "EvaluatedModel[]" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 887, "kind": "method", "name": "_filterByBounds", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#_filterByBounds", "access": "private", "description": "If any models are in bounds, filter out-of-bounds models from the given models.\nTODO: indicate if out-of-bounds models are used as this could reduce the quality of prediction", "lineNumber": 440, "params": [ { "nullable": null, "types": [ "EvaluatedModel[]" ], "spread": false, "optional": false, "name": "models", "description": "" } ], "return": { "nullable": null, "types": [ "EvaluatedModel[]" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 888, "kind": "method", "name": "getPredictionDependencies", "memberof": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/IndustryWidePredictionService.js~IndustryWidePredictionService#getPredictionDependencies", "access": "public", "description": "Gets the dependencies used in the prediction models for the given line item def id", "lineNumber": 450, "return": { "nullable": null, "types": [ "bidEntity[]" ], "spread": false, "description": "The prediction model dependencies" }, "params": [] }, { "__docId__": 889, "kind": "file", "name": "src/domain/services/LineItemRuleService.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/LineItemRuleService.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 890, "kind": "class", "name": "LineItemRuleService", "memberof": "src/domain/services/LineItemRuleService.js", "static": true, "longname": "src/domain/services/LineItemRuleService.js~LineItemRuleService", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/LineItemRuleService.js", "importStyle": "LineItemRuleService", "description": null, "lineNumber": 4, "undocument": true, "interface": false }, { "__docId__": 891, "kind": "method", "name": "isIncluded", "memberof": "src/domain/services/LineItemRuleService.js~LineItemRuleService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/LineItemRuleService.js~LineItemRuleService#isIncluded", "access": "public", "description": null, "lineNumber": 5, "undocument": true, "params": [ { "name": "lineItem", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 892, "kind": "method", "name": "isWeighted", "memberof": "src/domain/services/LineItemRuleService.js~LineItemRuleService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/LineItemRuleService.js~LineItemRuleService#isWeighted", "access": "public", "description": "Determine if the line item should be weighted by examining the rules\nA line item will be weighted if predictive pricing is enabled AND a rule dependency is not defined", "lineNumber": 46, "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "lineItem", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 893, "kind": "method", "name": "_isUsingUndefinedDependencies", "memberof": "src/domain/services/LineItemRuleService.js~LineItemRuleService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/LineItemRuleService.js~LineItemRuleService#_isUsingUndefinedDependencies", "access": "private", "description": "Determine if a rule is relying on any undefined dependency values", "lineNumber": 67, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "rule", "description": "The line item rule" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "lineItem", "description": "The line item" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 894, "kind": "method", "name": "_evalExpressionRule", "memberof": "src/domain/services/LineItemRuleService.js~LineItemRuleService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/LineItemRuleService.js~LineItemRuleService#_evalExpressionRule", "access": "private", "description": null, "lineNumber": 96, "undocument": true, "ignore": true, "params": [ { "name": "lineItemRule", "types": [ "*" ] }, { "name": "lineItem", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 895, "kind": "method", "name": "_evalToggleFieldRule", "memberof": "src/domain/services/LineItemRuleService.js~LineItemRuleService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/LineItemRuleService.js~LineItemRuleService#_evalToggleFieldRule", "access": "private", "description": null, "lineNumber": 112, "undocument": true, "ignore": true, "params": [ { "name": "lineItemRule", "types": [ "*" ] }, { "name": "lineItem", "types": [ "*" ] } ], "return": { "types": [ "boolean" ] } }, { "__docId__": 896, "kind": "method", "name": "_evalListSelectRule", "memberof": "src/domain/services/LineItemRuleService.js~LineItemRuleService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/LineItemRuleService.js~LineItemRuleService#_evalListSelectRule", "access": "private", "description": null, "lineNumber": 122, "undocument": true, "ignore": true, "params": [ { "name": "lineItemRule", "types": [ "*" ] }, { "name": "lineItem", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 897, "kind": "file", "name": "src/domain/services/PredictionService.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/PredictionService.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 898, "kind": "class", "name": "PredictionService", "memberof": "src/domain/services/PredictionService.js", "static": true, "longname": "src/domain/services/PredictionService.js~PredictionService", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/PredictionService.js", "importStyle": "PredictionService", "description": null, "lineNumber": 6, "undocument": true, "interface": false }, { "__docId__": 899, "kind": "constructor", "name": "constructor", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#constructor", "access": "public", "description": "Constructor", "lineNumber": 11, "params": [ { "nullable": null, "types": [ "LineItem" ], "spread": false, "optional": false, "name": "lineItem", "description": "" } ] }, { "__docId__": 900, "kind": "member", "name": "lineItem", "memberof": "src/domain/services/PredictionService.js~PredictionService", "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#lineItem", "access": "public", "description": null, "lineNumber": 12, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 901, "kind": "member", "name": "bid", "memberof": "src/domain/services/PredictionService.js~PredictionService", "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#bid", "access": "public", "description": null, "lineNumber": 17, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 902, "kind": "member", "name": "models", "memberof": "src/domain/services/PredictionService.js~PredictionService", "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#models", "access": "public", "description": null, "lineNumber": 19, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 903, "kind": "member", "name": "distributionRanges", "memberof": "src/domain/services/PredictionService.js~PredictionService", "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#distributionRanges", "access": "public", "description": null, "lineNumber": 21, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 904, "kind": "member", "name": "zFactor", "memberof": "src/domain/services/PredictionService.js~PredictionService", "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#zFactor", "access": "public", "description": null, "lineNumber": 25, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 905, "kind": "member", "name": "predictionType", "memberof": "src/domain/services/PredictionService.js~PredictionService", "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#predictionType", "access": "public", "description": null, "lineNumber": 29, "undocument": true, "type": { "types": [ "string" ] } }, { "__docId__": 906, "kind": "member", "name": "_canUsePatch", "memberof": "src/domain/services/PredictionService.js~PredictionService", "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_canUsePatch", "access": "private", "description": null, "lineNumber": 34, "undocument": true, "ignore": true, "type": { "types": [ "{\"ignoreNullDependency\": *, \"nonNumericResult\": *, \"dependencyAssemblyContext\": *}" ] } }, { "__docId__": 907, "kind": "method", "name": "_getFilteredModels", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_getFilteredModels", "access": "private", "description": "Retrieves a filtered list of prediction models", "lineNumber": 47, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "filterByType", "description": "'cost' or 'labor_hours' the type of models to retrieve" } ], "return": { "nullable": null, "types": [ "object[]" ], "spread": false, "description": "List of models filtered by the filterType" }, "ignore": true }, { "__docId__": 908, "kind": "method", "name": "hasPredictionModels", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#hasPredictionModels", "access": "public", "description": "Determine if the line item has any prediction models", "lineNumber": 56, "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 909, "kind": "method", "name": "getDistributionRanges", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#getDistributionRanges", "access": "public", "description": "Returns the distribution ranges", "lineNumber": 65, "return": { "nullable": null, "types": [ "number[]" ], "spread": false, "description": "The distribution ranges" }, "params": [] }, { "__docId__": 910, "kind": "method", "name": "getCostPredictionModels", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#getCostPredictionModels", "access": "public", "description": "Retrieves a list of cost prediction models", "lineNumber": 74, "return": { "nullable": null, "types": [ "Object[]" ], "spread": false, "description": "cost prediction models" }, "params": [] }, { "__docId__": 911, "kind": "method", "name": "getLaborPredictionModels", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#getLaborPredictionModels", "access": "public", "description": "Retrieves a list of labor prediction models", "lineNumber": 83, "return": { "nullable": null, "types": [ "Object[]" ], "spread": false, "description": "labor prediction models" }, "params": [] }, { "__docId__": 912, "kind": "method", "name": "getContributionWeight", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#getContributionWeight", "access": "public", "description": "Retrieves the contribution weight for the line item", "lineNumber": 92, "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "The contribution weight" }, "params": [] }, { "__docId__": 913, "kind": "method", "name": "_getWeightedAvg", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_getWeightedAvg", "access": "private", "description": "Gets average model value weighted by r2 for the given evaluated models", "lineNumber": 102, "params": [ { "nullable": null, "types": [ "EvaluatedModel[]" ], "spread": false, "optional": false, "name": "evaluatedModels", "description": "The evaluated model object. Must include the model's evaluated 'value' and 'r2'" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "Weighted average" }, "ignore": true }, { "__docId__": 914, "kind": "method", "name": "_getWeightedBoundsAvg", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_getWeightedBoundsAvg", "access": "private", "description": null, "lineNumber": 117, "undocument": true, "ignore": true, "params": [ { "name": "evaluatedModels", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 915, "kind": "method", "name": "_getExperimentalWeightedAvg", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_getExperimentalWeightedAvg", "access": "private", "description": "Get the weighted average result of the prediction models based on scaled r2", "lineNumber": 150, "params": [ { "nullable": null, "types": [ "EvaluatedModel[]" ], "spread": false, "optional": false, "name": "evaluatedModels", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 916, "kind": "method", "name": "_getModelDependencyValue", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_getModelDependencyValue", "access": "private", "description": "Evaluates a prediction model dependency. Returns null if it cannot be evaluated.", "lineNumber": 168, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "modelDependency", "description": "A prediction model dependency" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "modelDependency.type", "description": "The type of dependency. Either 'field' or 'metric'" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "modelDependency.definition_id", "description": "The definition id of the dependency" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "modelDependency.field", "description": "The dependencies value field. Typically 'value'" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "isBaseModel", "description": "Whether or not this is the base model for the line item.\n If it is, the value should be given even if the dependency is not fully defined." } ], "return": { "nullable": null, "types": [ "number", "null" ], "spread": false, "description": "The evaluated value of the dependency" }, "ignore": true }, { "__docId__": 917, "kind": "method", "name": "_getModelDependency", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_getModelDependency", "access": "private", "description": "Get the dependency used by the prediction model", "lineNumber": 183, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "type", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "definitionId", "description": "" } ], "return": { "nullable": null, "types": [ "object", "undefined" ], "spread": false, "description": "bid entity" }, "ignore": true }, { "__docId__": 918, "kind": "method", "name": "_canUseDependency", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_canUseDependency", "access": "private", "description": "Determine if the entity should be used to evaluate a prediction model.\nBecause of the need to maintain the integrity of old estimates,\n a date check is used here to ensure only prediction models generated\n after the fix date get the fix", "lineNumber": 207, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "entity", "description": "" }, { "nullable": true, "types": [ "object" ], "spread": false, "optional": false, "name": "field", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 919, "kind": "method", "name": "_isInBounds", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_isInBounds", "access": "private", "description": "Determines whether the given value is within the given range (including a 15% factor)\nRange is defined as the lowest and highest values in the dataset for the given model", "lineNumber": 220, "params": [ { "nullable": null, "types": [ "number[]" ], "spread": false, "optional": false, "name": "bounds", "description": "the upper and lower bounds" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "value", "description": "the value to be evaluated" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "Whether or not the value is in bounds" }, "ignore": true }, { "__docId__": 920, "kind": "typedef", "name": "EvaluatedModel", "memberof": "src/domain/services/PredictionService.js~PredictionService", "static": true, "longname": "src/domain/services/PredictionService.js~PredictionService.EvaluatedModel", "access": "public", "description": "", "properties": [ { "nullable": null, "types": [ "number", "null" ], "spread": false, "optional": false, "name": "value", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "isInBounds", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "r2", "description": "" } ], "type": { "types": [ "Object" ], "optional": false, "name": "EvaluatedModel" } }, { "__docId__": 921, "kind": "method", "name": "evaluateModel", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#evaluateModel", "access": "public", "description": "Evaluates a single prediction model", "lineNumber": 242, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "model", "description": "A prediction model to evaluate" } ], "return": { "nullable": null, "types": [ "EvaluatedModel" ], "spread": false, "description": "The result of evaluating the model" } }, { "__docId__": 922, "kind": "method", "name": "evaluateModels", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#evaluateModels", "access": "public", "description": "Evaluates all the given models and returns a weighted average of the significant results", "lineNumber": 332, "params": [ { "nullable": null, "types": [ "object[]" ], "spread": false, "optional": false, "name": "models", "description": "The models to evaluate" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "The weighted avg of evaluating the given models" } }, { "__docId__": 923, "kind": "method", "name": "evaluateModelsExperimental", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#evaluateModelsExperimental", "access": "public", "description": "Evaluate the models using an experimental weighting", "lineNumber": 358, "params": [ { "nullable": null, "types": [ "object[]" ], "spread": false, "optional": false, "name": "models", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" } }, { "__docId__": 924, "kind": "method", "name": "_getEvaluatedModels", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_getEvaluatedModels", "access": "private", "description": "Evaluate the given models in order of descending r2 value.", "lineNumber": 370, "params": [ { "nullable": null, "types": [ "object[]" ], "spread": false, "optional": false, "name": "models", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": true, "defaultValue": "5", "defaultRaw": 5, "name": "limit", "description": "The maximum number of models to evaluate" } ], "return": { "nullable": null, "types": [ "EvaluatedModel[]" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 925, "kind": "method", "name": "_filterByBounds", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_filterByBounds", "access": "private", "description": "If any models are in bounds, filter out-of-bounds models from the given models.\nTODO: indicate if out-of-bounds models are used as this could reduce the quality of prediction", "lineNumber": 392, "params": [ { "nullable": null, "types": [ "EvaluatedModel[]" ], "spread": false, "optional": false, "name": "models", "description": "" } ], "return": { "nullable": null, "types": [ "EvaluatedModel[]" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 926, "kind": "method", "name": "getPredictionDependencies", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#getPredictionDependencies", "access": "public", "description": "Gets the dependencies used in the prediction models for the given line item def id", "lineNumber": 402, "return": { "nullable": null, "types": [ "bidEntity[]" ], "spread": false, "description": "The prediction model dependencies" }, "params": [] }, { "__docId__": 927, "kind": "method", "name": "_getZFactor", "memberof": "src/domain/services/PredictionService.js~PredictionService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/PredictionService.js~PredictionService#_getZFactor", "access": "private", "description": "Get the Z-Factor for this Bid Line Item", "lineNumber": 425, "params": [ { "nullable": null, "types": [ "object[]" ], "spread": false, "optional": false, "name": "lineItem", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 928, "kind": "file", "name": "src/domain/services/ProjectSavingHelper.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/ProjectSavingHelper.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 929, "kind": "class", "name": "ProjectSavingHelper", "memberof": "src/domain/services/ProjectSavingHelper.js", "static": true, "longname": "src/domain/services/ProjectSavingHelper.js~ProjectSavingHelper", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/ProjectSavingHelper.js", "importStyle": "ProjectSavingHelper", "description": null, "lineNumber": 3, "undocument": true, "interface": false }, { "__docId__": 930, "kind": "method", "name": "extract", "memberof": "src/domain/services/ProjectSavingHelper.js~ProjectSavingHelper", "generator": false, "async": false, "static": false, "longname": "src/domain/services/ProjectSavingHelper.js~ProjectSavingHelper#extract", "access": "public", "description": null, "lineNumber": 4, "undocument": true, "params": [ { "name": "project", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 931, "kind": "file", "name": "src/domain/services/ProjectService.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/domain/services/ProjectService.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 932, "kind": "class", "name": "ProjectService", "memberof": "src/domain/services/ProjectService.js", "static": true, "longname": "src/domain/services/ProjectService.js~ProjectService", "access": "public", "export": true, "importPath": "pvbid-sdk/src/domain/services/ProjectService.js", "importStyle": "ProjectService", "description": "", "lineNumber": 12, "params": [ { "nullable": null, "types": [ "ProjectRepository" ], "spread": false, "optional": false, "name": "projectRepository", "description": "" }, { "nullable": null, "types": [ "BidService" ], "spread": false, "optional": false, "name": "bidService", "description": "" } ], "interface": false }, { "__docId__": 933, "kind": "constructor", "name": "constructor", "memberof": "src/domain/services/ProjectService.js~ProjectService", "generator": false, "async": false, "static": false, "longname": "src/domain/services/ProjectService.js~ProjectService#constructor", "access": "public", "description": "Creates an instance of ProjectService.", "lineNumber": 17, "params": [ { "nullable": null, "types": [ "PVBidContext" ], "spread": false, "optional": false, "name": "context", "description": "" } ] }, { "__docId__": 934, "kind": "member", "name": "context", "memberof": "src/domain/services/ProjectService.js~ProjectService", "static": false, "longname": "src/domain/services/ProjectService.js~ProjectService#context", "access": "public", "description": null, "lineNumber": 18, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 935, "kind": "member", "name": "repositories", "memberof": "src/domain/services/ProjectService.js~ProjectService", "static": false, "longname": "src/domain/services/ProjectService.js~ProjectService#repositories", "access": "public", "description": null, "lineNumber": 19, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 936, "kind": "member", "name": "_savingHelper", "memberof": "src/domain/services/ProjectService.js~ProjectService", "static": false, "longname": "src/domain/services/ProjectService.js~ProjectService#_savingHelper", "access": "private", "description": null, "lineNumber": 20, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 937, "kind": "method", "name": "save", "memberof": "src/domain/services/ProjectService.js~ProjectService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/ProjectService.js~ProjectService#save", "access": "public", "description": "Saves project and underlying bids.", "lineNumber": 31, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "Project" ], "spread": false, "optional": false, "name": "project", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "options.isAutoSave", "description": "indicate if this is the result of an auto-save" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 938, "kind": "method", "name": "saveChangeLog", "memberof": "src/domain/services/ProjectService.js~ProjectService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/ProjectService.js~ProjectService#saveChangeLog", "access": "public", "description": null, "lineNumber": 82, "undocument": true, "params": [ { "name": "project", "types": [ "*" ] }, { "name": "entityChangeData", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 939, "kind": "method", "name": "createBid", "memberof": "src/domain/services/ProjectService.js~ProjectService", "generator": false, "async": true, "static": false, "longname": "src/domain/services/ProjectService.js~ProjectService#createBid", "access": "public", "description": "Creates bid and attaches to project.", "lineNumber": 92, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "Project" ], "spread": false, "optional": false, "name": "project", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "New Bid", "defaultRaw": "New Bid", "name": "title", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 940, "kind": "file", "name": "src/pvbid.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/pvbid.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 941, "kind": "function", "name": "createContext", "memberof": "src/pvbid.js", "generator": false, "async": false, "static": true, "longname": "src/pvbid.js~createContext", "access": "public", "export": true, "importPath": "pvbid-sdk/src/pvbid.js", "importStyle": "{createContext}", "description": "Creates a authorized context instance.", "lineNumber": 17, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "config", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "config.token", "description": "The auth token to access account data.." }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "https://api.pvbid.com/v2", "defaultRaw": "https://api.pvbid.com/v2", "name": "config.base_uri", "description": "" } ], "return": { "nullable": null, "types": [ "PVBidContext" ], "spread": false, "description": "" } }, { "__docId__": 942, "kind": "function", "name": "getAuthToken", "memberof": "src/pvbid.js", "generator": false, "async": false, "static": true, "longname": "src/pvbid.js~getAuthToken", "access": "public", "export": true, "importPath": "pvbid-sdk/src/pvbid.js", "importStyle": "{getAuthToken}", "description": "Obtains a user access token and refresh_token.", "lineNumber": 34, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "username", "description": "The user's email address is used" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "password", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "config", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": true, "defaultValue": "https://api.pvbid.com/v2", "defaultRaw": "https://api.pvbid.com/v2", "name": "config.base_uri", "description": "" } ], "properties": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "token_type", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "expires_in", "description": "Unix timestamp" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "access_token", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "refresh_token", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 943, "kind": "variable", "name": "helpers", "memberof": "src/pvbid.js", "static": true, "longname": "src/pvbid.js~helpers", "access": "public", "export": true, "importPath": "pvbid-sdk/src/pvbid.js", "importStyle": "{helpers}", "description": null, "lineNumber": 43, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 944, "kind": "variable", "name": "services", "memberof": "src/pvbid.js", "static": true, "longname": "src/pvbid.js~services", "access": "public", "export": true, "importPath": "pvbid-sdk/src/pvbid.js", "importStyle": "{services}", "description": null, "lineNumber": 44, "undocument": true, "type": { "types": [ "{\"BaseWorkupService\": *}" ] } }, { "__docId__": 945, "kind": "file", "name": "src/repositories/AssemblyDefRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/AssemblyDefRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 946, "kind": "class", "name": "AssemblyDefRepository", "memberof": "src/repositories/AssemblyDefRepository.js", "static": true, "longname": "src/repositories/AssemblyDefRepository.js~AssemblyDefRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/AssemblyDefRepository.js", "importStyle": "AssemblyDefRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository" ] }, { "__docId__": 947, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/AssemblyDefRepository.js~AssemblyDefRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/AssemblyDefRepository.js~AssemblyDefRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 948, "kind": "file", "name": "src/repositories/AssemblyRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/AssemblyRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 949, "kind": "class", "name": "AssemblyRepository", "memberof": "src/repositories/AssemblyRepository.js", "static": true, "longname": "src/repositories/AssemblyRepository.js~AssemblyRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/AssemblyRepository.js", "importStyle": "AssemblyRepository", "description": "", "lineNumber": 7, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 950, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/AssemblyRepository.js~AssemblyRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/AssemblyRepository.js~AssemblyRepository#constructor", "access": "public", "description": null, "lineNumber": 8, "undocument": true }, { "__docId__": 951, "kind": "method", "name": "findById", "memberof": "src/repositories/AssemblyRepository.js~AssemblyRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/AssemblyRepository.js~AssemblyRepository#findById", "access": "public", "description": null, "lineNumber": 12, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "assemblyId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 952, "kind": "member", "name": "endpoint", "memberof": "src/repositories/AssemblyRepository.js~AssemblyRepository", "static": false, "longname": "src/repositories/AssemblyRepository.js~AssemblyRepository#endpoint", "access": "public", "description": null, "lineNumber": 13, "undocument": true, "type": { "types": [ "string" ] } }, { "__docId__": 953, "kind": "method", "name": "get", "memberof": "src/repositories/AssemblyRepository.js~AssemblyRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/AssemblyRepository.js~AssemblyRepository#get", "access": "public", "description": null, "lineNumber": 17, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "params", "types": [ "*" ] }, { "name": "forceReload", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 955, "kind": "method", "name": "create", "memberof": "src/repositories/AssemblyRepository.js~AssemblyRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/AssemblyRepository.js~AssemblyRepository#create", "access": "public", "description": "Inherited function has been disabled.\nUse {@link AssemblyRepository.implement}", "lineNumber": 27, "throws": [ { "types": [ "error" ], "description": "Throws exception when accessed." } ], "params": [], "return": null }, { "__docId__": 956, "kind": "method", "name": "delete", "memberof": "src/repositories/AssemblyRepository.js~AssemblyRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/AssemblyRepository.js~AssemblyRepository#delete", "access": "public", "description": null, "lineNumber": 31, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "assemblyId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 958, "kind": "method", "name": "implement", "memberof": "src/repositories/AssemblyRepository.js~AssemblyRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/AssemblyRepository.js~AssemblyRepository#implement", "access": "public", "description": null, "lineNumber": 36, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "assemblyId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 960, "kind": "file", "name": "src/repositories/BaseDefinitionRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/BaseDefinitionRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 961, "kind": "class", "name": "BaseDefinitionRepository", "memberof": "src/repositories/BaseDefinitionRepository.js", "static": true, "longname": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/BaseDefinitionRepository.js", "importStyle": "BaseDefinitionRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 962, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 963, "kind": "method", "name": "findById", "memberof": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository#findById", "access": "public", "description": null, "lineNumber": 8, "undocument": true, "params": [ { "name": "id", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 964, "kind": "method", "name": "get", "memberof": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository#get", "access": "public", "description": null, "lineNumber": 12, "undocument": true, "params": [ { "name": "params", "optional": true, "types": [ "{}" ], "defaultRaw": {}, "defaultValue": "{}" } ], "return": { "types": [ "*" ] } }, { "__docId__": 965, "kind": "method", "name": "save", "memberof": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository#save", "access": "public", "description": null, "lineNumber": 17, "undocument": true, "params": [], "return": null }, { "__docId__": 966, "kind": "method", "name": "create", "memberof": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository#create", "access": "public", "description": null, "lineNumber": 23, "undocument": true, "params": [], "return": null }, { "__docId__": 967, "kind": "method", "name": "delete", "memberof": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository#delete", "access": "public", "description": null, "lineNumber": 29, "undocument": true, "params": [], "return": null }, { "__docId__": 968, "kind": "file", "name": "src/repositories/BaseRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/BaseRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 969, "kind": "class", "name": "BaseRepository", "memberof": "src/repositories/BaseRepository.js", "static": true, "longname": "src/repositories/BaseRepository.js~BaseRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/BaseRepository.js", "importStyle": "BaseRepository", "description": "", "lineNumber": 8, "interface": false }, { "__docId__": 970, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#constructor", "access": "public", "description": "Creates an instance of BaseRepository.", "lineNumber": 16, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "endpoint", "description": "The API endpoint for the entity" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "singleMap", "description": "The singular noun for the entity (ie. 'bid' or 'assembly')" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "multiMap", "description": "The plural noun for the entity (ie. 'bids' or 'assemblies')" } ] }, { "__docId__": 971, "kind": "member", "name": "httpConfig", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#httpConfig", "access": "public", "description": null, "lineNumber": 20, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 972, "kind": "member", "name": "metaData", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#metaData", "access": "public", "description": null, "lineNumber": 21, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 973, "kind": "member", "name": "params", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#params", "access": "public", "description": null, "lineNumber": 22, "undocument": true, "type": { "types": [ "{}" ] } }, { "__docId__": 974, "kind": "member", "name": "endpoint", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#endpoint", "access": "public", "description": null, "lineNumber": 23, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 975, "kind": "member", "name": "map", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#map", "access": "public", "description": null, "lineNumber": 24, "undocument": true, "type": { "types": [ "{\"single\": *, \"multi\": *}" ] } }, { "__docId__": 976, "kind": "member", "name": "http", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#http", "access": "public", "description": null, "lineNumber": 25, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 977, "kind": "method", "name": "findById", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#findById", "access": "public", "description": "Retrieves a single domain object by its id.", "lineNumber": 36, "params": [ { "nullable": null, "types": [ "number", "string" ], "spread": false, "optional": false, "name": "id", "description": "The id of the entity to retrieve." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 978, "kind": "method", "name": "get", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#get", "access": "public", "description": "Retrieves an array of results for the endpoint", "lineNumber": 56, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "params", "description": "A set of parameters to include for the endpoint." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Array of results filtered by the given params" } }, { "__docId__": 981, "kind": "method", "name": "save", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#save", "access": "public", "description": "Persists an update to the entity", "lineNumber": 80, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise} The updated entity" } ], "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "entity", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "The updated entity" } }, { "__docId__": 982, "kind": "method", "name": "create", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#create", "access": "public", "description": "Persists a new entity", "lineNumber": 97, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise} The newly persisted entity" } ], "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "entity", "description": "An entity object to persist" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "The newly persisted entity" } }, { "__docId__": 983, "kind": "method", "name": "delete", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#delete", "access": "public", "description": "Deletes a single entity by its id", "lineNumber": 114, "params": [ { "nullable": null, "types": [ "number", "string" ], "spread": false, "optional": false, "name": "id", "description": "The id of the entity to delete" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Response status message" } }, { "__docId__": 984, "kind": "method", "name": "_applyIntercepts", "memberof": "src/repositories/BaseRepository.js~BaseRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/BaseRepository.js~BaseRepository#_applyIntercepts", "access": "private", "description": "Apply the impersonation ID to the request if applicable", "lineNumber": 131, "ignore": true, "params": [], "return": null }, { "__docId__": 985, "kind": "file", "name": "src/repositories/BidDocumentRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/BidDocumentRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 986, "kind": "file", "name": "src/repositories/BidRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/BidRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 987, "kind": "class", "name": "BidRepository", "memberof": "src/repositories/BidRepository.js", "static": true, "longname": "src/repositories/BidRepository.js~BidRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/BidRepository.js", "importStyle": "BidRepository", "description": "", "lineNumber": 7, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 988, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/BidRepository.js~BidRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/BidRepository.js~BidRepository#constructor", "access": "public", "description": null, "lineNumber": 8, "undocument": true }, { "__docId__": 989, "kind": "method", "name": "get", "memberof": "src/repositories/BidRepository.js~BidRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/BidRepository.js~BidRepository#get", "access": "public", "description": "Retrieves a list of bids", "lineNumber": 25, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "params", "description": "A set of parameters to filter the bids by." }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "params.per_page", "description": "Number of bids to to display per request (max 100)" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "params.page", "description": "Page number" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "params.search", "description": "Search term to apply to bid's title" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "params.sort_order", "description": "'asc' or 'desc'" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "params.order_by", "description": "The name of the property to sort the results by" }, { "nullable": null, "types": [ "number[]" ], "spread": false, "optional": false, "name": "params.statuses", "description": "List of status ids to filter by (excluding this will include all statuses)" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "params.owner_id", "description": "Specify the user id of the bids owner" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Filtered list of bids" } }, { "__docId__": 990, "kind": "method", "name": "clone", "memberof": "src/repositories/BidRepository.js~BidRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/BidRepository.js~BidRepository#clone", "access": "public", "description": "Create a clone of the bid", "lineNumber": 35, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bidId", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Bid clone" } }, { "__docId__": 991, "kind": "method", "name": "moveToProject", "memberof": "src/repositories/BidRepository.js~BidRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/BidRepository.js~BidRepository#moveToProject", "access": "public", "description": "Init a request to move a bid to a project via bid and project id.\nreturns the request status as fail or success.", "lineNumber": 55, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise>}" } ], "params": [ { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "bidId", "description": "" }, { "nullable": null, "types": [ "*" ], "spread": false, "optional": false, "name": "projectId", "description": "" } ], "return": { "nullable": null, "types": [ "Promise>" ], "spread": false, "description": "" } }, { "__docId__": 992, "kind": "file", "name": "src/repositories/CacheRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/CacheRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 993, "kind": "class", "name": "CacheRepository", "memberof": "src/repositories/CacheRepository.js", "static": true, "longname": "src/repositories/CacheRepository.js~CacheRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/CacheRepository.js", "importStyle": "CacheRepository", "description": "", "lineNumber": 7, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 994, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/CacheRepository.js~CacheRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/CacheRepository.js~CacheRepository#constructor", "access": "public", "description": "Creates an instance of BaseRepository.", "lineNumber": 15, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "endpoint", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "singleMap", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "multiMap", "description": "" } ] }, { "__docId__": 995, "kind": "member", "name": "_cache", "memberof": "src/repositories/CacheRepository.js~CacheRepository", "static": false, "longname": "src/repositories/CacheRepository.js~CacheRepository#_cache", "access": "private", "description": null, "lineNumber": 17, "undocument": true, "ignore": true, "type": { "types": [ "{}" ] } }, { "__docId__": 996, "kind": "member", "name": "params", "memberof": "src/repositories/CacheRepository.js~CacheRepository", "static": false, "longname": "src/repositories/CacheRepository.js~CacheRepository#params", "access": "public", "description": null, "lineNumber": 18, "undocument": true, "type": { "types": [ "{}" ] } }, { "__docId__": 997, "kind": "method", "name": "findById", "memberof": "src/repositories/CacheRepository.js~CacheRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/CacheRepository.js~CacheRepository#findById", "access": "public", "description": "Retrieves a single domain object by its id.", "lineNumber": 27, "params": [ { "nullable": null, "types": [ "int" ], "spread": false, "optional": false, "name": "id", "description": "The id of the entity to retrieve." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "forceReload", "description": "Flags repository to force reload skipping cached data." } ], "return": { "types": [ "*" ] } }, { "__docId__": 998, "kind": "method", "name": "get", "memberof": "src/repositories/CacheRepository.js~CacheRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/CacheRepository.js~CacheRepository#get", "access": "public", "description": "Retrieves an array of results for the endpoint", "lineNumber": 51, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "params", "description": "A set of parameters to include for the endpoint." }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "forceReload", "description": "Flags repository to force reload skipping cached data." } ], "return": { "types": [ "*" ] } }, { "__docId__": 999, "kind": "method", "name": "save", "memberof": "src/repositories/CacheRepository.js~CacheRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/CacheRepository.js~CacheRepository#save", "access": "public", "description": "Saves resource and stores response to cache by resource id.", "lineNumber": 78, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "entity", "description": "bid entity data object" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1000, "kind": "method", "name": "create", "memberof": "src/repositories/CacheRepository.js~CacheRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/CacheRepository.js~CacheRepository#create", "access": "public", "description": "Creates a single entity and invalidates the cached data", "lineNumber": 100, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "entity", "description": "bid entity data object" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1001, "kind": "method", "name": "delete", "memberof": "src/repositories/CacheRepository.js~CacheRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/CacheRepository.js~CacheRepository#delete", "access": "public", "description": "Deletes resource and removes resource from cache.", "lineNumber": 122, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "The id of the resource to delete" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Returns the response data." } }, { "__docId__": 1002, "kind": "file", "name": "src/repositories/ComponentDefRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/ComponentDefRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1003, "kind": "class", "name": "ComponentDefRepository", "memberof": "src/repositories/ComponentDefRepository.js", "static": true, "longname": "src/repositories/ComponentDefRepository.js~ComponentDefRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/ComponentDefRepository.js", "importStyle": "ComponentDefRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository" ] }, { "__docId__": 1004, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/ComponentDefRepository.js~ComponentDefRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/ComponentDefRepository.js~ComponentDefRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1005, "kind": "file", "name": "src/repositories/ComponentGroupDefRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/ComponentGroupDefRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1006, "kind": "class", "name": "ComponentGroupDefRepository", "memberof": "src/repositories/ComponentGroupDefRepository.js", "static": true, "longname": "src/repositories/ComponentGroupDefRepository.js~ComponentGroupDefRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/ComponentGroupDefRepository.js", "importStyle": "ComponentGroupDefRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository" ] }, { "__docId__": 1007, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/ComponentGroupDefRepository.js~ComponentGroupDefRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/ComponentGroupDefRepository.js~ComponentGroupDefRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1008, "kind": "file", "name": "src/repositories/DatatableDefRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/DatatableDefRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1009, "kind": "class", "name": "DatatableDefRepository", "memberof": "src/repositories/DatatableDefRepository.js", "static": true, "longname": "src/repositories/DatatableDefRepository.js~DatatableDefRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/DatatableDefRepository.js", "importStyle": "DatatableDefRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository" ] }, { "__docId__": 1010, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/DatatableDefRepository.js~DatatableDefRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/DatatableDefRepository.js~DatatableDefRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1011, "kind": "file", "name": "src/repositories/DatatableRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/DatatableRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1012, "kind": "class", "name": "DatatableRepository", "memberof": "src/repositories/DatatableRepository.js", "static": true, "longname": "src/repositories/DatatableRepository.js~DatatableRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/DatatableRepository.js", "importStyle": "DatatableRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1013, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/DatatableRepository.js~DatatableRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/DatatableRepository.js~DatatableRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1014, "kind": "method", "name": "findById", "memberof": "src/repositories/DatatableRepository.js~DatatableRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DatatableRepository.js~DatatableRepository#findById", "access": "public", "description": null, "lineNumber": 8, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "datatableId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1015, "kind": "member", "name": "endpoint", "memberof": "src/repositories/DatatableRepository.js~DatatableRepository", "static": false, "longname": "src/repositories/DatatableRepository.js~DatatableRepository#endpoint", "access": "public", "description": null, "lineNumber": 9, "undocument": true, "type": { "types": [ "string" ] } }, { "__docId__": 1016, "kind": "method", "name": "save", "memberof": "src/repositories/DatatableRepository.js~DatatableRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DatatableRepository.js~DatatableRepository#save", "access": "public", "description": null, "lineNumber": 13, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "datatable", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1018, "kind": "method", "name": "get", "memberof": "src/repositories/DatatableRepository.js~DatatableRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DatatableRepository.js~DatatableRepository#get", "access": "public", "description": null, "lineNumber": 18, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "params", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1020, "kind": "method", "name": "create", "memberof": "src/repositories/DatatableRepository.js~DatatableRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DatatableRepository.js~DatatableRepository#create", "access": "public", "description": null, "lineNumber": 23, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "datatableObject", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1022, "kind": "method", "name": "delete", "memberof": "src/repositories/DatatableRepository.js~DatatableRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DatatableRepository.js~DatatableRepository#delete", "access": "public", "description": null, "lineNumber": 28, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "datatableId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1024, "kind": "file", "name": "src/repositories/DocumentRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/DocumentRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1025, "kind": "class", "name": "DocumentRepository", "memberof": "src/repositories/DocumentRepository.js", "static": true, "longname": "src/repositories/DocumentRepository.js~DocumentRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/DocumentRepository.js", "importStyle": "DocumentRepository", "description": "", "lineNumber": 6, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1026, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/DocumentRepository.js~DocumentRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/DocumentRepository.js~DocumentRepository#constructor", "access": "public", "description": null, "lineNumber": 7, "undocument": true }, { "__docId__": 1027, "kind": "method", "name": "findById", "memberof": "src/repositories/DocumentRepository.js~DocumentRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DocumentRepository.js~DocumentRepository#findById", "access": "public", "description": null, "lineNumber": 11, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "documentId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1028, "kind": "member", "name": "endpoint", "memberof": "src/repositories/DocumentRepository.js~DocumentRepository", "static": false, "longname": "src/repositories/DocumentRepository.js~DocumentRepository#endpoint", "access": "public", "description": null, "lineNumber": 12, "undocument": true, "type": { "types": [ "string" ] } }, { "__docId__": 1029, "kind": "method", "name": "get", "memberof": "src/repositories/DocumentRepository.js~DocumentRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DocumentRepository.js~DocumentRepository#get", "access": "public", "description": null, "lineNumber": 16, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "params", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1031, "kind": "method", "name": "create", "memberof": "src/repositories/DocumentRepository.js~DocumentRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DocumentRepository.js~DocumentRepository#create", "access": "public", "description": null, "lineNumber": 21, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "documentObject", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1033, "kind": "method", "name": "delete", "memberof": "src/repositories/DocumentRepository.js~DocumentRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DocumentRepository.js~DocumentRepository#delete", "access": "public", "description": null, "lineNumber": 26, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "documentId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1035, "kind": "file", "name": "src/repositories/DynamicGroupRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/DynamicGroupRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1036, "kind": "class", "name": "DynamicGroupRepository", "memberof": "src/repositories/DynamicGroupRepository.js", "static": true, "longname": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/DynamicGroupRepository.js", "importStyle": "DynamicGroupRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1037, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1038, "kind": "method", "name": "get", "memberof": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository#get", "access": "public", "description": "Get all the Dynamic Groups for a Bid", "lineNumber": 14, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bidId", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "$dynamicGroupId", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Array of results filtered by the given params" } }, { "__docId__": 1039, "kind": "member", "name": "endpoint", "memberof": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository", "static": false, "longname": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository#endpoint", "access": "public", "description": null, "lineNumber": 15, "undocument": true, "type": { "types": [ "string" ] } }, { "__docId__": 1040, "kind": "method", "name": "findById", "memberof": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository#findById", "access": "public", "description": "Finds a Dynamic Group by it's Bid and ID", "lineNumber": 26, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bidId", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "$dynamicGroupId", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1042, "kind": "method", "name": "create", "memberof": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository#create", "access": "public", "description": "Persists a new entity", "lineNumber": 37, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise} The newly persisted entity" } ], "params": [ { "nullable": null, "types": [ "BidEntity" ], "spread": false, "optional": false, "name": "entity", "description": "An entity object to persist" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "The newly persisted entity" } }, { "__docId__": 1044, "kind": "method", "name": "delete", "memberof": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/DynamicGroupRepository.js~DynamicGroupRepository#delete", "access": "public", "description": "Persists a new entity", "lineNumber": 48, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "id", "description": "An entity object to persist" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Response status message" } }, { "__docId__": 1046, "kind": "file", "name": "src/repositories/FieldDefRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/FieldDefRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1047, "kind": "class", "name": "FieldDefRepository", "memberof": "src/repositories/FieldDefRepository.js", "static": true, "longname": "src/repositories/FieldDefRepository.js~FieldDefRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/FieldDefRepository.js", "importStyle": "FieldDefRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository" ] }, { "__docId__": 1048, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/FieldDefRepository.js~FieldDefRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/FieldDefRepository.js~FieldDefRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1049, "kind": "file", "name": "src/repositories/FieldGroupDefRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/FieldGroupDefRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1050, "kind": "class", "name": "FieldGroupDefRepository", "memberof": "src/repositories/FieldGroupDefRepository.js", "static": true, "longname": "src/repositories/FieldGroupDefRepository.js~FieldGroupDefRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/FieldGroupDefRepository.js", "importStyle": "FieldGroupDefRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository" ] }, { "__docId__": 1051, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/FieldGroupDefRepository.js~FieldGroupDefRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/FieldGroupDefRepository.js~FieldGroupDefRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1052, "kind": "file", "name": "src/repositories/FieldRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/FieldRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1053, "kind": "class", "name": "FieldRepository", "memberof": "src/repositories/FieldRepository.js", "static": true, "longname": "src/repositories/FieldRepository.js~FieldRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/FieldRepository.js", "importStyle": "FieldRepository", "description": "", "lineNumber": 6, "deprecated": "This class will be removed in version 1.1.x.", "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1054, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/FieldRepository.js~FieldRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/FieldRepository.js~FieldRepository#constructor", "access": "public", "description": null, "lineNumber": 7, "undocument": true }, { "__docId__": 1055, "kind": "method", "name": "findById", "memberof": "src/repositories/FieldRepository.js~FieldRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/FieldRepository.js~FieldRepository#findById", "access": "public", "description": null, "lineNumber": 11, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "fieldId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1056, "kind": "member", "name": "endpoint", "memberof": "src/repositories/FieldRepository.js~FieldRepository", "static": false, "longname": "src/repositories/FieldRepository.js~FieldRepository#endpoint", "access": "public", "description": null, "lineNumber": 12, "undocument": true, "type": { "types": [ "string" ] } }, { "__docId__": 1057, "kind": "method", "name": "get", "memberof": "src/repositories/FieldRepository.js~FieldRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/FieldRepository.js~FieldRepository#get", "access": "public", "description": null, "lineNumber": 16, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "params", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1059, "kind": "method", "name": "create", "memberof": "src/repositories/FieldRepository.js~FieldRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/FieldRepository.js~FieldRepository#create", "access": "public", "description": null, "lineNumber": 21, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "fieldObject", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1061, "kind": "method", "name": "delete", "memberof": "src/repositories/FieldRepository.js~FieldRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/FieldRepository.js~FieldRepository#delete", "access": "public", "description": null, "lineNumber": 26, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "fieldId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1063, "kind": "file", "name": "src/repositories/IndustryWidePredictionModelRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/IndustryWidePredictionModelRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1064, "kind": "class", "name": "IndustryWidePredictionModelRepository", "memberof": "src/repositories/IndustryWidePredictionModelRepository.js", "static": true, "longname": "src/repositories/IndustryWidePredictionModelRepository.js~IndustryWidePredictionModelRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/IndustryWidePredictionModelRepository.js", "importStyle": "IndustryWidePredictionModelRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1065, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/IndustryWidePredictionModelRepository.js~IndustryWidePredictionModelRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/IndustryWidePredictionModelRepository.js~IndustryWidePredictionModelRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1066, "kind": "method", "name": "get", "memberof": "src/repositories/IndustryWidePredictionModelRepository.js~IndustryWidePredictionModelRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/IndustryWidePredictionModelRepository.js~IndustryWidePredictionModelRepository#get", "access": "public", "description": "Retrieves a list of industry wide prediction models", "lineNumber": 15, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "params", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "params.lineItemDefId", "description": "Filters results by line item definition" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "List of predictions" } }, { "__docId__": 1067, "kind": "method", "name": "getData", "memberof": "src/repositories/IndustryWidePredictionModelRepository.js~IndustryWidePredictionModelRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/IndustryWidePredictionModelRepository.js~IndustryWidePredictionModelRepository#getData", "access": "public", "description": "Get an industry wide prediction model with associated datasets", "lineNumber": 25, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "predictionModelId", "description": "" } ], "return": { "nullable": null, "types": [ "promise" ], "spread": false, "description": "prediction model with datasets" } }, { "__docId__": 1068, "kind": "file", "name": "src/repositories/LineItemDefRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/LineItemDefRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1069, "kind": "class", "name": "LineItemDefRepository", "memberof": "src/repositories/LineItemDefRepository.js", "static": true, "longname": "src/repositories/LineItemDefRepository.js~LineItemDefRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/LineItemDefRepository.js", "importStyle": "LineItemDefRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository" ] }, { "__docId__": 1070, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/LineItemDefRepository.js~LineItemDefRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/LineItemDefRepository.js~LineItemDefRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1071, "kind": "file", "name": "src/repositories/LineItemRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/LineItemRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1072, "kind": "class", "name": "LineItemRepository", "memberof": "src/repositories/LineItemRepository.js", "static": true, "longname": "src/repositories/LineItemRepository.js~LineItemRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/LineItemRepository.js", "importStyle": "LineItemRepository", "description": "", "lineNumber": 6, "deprecated": "This class will be removed in version 1.1.x.", "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1073, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/LineItemRepository.js~LineItemRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/LineItemRepository.js~LineItemRepository#constructor", "access": "public", "description": null, "lineNumber": 7, "undocument": true }, { "__docId__": 1074, "kind": "method", "name": "findById", "memberof": "src/repositories/LineItemRepository.js~LineItemRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/LineItemRepository.js~LineItemRepository#findById", "access": "public", "description": null, "lineNumber": 11, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "lineItemId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1075, "kind": "member", "name": "endpoint", "memberof": "src/repositories/LineItemRepository.js~LineItemRepository", "static": false, "longname": "src/repositories/LineItemRepository.js~LineItemRepository#endpoint", "access": "public", "description": null, "lineNumber": 12, "undocument": true, "type": { "types": [ "string" ] } }, { "__docId__": 1076, "kind": "method", "name": "get", "memberof": "src/repositories/LineItemRepository.js~LineItemRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/LineItemRepository.js~LineItemRepository#get", "access": "public", "description": null, "lineNumber": 16, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "params", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1078, "kind": "method", "name": "create", "memberof": "src/repositories/LineItemRepository.js~LineItemRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/LineItemRepository.js~LineItemRepository#create", "access": "public", "description": null, "lineNumber": 21, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "lineItemObject", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1080, "kind": "method", "name": "delete", "memberof": "src/repositories/LineItemRepository.js~LineItemRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/LineItemRepository.js~LineItemRepository#delete", "access": "public", "description": null, "lineNumber": 26, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "lineItemId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1082, "kind": "file", "name": "src/repositories/MetricDefRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/MetricDefRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1083, "kind": "class", "name": "MetricDefRepository", "memberof": "src/repositories/MetricDefRepository.js", "static": true, "longname": "src/repositories/MetricDefRepository.js~MetricDefRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/MetricDefRepository.js", "importStyle": "MetricDefRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseDefinitionRepository.js~BaseDefinitionRepository" ] }, { "__docId__": 1084, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/MetricDefRepository.js~MetricDefRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/MetricDefRepository.js~MetricDefRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1085, "kind": "file", "name": "src/repositories/MetricRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/MetricRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1086, "kind": "class", "name": "MetricRepository", "memberof": "src/repositories/MetricRepository.js", "static": true, "longname": "src/repositories/MetricRepository.js~MetricRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/MetricRepository.js", "importStyle": "MetricRepository", "description": "", "lineNumber": 6, "deprecated": "This class will be removed in version 1.1.x.", "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1087, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/MetricRepository.js~MetricRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/MetricRepository.js~MetricRepository#constructor", "access": "public", "description": null, "lineNumber": 7, "undocument": true }, { "__docId__": 1088, "kind": "method", "name": "findById", "memberof": "src/repositories/MetricRepository.js~MetricRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/MetricRepository.js~MetricRepository#findById", "access": "public", "description": null, "lineNumber": 11, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "metricId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1089, "kind": "member", "name": "endpoint", "memberof": "src/repositories/MetricRepository.js~MetricRepository", "static": false, "longname": "src/repositories/MetricRepository.js~MetricRepository#endpoint", "access": "public", "description": null, "lineNumber": 12, "undocument": true, "type": { "types": [ "string" ] } }, { "__docId__": 1090, "kind": "method", "name": "get", "memberof": "src/repositories/MetricRepository.js~MetricRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/MetricRepository.js~MetricRepository#get", "access": "public", "description": null, "lineNumber": 16, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "params", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1092, "kind": "method", "name": "create", "memberof": "src/repositories/MetricRepository.js~MetricRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/MetricRepository.js~MetricRepository#create", "access": "public", "description": null, "lineNumber": 21, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "metricObject", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1094, "kind": "method", "name": "delete", "memberof": "src/repositories/MetricRepository.js~MetricRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/MetricRepository.js~MetricRepository#delete", "access": "public", "description": null, "lineNumber": 26, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "metricId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1096, "kind": "file", "name": "src/repositories/PredictionModelRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/PredictionModelRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1097, "kind": "class", "name": "PredictionModelRepository", "memberof": "src/repositories/PredictionModelRepository.js", "static": true, "longname": "src/repositories/PredictionModelRepository.js~PredictionModelRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/PredictionModelRepository.js", "importStyle": "PredictionModelRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1098, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/PredictionModelRepository.js~PredictionModelRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/PredictionModelRepository.js~PredictionModelRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1099, "kind": "method", "name": "get", "memberof": "src/repositories/PredictionModelRepository.js~PredictionModelRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/PredictionModelRepository.js~PredictionModelRepository#get", "access": "public", "description": "Retrieves a list of prediction models", "lineNumber": 15, "params": [ { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "params", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "params.lineItemDefId", "description": "Filters results by line item definition" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "List of predictions" } }, { "__docId__": 1100, "kind": "method", "name": "getData", "memberof": "src/repositories/PredictionModelRepository.js~PredictionModelRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/PredictionModelRepository.js~PredictionModelRepository#getData", "access": "public", "description": "Get a prediction model with associated datasets", "lineNumber": 25, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "predictionModelId", "description": "" } ], "return": { "nullable": null, "types": [ "promise" ], "spread": false, "description": "prediction model with datasets" } }, { "__docId__": 1101, "kind": "file", "name": "src/repositories/ProjectRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/ProjectRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1102, "kind": "class", "name": "ProjectRepository", "memberof": "src/repositories/ProjectRepository.js", "static": true, "longname": "src/repositories/ProjectRepository.js~ProjectRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/ProjectRepository.js", "importStyle": "ProjectRepository", "description": null, "lineNumber": 4, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1103, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/ProjectRepository.js~ProjectRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/ProjectRepository.js~ProjectRepository#constructor", "access": "public", "description": null, "lineNumber": 5, "undocument": true }, { "__docId__": 1104, "kind": "method", "name": "get", "memberof": "src/repositories/ProjectRepository.js~ProjectRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/ProjectRepository.js~ProjectRepository#get", "access": "public", "description": "Retrieves a list of projects", "lineNumber": 22, "params": [ { "nullable": null, "types": [ "Object" ], "spread": false, "optional": true, "name": "params", "description": "A set of parameters to filter the projects by." }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "params.per_page", "description": "Number of projects to to display per request (max 100)" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "params.page", "description": "Page number" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "params.search", "description": "Search term to apply to project's title" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "params.sort_order", "description": "'asc' or 'desc'" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "params.order_by", "description": "The name of the property to sort the results by" }, { "nullable": null, "types": [ "number[]" ], "spread": false, "optional": false, "name": "params.tag_ids", "description": "List of tags to filter by (excluding this will include all tags)" }, { "nullable": null, "types": [ "number[]" ], "spread": false, "optional": false, "name": "params.user_ids", "description": "List of users to filter by (excluding this will include all users)" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Filtered list of projects" } }, { "__docId__": 1105, "kind": "method", "name": "attachBid", "memberof": "src/repositories/ProjectRepository.js~ProjectRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/ProjectRepository.js~ProjectRepository#attachBid", "access": "public", "description": "Adds a bid to a project", "lineNumber": 33, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "projectId", "description": "The project's id" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bidId", "description": "The bid's id" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "API response status" } }, { "__docId__": 1106, "kind": "method", "name": "detachBid", "memberof": "src/repositories/ProjectRepository.js~ProjectRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/ProjectRepository.js~ProjectRepository#detachBid", "access": "public", "description": "Removes a bid from a project", "lineNumber": 52, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "projectId", "description": "The project's id" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "bidId", "description": "The bid's id" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "API response status" } }, { "__docId__": 1107, "kind": "method", "name": "attachUser", "memberof": "src/repositories/ProjectRepository.js~ProjectRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/ProjectRepository.js~ProjectRepository#attachUser", "access": "public", "description": "Adds a user to a project", "lineNumber": 71, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "projectId", "description": "The project's id" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "userId", "description": "The user's id" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "API response status" } }, { "__docId__": 1108, "kind": "method", "name": "detachUser", "memberof": "src/repositories/ProjectRepository.js~ProjectRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/ProjectRepository.js~ProjectRepository#detachUser", "access": "public", "description": "Removes a user from a project", "lineNumber": 90, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "projectId", "description": "The project's id" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "userId", "description": "The user's id" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "API response status" } }, { "__docId__": 1109, "kind": "method", "name": "batchUpdate", "memberof": "src/repositories/ProjectRepository.js~ProjectRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/ProjectRepository.js~ProjectRepository#batchUpdate", "access": "public", "description": "Allows persistance of underlying bid data along with project", "lineNumber": 111, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "projectId", "description": "" }, { "nullable": null, "types": [ "Object" ], "spread": false, "optional": false, "name": "data", "description": "The project data to update" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "options.isAutoSave", "description": "Indicates that this batch update is due to the auto-save. Useful for debugging." } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "The API response" } }, { "__docId__": 1110, "kind": "method", "name": "clone", "memberof": "src/repositories/ProjectRepository.js~ProjectRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/ProjectRepository.js~ProjectRepository#clone", "access": "public", "description": "Clones a project", "lineNumber": 134, "params": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "projectId", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "Project clone" } }, { "__docId__": 1111, "kind": "method", "name": "saveEntityChangeLog", "memberof": "src/repositories/ProjectRepository.js~ProjectRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/ProjectRepository.js~ProjectRepository#saveEntityChangeLog", "access": "public", "description": null, "lineNumber": 146, "undocument": true, "params": [ { "name": "projectId", "types": [ "*" ] }, { "name": "entityChangeData", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1112, "kind": "file", "name": "src/repositories/ProjectStatusRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/ProjectStatusRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1113, "kind": "class", "name": "ProjectStatusRepository", "memberof": "src/repositories/ProjectStatusRepository.js", "static": true, "longname": "src/repositories/ProjectStatusRepository.js~ProjectStatusRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/ProjectStatusRepository.js", "importStyle": "ProjectStatusRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/CacheRepository.js~CacheRepository" ] }, { "__docId__": 1114, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/ProjectStatusRepository.js~ProjectStatusRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/ProjectStatusRepository.js~ProjectStatusRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1115, "kind": "file", "name": "src/repositories/SavingsAnalysisRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/SavingsAnalysisRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1116, "kind": "file", "name": "src/repositories/SnapshotRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/SnapshotRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1117, "kind": "class", "name": "SnapshotRepository", "memberof": "src/repositories/SnapshotRepository.js", "static": true, "longname": "src/repositories/SnapshotRepository.js~SnapshotRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/SnapshotRepository.js", "importStyle": "SnapshotRepository", "description": "", "lineNumber": 6, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1118, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/SnapshotRepository.js~SnapshotRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/SnapshotRepository.js~SnapshotRepository#constructor", "access": "public", "description": null, "lineNumber": 7, "undocument": true }, { "__docId__": 1119, "kind": "method", "name": "findById", "memberof": "src/repositories/SnapshotRepository.js~SnapshotRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/SnapshotRepository.js~SnapshotRepository#findById", "access": "public", "description": null, "lineNumber": 11, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "snapshotId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1120, "kind": "member", "name": "endpoint", "memberof": "src/repositories/SnapshotRepository.js~SnapshotRepository", "static": false, "longname": "src/repositories/SnapshotRepository.js~SnapshotRepository#endpoint", "access": "public", "description": null, "lineNumber": 12, "undocument": true, "type": { "types": [ "string" ] } }, { "__docId__": 1121, "kind": "method", "name": "get", "memberof": "src/repositories/SnapshotRepository.js~SnapshotRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/SnapshotRepository.js~SnapshotRepository#get", "access": "public", "description": null, "lineNumber": 16, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "params", "types": [ "*" ] }, { "name": "forceReload", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1123, "kind": "method", "name": "create", "memberof": "src/repositories/SnapshotRepository.js~SnapshotRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/SnapshotRepository.js~SnapshotRepository#create", "access": "public", "description": null, "lineNumber": 21, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "snapshotObject", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1125, "kind": "method", "name": "save", "memberof": "src/repositories/SnapshotRepository.js~SnapshotRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/SnapshotRepository.js~SnapshotRepository#save", "access": "public", "description": null, "lineNumber": 26, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "snapshotObject", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1127, "kind": "method", "name": "delete", "memberof": "src/repositories/SnapshotRepository.js~SnapshotRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/SnapshotRepository.js~SnapshotRepository#delete", "access": "public", "description": null, "lineNumber": 31, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "snapshotId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1129, "kind": "method", "name": "recover", "memberof": "src/repositories/SnapshotRepository.js~SnapshotRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/SnapshotRepository.js~SnapshotRepository#recover", "access": "public", "description": null, "lineNumber": 36, "undocument": true, "params": [ { "name": "bidId", "types": [ "*" ] }, { "name": "snapshotId", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1131, "kind": "file", "name": "src/repositories/TagRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/TagRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1132, "kind": "class", "name": "TagRepository", "memberof": "src/repositories/TagRepository.js", "static": true, "longname": "src/repositories/TagRepository.js~TagRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/TagRepository.js", "importStyle": "TagRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/CacheRepository.js~CacheRepository" ] }, { "__docId__": 1133, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/TagRepository.js~TagRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/TagRepository.js~TagRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1134, "kind": "file", "name": "src/repositories/UserRepository.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/repositories/UserRepository.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1135, "kind": "class", "name": "UserRepository", "memberof": "src/repositories/UserRepository.js", "static": true, "longname": "src/repositories/UserRepository.js~UserRepository", "access": "public", "export": true, "importPath": "pvbid-sdk/src/repositories/UserRepository.js", "importStyle": "UserRepository", "description": null, "lineNumber": 3, "undocument": true, "interface": false, "extends": [ "src/repositories/BaseRepository.js~BaseRepository" ] }, { "__docId__": 1136, "kind": "constructor", "name": "constructor", "memberof": "src/repositories/UserRepository.js~UserRepository", "generator": false, "async": false, "static": false, "longname": "src/repositories/UserRepository.js~UserRepository#constructor", "access": "public", "description": null, "lineNumber": 4, "undocument": true }, { "__docId__": 1137, "kind": "method", "name": "getAuthToken", "memberof": "src/repositories/UserRepository.js~UserRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/UserRepository.js~UserRepository#getAuthToken", "access": "public", "description": "Obtains an access token for a user", "lineNumber": 19, "unknown": [ { "tagName": "@returns", "tagValue": "{Promise}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "username", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "password", "description": "" } ], "properties": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "token_type", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "expires_in", "description": "Unix timestamp" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "access_token", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "refresh_token", "description": "" } ], "return": { "nullable": null, "types": [ "Promise" ], "spread": false, "description": "" } }, { "__docId__": 1138, "kind": "method", "name": "me", "memberof": "src/repositories/UserRepository.js~UserRepository", "generator": false, "async": true, "static": false, "longname": "src/repositories/UserRepository.js~UserRepository#me", "access": "public", "description": "Gets the current user.", "lineNumber": 45, "unknown": [ { "tagName": "@returns", "tagValue": "{Promis}" } ], "properties": [ { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "id", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "name", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "email", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "timezone", "description": "" }, { "nullable": null, "types": [ "string[]" ], "spread": false, "optional": false, "name": "permissions", "description": "" }, { "nullable": null, "types": [ "string[]" ], "spread": false, "optional": false, "name": "roles", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "account", "description": "" } ], "return": { "nullable": null, "types": [ "Promis" ], "spread": false, "description": "" }, "params": [] }, { "__docId__": 1139, "kind": "file", "name": "src/utils/AdvanceEventEmitter.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/utils/AdvanceEventEmitter.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1140, "kind": "class", "name": "AdvanceEventEmitter", "memberof": "src/utils/AdvanceEventEmitter.js", "static": true, "longname": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter", "access": "public", "export": true, "importPath": "pvbid-sdk/src/utils/AdvanceEventEmitter.js", "importStyle": "AdvanceEventEmitter", "description": "The AdvanceEventEmitter extends event emitter 3's functionality\nto check for max executions (due to circular loops) and adds an ability to \nfire a delayed event.", "lineNumber": 8, "interface": false, "extends": [ "eventemitter3~EventEmitter" ] }, { "__docId__": 1141, "kind": "constructor", "name": "constructor", "memberof": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter", "generator": false, "async": false, "static": false, "longname": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter#constructor", "access": "public", "description": "Creates an instance of AdvanceEventEmitter.", "lineNumber": 12 }, { "__docId__": 1142, "kind": "member", "name": "_eventTree", "memberof": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter", "static": false, "longname": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter#_eventTree", "access": "private", "description": null, "lineNumber": 14, "undocument": true, "ignore": true, "type": { "types": [ "{}" ] } }, { "__docId__": 1143, "kind": "member", "name": "maxEvents", "memberof": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter", "static": false, "longname": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter#maxEvents", "access": "public", "description": "Maximum number of events fired for the requester before events stop.", "lineNumber": 20, "type": { "nullable": null, "types": [ "number" ], "spread": false, "description": null } }, { "__docId__": 1144, "kind": "member", "name": "_waitForFinalEvent", "memberof": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter", "static": false, "longname": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter#_waitForFinalEvent", "access": "private", "description": null, "lineNumber": 22, "undocument": true, "ignore": true, "type": { "types": [ "*" ] } }, { "__docId__": 1145, "kind": "method", "name": "onDelay", "memberof": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter", "generator": false, "async": false, "static": false, "longname": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter#onDelay", "access": "public", "description": "", "lineNumber": 44, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "eventName", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": false, "name": "ms", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "requesterId", "description": "" }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "callback", "description": "" } ], "return": null }, { "__docId__": 1146, "kind": "method", "name": "on", "memberof": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter", "generator": false, "async": false, "static": false, "longname": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter#on", "access": "public", "description": "", "lineNumber": 69, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "eventName", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "requesterId", "description": "" }, { "nullable": null, "types": [ "function" ], "spread": false, "optional": false, "name": "callback", "description": "" } ], "return": null }, { "__docId__": 1147, "kind": "method", "name": "removeListenerByRequester", "memberof": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter", "generator": false, "async": false, "static": false, "longname": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter#removeListenerByRequester", "access": "public", "description": "Removes event listeners by event and requesterId.", "lineNumber": 87, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "eventName", "description": "" }, { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "requesterId", "description": "" } ], "return": null }, { "__docId__": 1148, "kind": "method", "name": "_shouldTrigger", "memberof": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter", "generator": false, "async": false, "static": false, "longname": "src/utils/AdvanceEventEmitter.js~AdvanceEventEmitter#_shouldTrigger", "access": "private", "description": "", "lineNumber": 104, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "requesterId", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" }, "ignore": true }, { "__docId__": 1149, "kind": "file", "name": "src/utils/ApiQueueService.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/utils/ApiQueueService.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1150, "kind": "class", "name": "ApiQueueService", "memberof": "src/utils/ApiQueueService.js", "static": true, "longname": "src/utils/ApiQueueService.js~ApiQueueService", "access": "public", "export": true, "importPath": "pvbid-sdk/src/utils/ApiQueueService.js", "importStyle": "ApiQueueService", "description": null, "lineNumber": 1, "undocument": true, "interface": false }, { "__docId__": 1151, "kind": "member", "name": "queue", "memberof": "src/utils/ApiQueueService.js~ApiQueueService", "static": true, "longname": "src/utils/ApiQueueService.js~ApiQueueService.queue", "access": "public", "description": null, "lineNumber": 2, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 1152, "kind": "method", "name": "run", "memberof": "src/utils/ApiQueueService.js~ApiQueueService", "generator": false, "async": true, "static": true, "longname": "src/utils/ApiQueueService.js~ApiQueueService.run", "access": "public", "description": null, "lineNumber": 4, "undocument": true, "params": [], "return": null }, { "__docId__": 1153, "kind": "method", "name": "add", "memberof": "src/utils/ApiQueueService.js~ApiQueueService", "generator": false, "async": true, "static": true, "longname": "src/utils/ApiQueueService.js~ApiQueueService.add", "access": "public", "description": null, "lineNumber": 18, "undocument": true, "params": [ { "name": "request", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1154, "kind": "file", "name": "src/utils/Helpers.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/utils/Helpers.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1155, "kind": "variable", "name": "math", "memberof": "src/utils/Helpers.js", "static": true, "longname": "src/utils/Helpers.js~math", "access": "public", "export": false, "importPath": "pvbid-sdk/src/utils/Helpers.js", "importStyle": null, "description": null, "lineNumber": 3, "undocument": true, "type": { "types": [ "*" ] }, "ignore": true }, { "__docId__": 1156, "kind": "class", "name": "Helpers", "memberof": "src/utils/Helpers.js", "static": true, "longname": "src/utils/Helpers.js~Helpers", "access": "public", "export": true, "importPath": "pvbid-sdk/src/utils/Helpers.js", "importStyle": "Helpers", "description": null, "lineNumber": 15, "undocument": true, "interface": false }, { "__docId__": 1157, "kind": "constructor", "name": "constructor", "memberof": "src/utils/Helpers.js~Helpers", "generator": false, "async": false, "static": false, "longname": "src/utils/Helpers.js~Helpers#constructor", "access": "public", "description": null, "lineNumber": 16, "undocument": true }, { "__docId__": 1158, "kind": "method", "name": "confirmNumber", "memberof": "src/utils/Helpers.js~Helpers", "generator": false, "async": false, "static": true, "longname": "src/utils/Helpers.js~Helpers.confirmNumber", "access": "public", "description": "Converts any value to a finite number. If the value can not\nbe converted it will use the default value. Booleans are converted to 1 or 0.", "lineNumber": 27, "unknown": [ { "tagName": "@returns", "tagValue": "{number}" } ], "params": [ { "nullable": null, "types": [ "number", "string", "boolean" ], "spread": false, "optional": false, "name": "val", "description": "" }, { "nullable": null, "types": [ "number" ], "spread": false, "optional": true, "defaultValue": "0", "defaultRaw": 0, "name": "dflt", "description": "" } ], "return": { "nullable": null, "types": [ "number" ], "spread": false, "description": "" } }, { "__docId__": 1159, "kind": "method", "name": "isNumber", "memberof": "src/utils/Helpers.js~Helpers", "generator": false, "async": false, "static": true, "longname": "src/utils/Helpers.js~Helpers.isNumber", "access": "public", "description": "Determines if value is a finite number.", "lineNumber": 49, "unknown": [ { "tagName": "@returns", "tagValue": "{boolean}" } ], "params": [ { "nullable": null, "types": [ "string", "number" ], "spread": false, "optional": false, "name": "val", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 1160, "kind": "method", "name": "parseFormulaArguments", "memberof": "src/utils/Helpers.js~Helpers", "generator": false, "async": false, "static": true, "longname": "src/utils/Helpers.js~Helpers.parseFormulaArguments", "access": "public", "description": "Parse the variables referenced in a formula", "lineNumber": 63, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "formula", "description": "" } ], "return": { "nullable": null, "types": [ "string[]" ], "spread": false, "description": "Array of variables referenced in the formula" } }, { "__docId__": 1161, "kind": "method", "name": "calculateFormula", "memberof": "src/utils/Helpers.js~Helpers", "generator": false, "async": false, "static": true, "longname": "src/utils/Helpers.js~Helpers.calculateFormula", "access": "public", "description": "Calculate the value of the given formula", "lineNumber": 99, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "formula", "description": "formula to evaluate" }, { "nullable": null, "types": [ "Object." ], "spread": false, "optional": false, "name": "valuesMap", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "options", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": true, "defaultValue": "true", "defaultRaw": true, "name": "options.castValuesToNumbers", "description": "flag forces all non-number values to be treated as numbers" } ], "return": { "nullable": null, "types": [ "number", "boolean", "string" ], "spread": false, "description": "the calculated value of the formula" } }, { "__docId__": 1162, "kind": "method", "name": "_cleanFormula", "memberof": "src/utils/Helpers.js~Helpers", "generator": false, "async": false, "static": true, "longname": "src/utils/Helpers.js~Helpers._cleanFormula", "access": "private", "description": null, "lineNumber": 121, "undocument": true, "ignore": true, "params": [ { "name": "formula", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1163, "kind": "method", "name": "_cleanValues", "memberof": "src/utils/Helpers.js~Helpers", "generator": false, "async": false, "static": true, "longname": "src/utils/Helpers.js~Helpers._cleanValues", "access": "private", "description": "Clean values and cast when appropriate", "lineNumber": 162, "params": [ { "nullable": null, "types": [ "Object." ], "spread": false, "optional": false, "name": "valuesMap", "description": "" }, { "nullable": null, "types": [ "boolean" ], "spread": false, "optional": false, "name": "castAsNumbers", "description": "" } ], "return": { "nullable": null, "types": [ "Object" ], "spread": false, "description": "The values mapped" }, "ignore": true }, { "__docId__": 1164, "kind": "method", "name": "validateFormula", "memberof": "src/utils/Helpers.js~Helpers", "generator": false, "async": false, "static": true, "longname": "src/utils/Helpers.js~Helpers.validateFormula", "access": "public", "description": "FIXME\ndon't think there is a good way to validate without just eval'ing\nwith the variables substituted in.", "lineNumber": 191, "params": [ { "name": "formula", "types": [ "*" ] }, { "name": "valuesMap", "types": [ "*" ] } ], "return": { "types": [ "*" ] } }, { "__docId__": 1165, "kind": "method", "name": "evalExpression", "memberof": "src/utils/Helpers.js~Helpers", "generator": false, "async": false, "static": true, "longname": "src/utils/Helpers.js~Helpers.evalExpression", "access": "public", "description": "Evaluate the logical expression", "lineNumber": 208, "params": [ { "nullable": null, "types": [ "string" ], "spread": false, "optional": false, "name": "formula", "description": "" }, { "nullable": null, "types": [ "object" ], "spread": false, "optional": false, "name": "valueMap", "description": "" } ], "return": { "nullable": null, "types": [ "boolean" ], "spread": false, "description": "" } }, { "__docId__": 1166, "kind": "method", "name": "union", "memberof": "src/utils/Helpers.js~Helpers", "generator": false, "async": false, "static": true, "longname": "src/utils/Helpers.js~Helpers.union", "access": "public", "description": null, "lineNumber": 221, "undocument": true, "params": [ { "name": "iterables", "types": [ "...*" ], "spread": true } ], "return": { "types": [ "*" ] } }, { "__docId__": 1167, "kind": "member", "name": "applyCeiling", "memberof": "src/utils/Helpers.js~Helpers", "static": true, "longname": "src/utils/Helpers.js~Helpers.applyCeiling", "access": "public", "description": null, "lineNumber": 236, "undocument": true, "type": { "types": [ "*" ] } }, { "__docId__": 1168, "kind": "file", "name": "src/utils/WaitForFinalEvent.js", "content": "", "static": true, "longname": "/home/justin/Projects/sdk/src/utils/WaitForFinalEvent.js", "access": "public", "description": null, "lineNumber": 1 }, { "__docId__": 1169, "kind": "variable", "name": "waitForFinalEvent", "memberof": "src/utils/WaitForFinalEvent.js", "static": true, "longname": "src/utils/WaitForFinalEvent.js~waitForFinalEvent", "access": "public", "export": true, "importPath": "pvbid-sdk/src/utils/WaitForFinalEvent.js", "importStyle": "{waitForFinalEvent}", "description": null, "lineNumber": 1, "undocument": true, "type": { "types": [ "*" ] } }, { "kind": "index", "content": "# PVBid SDK\n\nPVBid is an estimating platform designed for the solar industry. This SDK allows for secure access to PVBid's servers, with tools to programmatically manipulate a bid.\n\n## Installation\n\nThere are 2 compiled files. `pvbid.node.js` should be used for any node.js applications. Using our npm package, `const pvbid = require(\"pvbid-sdk\");` will point to the correct file. There is also a `pvbid.min.js` file that should be for any web application.\n\n**NPM**\n\n```\nnpm i pvbid-sdk --save\n```\n\n**CDN**\n~120kB gzipped\n\nhttps://unpkg.com/pvbid-sdk@1.3.50/dist/pvbid.min.js\n\n## Documentation\n\nOur most recent docs are hosted at http://sdk.pvbid.com. Code examples are included under the [Manual](http://sdk.pvbid.com/manual) section. The docs are also included in the npm package.\n\n## Recent Changes\n\nSee our changelog [here](http://sdk.pvbid.com/manual/CHANGELOG.html).\n\n## License\n\nCopyright (C) PVBid, Inc - All Rights Reserved.\n\n[See LICENSE](http://sdk.pvbid.com/manual/LICENSE.html)\n", "longname": "/home/justin/Projects/sdk/README.md", "name": "./README.md", "static": true, "access": "public" }, { "kind": "packageJSON", "content": "{\n \"name\": \"pvbid-sdk\",\n \"version\": \"1.3.50\",\n \"description\": \"\",\n \"main\": \"dist/pvbid.node.js\",\n \"scripts\": {\n \"build\": \"npm run test && npm run docs && npm run build-node && npm run build-web\",\n \"build-node\": \"PLATFORM=node webpack --mode=production\",\n \"build-web\": \"PLATFORM=web webpack --mode=production\",\n \"watch\": \"WATCH=true webpack --mode=development\",\n \"watch-node\": \"WATCH=true PLATFORM=node webpack --mode=development\",\n \"docs\": \"./node_modules/.bin/esdoc && open docs/index.html\",\n \"publish-docs\": \"npm run test && npm run docs && PLATFORM=web DOCS=true webpack\",\n \"size\": \"size-limit\",\n \"test\": \"jest --passWithNoTests\",\n \"preversion\": \"npm run test\",\n \"version\": \"npm run build-node && npm run build-web\",\n \"postversion\": \"git push\"\n },\n \"size-limit\": [\n {\n \"path\": \"src/pvbid.js\",\n \"limit\": \"120 KB\"\n }\n ],\n \"jest\": {\n \"moduleNameMapper\": {\n \"@/(.*)$\": \"/src/$1\"\n },\n \"transform\": {\n \"^.+\\\\.tsx?$\": \"babel-jest\",\n \"^.+\\\\.jsx?$\": \"babel-jest\"\n },\n \"testRegex\": \"(/tests/.*(\\\\.|/)(test|spec))\\\\.(js|ts)?$\",\n \"verbose\": true,\n \"browser\": false,\n \"testEnvironment\": \"node\"\n },\n \"keywords\": [\n \"pvbid\",\n \"solar\",\n \"javascript\",\n \"estimating\",\n \"bidding\"\n ],\n \"author\": \"PVBid, Inc\",\n \"license\": \"LicenseRef-LICENSE\",\n \"devDependencies\": {\n \"@babel/core\": \"^7.22.10\",\n \"@babel/plugin-proposal-class-properties\": \"^7.12.1\",\n \"@babel/plugin-proposal-decorators\": \"^7.12.12\",\n \"@babel/plugin-proposal-do-expressions\": \"^7.12.1\",\n \"@babel/plugin-proposal-export-default-from\": \"^7.12.1\",\n \"@babel/plugin-proposal-export-namespace-from\": \"^7.12.1\",\n \"@babel/plugin-proposal-function-sent\": \"^7.12.1\",\n \"@babel/plugin-proposal-json-strings\": \"^7.12.1\",\n \"@babel/plugin-proposal-logical-assignment-operators\": \"^7.12.1\",\n \"@babel/plugin-proposal-nullish-coalescing-operator\": \"^7.12.1\",\n \"@babel/plugin-proposal-numeric-separator\": \"^7.12.7\",\n \"@babel/plugin-proposal-object-rest-spread\": \"^7.12.1\",\n \"@babel/plugin-proposal-optional-chaining\": \"^7.12.7\",\n \"@babel/plugin-proposal-pipeline-operator\": \"^7.12.1\",\n \"@babel/plugin-proposal-throw-expressions\": \"^7.12.1\",\n \"@babel/plugin-syntax-dynamic-import\": \"^7.8.3\",\n \"@babel/plugin-syntax-import-meta\": \"^7.10.4\",\n \"@babel/plugin-transform-regenerator\": \"^7.12.1\",\n \"@babel/plugin-transform-runtime\": \"^7.12.10\",\n \"@babel/polyfill\": \"^7.12.1\",\n \"@babel/preset-env\": \"^7.22.10\",\n \"@babel/preset-typescript\": \"^7.12.7\",\n \"@babel/runtime\": \"^7.12.5\",\n \"@babel/runtime-corejs2\": \"^7.12.5\",\n \"@types/jest\": \"^29.5.3\",\n \"@types/lodash\": \"^4.14.197\",\n \"axios-mock-adapter\": \"^1.21.5\",\n \"babel-core\": \"^6.26.3\",\n \"babel-eslint\": \"^10.1.0\",\n \"babel-jest\": \"^29.6.3\",\n \"babel-loader\": \"^9.1.3\",\n \"babel-plugin-lodash\": \"^3.3.4\",\n \"babel-plugin-syntax-async-functions\": \"^6.13.0\",\n \"dotenv\": \"^16.3.1\",\n \"esdoc\": \"^1.1.0\",\n \"esdoc-ecmascript-proposal-plugin\": \"^1.0.0\",\n \"esdoc-exclude-source-plugin\": \"^1.0.0\",\n \"esdoc-standard-plugin\": \"^1.0.0\",\n \"eslint\": \"^8.47.0\",\n \"eslint-config-airbnb-base\": \"^15.0.0\",\n \"eslint-plugin-import\": \"^2.28.1\",\n \"eslint-plugin-jest\": \"^27.2.3\",\n \"eslint-plugin-node\": \"^11.1.0\",\n \"eslint-plugin-promise\": \"^6.1.1\",\n \"jest\": \"^24.9.0\",\n \"jest-environment-node-debug\": \"^2.0.0\",\n \"jsdoc-template\": \"github:braintree/jsdoc-template\",\n \"jsonfile\": \"^6.1.0\",\n \"lodash-webpack-plugin\": \"^0.11.6\",\n \"minami\": \"^1.2.3\",\n \"path\": \"^0.12.7\",\n \"size-limit\": \"^8.2.6\",\n \"ts-jest\": \"^24.3.0\",\n \"typescript\": \"^5.1.6\",\n \"webpack\": \"^5.88.2\",\n \"webpack-cli\": \"^5.1.4\",\n \"webpack-s3-plugin\": \"^1.2.0-rc.0\"\n },\n \"dependencies\": {\n \"axios\": \"^0.21.0\",\n \"eventemitter3\": \"^5.0.1\",\n \"jstat\": \"^1.9.6\",\n \"lodash\": \"^4.17.20\",\n \"mathjs\": \"^3.20.2\",\n \"performance-now\": \"^2.1.0\"\n }\n}\n", "longname": "/home/justin/Projects/sdk/package.json", "name": "package.json", "static": true, "access": "public" }, { "kind": "manualIndex", "content": "# Getting Started\n\n### Important Notice\nIn the upcoming months, we are planning to change the IDs of, line items, metrics, fields, components, datatables, assemblies, component groups, and field groups. The IDs will switch to an alpha-numerical format. Project and Bid IDs are expected to remain as an integer and unchanged. All legacy bid data in our system will be updated. Breaking changes will be minimal, but are expected.\n\n### Concepts\nA [Project] contains multiple [Bids] and summations of the bid results. Projects also have statuses (ie. open/closed/win/loss), and can have assigned users.\n\n[Bids] are self-contained, self-assessing instances that have many types of bid entities. [Line Items], [Metrics], [Fields], [Assemblies], and [Components] are the most common. A bid sums up the line items' values.\n\nA [Line Item] is a bid entity that represents a specific cost. The line item contain basic information like cost, markup, tax, and price. Line items compute their values based on the fields, metrics, and other bid entities it depends on.\n\n[Metrics] are another type of bid entity the represent only numerical values. Metrics can be configured to depend on any other bid entity and apply a mathmatical formula.\n\n[Fields] have multiple type of inputs: number, boolean, list, and text. They are the primary way to manipulate a bid, though other bid entities can have their values overridden.\n\n[Components] help organize line items in a nested format. Components sum the nested line items' values. Changing a component value, for example `component.cost = 5000.00`, will proportionally apply the value to the nested line items.\n\nAn [Assembly] is a special type of bid entity, that represents a package of Fields, Line Items, and Metrics. Assemblies can be inserted into a bid, adding new bid entities.\n\n[Datatables] are simple object stores, typically used for pricing tables and other structured data. [Fields] can reference datatables to generate a selectable list with associated values.\n\n\n### Code Examples\nThe following demonstrates how to set up an authorized context, loading a project, making changes, and saving.\n\n**Create a context with an authorization token**\n```javascript\nconst config = { token: \"Bearer auth_token\" };\nconst pvbid = PVBid.createContext(config);\n```\n\n*Important Note: the token string passed to the `config.token` property should include `Bearer` prefix.*\n\n**Load a self assessing Project instance**\n```javascript \nlet project = await pvbid.getProject(projectId);\n```\n**Setup autosave**\n```javascript\nproject.onDelay(\"changed\", 1500, \"requesterId\", () => project.save());\n```\n\n**Create a new project (w/bid)**\n```javascript\nconst newProject = await pvbid.repositories.projects.create({ title: \"New Project\" }); // initializes the new project\nconst project = await pvbid.getProject(newProject.id); // gets the self assessing project instance\n```\n\n**Create a new bid in a project**\n```javascript\nconst newBid = await project.createBid(\"Bid Title\");\n```\n\n**Choose a bid to modify**\n\nProject instances contain a list of their child bids.\n```javascript \nlet bid = project.bids[bidId];\n```\n\n**Load bids only when you need them**\nYou can defer loading all the bids in a project. This can save load time.\n```javascript\nconst project = await pvbid.getProject(projectId, { loadBidEntities: false });\n\n// load a bid's data when you need it...\nconst bid = project.bids[bidId];\nawait bid.load();\n// self assessing bid is ready to use!\n```\n\n**Making changes to the bid's properties**\n\nMany properties will trigger the bid to self assess. For example setting the `bid.cost` property will fire its `assessing` event. `bid.title` will not assess, but will flag the bid as dirty.\n```javascript \nbid.title = \"New Title\";\nbid.cost = 155555.99;\n```\n**Find a Field by its title and modify its value**\n\nThe type of bid entities include: `line_item`, `metric`, `field`, `component`, `assembly`, `datatable`, `component_group`, and `field_group`.\n```javascript \nlet fields = bid.entities.searchByTitle(\"field\", \"Customer Name\");\nif(fields.length > 0){\n fields[0].value = \"John Doe\";\n}\n``` \n**Find a Metric by its id and modify its value**\n```javascript \nlet metric = bid.entities.metrics(metricId);\nif (metric) metric.value = 123.45;\n```\n**Get a datatable row key by a linked part**\n```javascript\nconst rowKey = datatable.findRowByExternalPartId('sundat', 75); // 'x4gw' (datatable row key)\nfield.value = rowKey; // for a list type field connected to datatable\n```\n**Manually assessing the bid**\n\nIt is a good idea to assess (calculate) the bid after making changes to Metrics, Fields and Variables.\n``` javascript\nbid.assess();\n// OR\nbid.reassessAll(true); // forces a full reassessment of ALL entities within the bid\n```\n**Manually save the bid, underlying bid entities, and parent project**\n\nSaving a project also saves the bids and underlying data. You can immediately save a project any time. However, if an underlying bid is still calculating its results, any futher changes after saving the project will not persist. When a project and bids are finished calculating, the project instance will pass an `assessed` event.\n```javascript \nproject.save();\n// OR\nproject.once(\"assessed\", () => project.save());\n```\n**Log a summary of the bid**\n\n``` javascript\nconsole.log(`\n ${bid.title}:\n + ${bid.cost} (cost)\n + ${bid.tax} (tax)\n + ${bid.markup} (markup)\n ------------------\n = ${bid.price} (price)\n`);\n```\n**Log a summary of the bid with a top-level component cost breakdown**\n\n[Components] are organized in [ComponentGroups] such as \"Cost Codes\" or \"PVBid Standard\". Looking at the top-level components in a group gives us a general overview of the cost breakdown within a bid.\n``` javascript\n// First, select a component group (ie. \"Cost Codes\" or \"PVBid Standard\")\nconst groups = bid.entities.componentGroups();\nconst group = Object.values(groups)\n .find(group => group.title === 'PVBid Standard');\n\n// Next, get the top-level (summary) components for the group\nconst allComponents = bid.entities.components();\nconst componentsInGroup = Object.values(allComponents)\n .filter(component => component.componentGroupId === group.id);\nconst topLevelComponents = componentsInGroup\n .filter(component => !component.config.is_nested);\n\n// Finally, display a cost summary\nconst componentCostSummary = topLevelComponents\n .map(c => `[$${c.cost}] ${c.title}`)\n .join('\\n');\nconsole.log(componentCostSummary);\nconsole.log(`Total: ${bid.cost}`);\n```\n\n\n[Bid]: ../class/src/domain/Bid.js~Bid.html\n[Bids]: ../class/src/domain/Bid.js~Bid.html\n[Fields]: ../class/src/domain/Field.js~Field.html\n[Components]: ../class/src/domain/Component.js~Component.html\n[ComponentGroups]: ../class/src/domain/ComponentGroup.js~ComponentGroup.html\n[Assemblies]: ../class/src/domain/Assembly.js~Assembly.html\n[Assembly]: ../class/src/domain/Assembly.js~Assembly.html\n[Metrics]: ../class/src/domain/Metric.js~Metric.html\n[Line Items]: ../class/src/domain/LineItem.js~LineItem.html\n[Line Item]: ../class/src/domain/LineItem.js~LineItem.html\n[Datatables]: ../class/src/domain/Datatable.js~Datatable.html\n[Project]: ../class/src/domain/Project.js~Project.html", "longname": "/home/justin/Projects/sdk/manual/getting_started.md", "name": "./manual/getting_started.md", "static": true, "access": "public" }, { "kind": "manualAsset", "longname": "/home/justin/Projects/sdk/manual/asset", "name": "./manual/asset", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/justin/Projects/sdk/manual/getting_started.md", "name": "./manual/getting_started.md", "content": "# Getting Started\n\n### Important Notice\nIn the upcoming months, we are planning to change the IDs of, line items, metrics, fields, components, datatables, assemblies, component groups, and field groups. The IDs will switch to an alpha-numerical format. Project and Bid IDs are expected to remain as an integer and unchanged. All legacy bid data in our system will be updated. Breaking changes will be minimal, but are expected.\n\n### Concepts\nA [Project] contains multiple [Bids] and summations of the bid results. Projects also have statuses (ie. open/closed/win/loss), and can have assigned users.\n\n[Bids] are self-contained, self-assessing instances that have many types of bid entities. [Line Items], [Metrics], [Fields], [Assemblies], and [Components] are the most common. A bid sums up the line items' values.\n\nA [Line Item] is a bid entity that represents a specific cost. The line item contain basic information like cost, markup, tax, and price. Line items compute their values based on the fields, metrics, and other bid entities it depends on.\n\n[Metrics] are another type of bid entity the represent only numerical values. Metrics can be configured to depend on any other bid entity and apply a mathmatical formula.\n\n[Fields] have multiple type of inputs: number, boolean, list, and text. They are the primary way to manipulate a bid, though other bid entities can have their values overridden.\n\n[Components] help organize line items in a nested format. Components sum the nested line items' values. Changing a component value, for example `component.cost = 5000.00`, will proportionally apply the value to the nested line items.\n\nAn [Assembly] is a special type of bid entity, that represents a package of Fields, Line Items, and Metrics. Assemblies can be inserted into a bid, adding new bid entities.\n\n[Datatables] are simple object stores, typically used for pricing tables and other structured data. [Fields] can reference datatables to generate a selectable list with associated values.\n\n\n### Code Examples\nThe following demonstrates how to set up an authorized context, loading a project, making changes, and saving.\n\n**Create a context with an authorization token**\n```javascript\nconst config = { token: \"Bearer auth_token\" };\nconst pvbid = PVBid.createContext(config);\n```\n\n*Important Note: the token string passed to the `config.token` property should include `Bearer` prefix.*\n\n**Load a self assessing Project instance**\n```javascript \nlet project = await pvbid.getProject(projectId);\n```\n**Setup autosave**\n```javascript\nproject.onDelay(\"changed\", 1500, \"requesterId\", () => project.save());\n```\n\n**Create a new project (w/bid)**\n```javascript\nconst newProject = await pvbid.repositories.projects.create({ title: \"New Project\" }); // initializes the new project\nconst project = await pvbid.getProject(newProject.id); // gets the self assessing project instance\n```\n\n**Create a new bid in a project**\n```javascript\nconst newBid = await project.createBid(\"Bid Title\");\n```\n\n**Choose a bid to modify**\n\nProject instances contain a list of their child bids.\n```javascript \nlet bid = project.bids[bidId];\n```\n\n**Load bids only when you need them**\nYou can defer loading all the bids in a project. This can save load time.\n```javascript\nconst project = await pvbid.getProject(projectId, { loadBidEntities: false });\n\n// load a bid's data when you need it...\nconst bid = project.bids[bidId];\nawait bid.load();\n// self assessing bid is ready to use!\n```\n\n**Making changes to the bid's properties**\n\nMany properties will trigger the bid to self assess. For example setting the `bid.cost` property will fire its `assessing` event. `bid.title` will not assess, but will flag the bid as dirty.\n```javascript \nbid.title = \"New Title\";\nbid.cost = 155555.99;\n```\n**Find a Field by its title and modify its value**\n\nThe type of bid entities include: `line_item`, `metric`, `field`, `component`, `assembly`, `datatable`, `component_group`, and `field_group`.\n```javascript \nlet fields = bid.entities.searchByTitle(\"field\", \"Customer Name\");\nif(fields.length > 0){\n fields[0].value = \"John Doe\";\n}\n``` \n**Find a Metric by its id and modify its value**\n```javascript \nlet metric = bid.entities.metrics(metricId);\nif (metric) metric.value = 123.45;\n```\n**Get a datatable row key by a linked part**\n```javascript\nconst rowKey = datatable.findRowByExternalPartId('sundat', 75); // 'x4gw' (datatable row key)\nfield.value = rowKey; // for a list type field connected to datatable\n```\n**Manually assessing the bid**\n\nIt is a good idea to assess (calculate) the bid after making changes to Metrics, Fields and Variables.\n``` javascript\nbid.assess();\n// OR\nbid.reassessAll(true); // forces a full reassessment of ALL entities within the bid\n```\n**Manually save the bid, underlying bid entities, and parent project**\n\nSaving a project also saves the bids and underlying data. You can immediately save a project any time. However, if an underlying bid is still calculating its results, any futher changes after saving the project will not persist. When a project and bids are finished calculating, the project instance will pass an `assessed` event.\n```javascript \nproject.save();\n// OR\nproject.once(\"assessed\", () => project.save());\n```\n**Log a summary of the bid**\n\n``` javascript\nconsole.log(`\n ${bid.title}:\n + ${bid.cost} (cost)\n + ${bid.tax} (tax)\n + ${bid.markup} (markup)\n ------------------\n = ${bid.price} (price)\n`);\n```\n**Log a summary of the bid with a top-level component cost breakdown**\n\n[Components] are organized in [ComponentGroups] such as \"Cost Codes\" or \"PVBid Standard\". Looking at the top-level components in a group gives us a general overview of the cost breakdown within a bid.\n``` javascript\n// First, select a component group (ie. \"Cost Codes\" or \"PVBid Standard\")\nconst groups = bid.entities.componentGroups();\nconst group = Object.values(groups)\n .find(group => group.title === 'PVBid Standard');\n\n// Next, get the top-level (summary) components for the group\nconst allComponents = bid.entities.components();\nconst componentsInGroup = Object.values(allComponents)\n .filter(component => component.componentGroupId === group.id);\nconst topLevelComponents = componentsInGroup\n .filter(component => !component.config.is_nested);\n\n// Finally, display a cost summary\nconst componentCostSummary = topLevelComponents\n .map(c => `[$${c.cost}] ${c.title}`)\n .join('\\n');\nconsole.log(componentCostSummary);\nconsole.log(`Total: ${bid.cost}`);\n```\n\n\n[Bid]: ../class/src/domain/Bid.js~Bid.html\n[Bids]: ../class/src/domain/Bid.js~Bid.html\n[Fields]: ../class/src/domain/Field.js~Field.html\n[Components]: ../class/src/domain/Component.js~Component.html\n[ComponentGroups]: ../class/src/domain/ComponentGroup.js~ComponentGroup.html\n[Assemblies]: ../class/src/domain/Assembly.js~Assembly.html\n[Assembly]: ../class/src/domain/Assembly.js~Assembly.html\n[Metrics]: ../class/src/domain/Metric.js~Metric.html\n[Line Items]: ../class/src/domain/LineItem.js~LineItem.html\n[Line Item]: ../class/src/domain/LineItem.js~LineItem.html\n[Datatables]: ../class/src/domain/Datatable.js~Datatable.html\n[Project]: ../class/src/domain/Project.js~Project.html", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/justin/Projects/sdk/manual/repositories.md", "name": "./manual/repositories.md", "content": "# Repositories\nIncluded in the SDK are multiple repositories to easily access data from the server. The repositories are initialized within the [PVBidContext].\n\n**Available Repositories**\n* `pvbid.repositories.bids` See [BidRepository]\n* `pvbid.repositories.projects` See [ProjectRepository]\n* `pvbid.repositories.projectStatuses` See [ProjectStatusRepository]\n* `pvbid.repositories.tags` See [TagRepository]\n* `pvbid.repositories.snapshots` See [SnapshotRepository]\n* `pvbid.repositories.assemblies` See [AssemblyRepository]\n* `pvbid.repositories.users` See [UserRepository]\n* `pvbid.repositories.predictionModels` See [PredictionModelRepository]\n* `pvbid.repositories.industryWidePredictionModels` See [IndustryWidePredictionModelRepository]\n\nThese repositories are available as read-only (they should be modified through the pvbid application):\n* `pvbid.repositories.assemblyDefs` See [AssemblyDefRepository]\n* `pvbid.repositories.lineItemDefs` See [LineItemDefRepository]\n* `pvbid.repositories.fieldDefs` See [FieldDefRepository]\n* `pvbid.repositories.fieldGroupDefs` See [FieldGroupDefRepository]\n* `pvbid.repositories.metricDefs` See [MetricDefRepository]\n* `pvbid.repositories.componentDefs` See [ComponentDefRepository]\n* `pvbid.repositories.componentGroupDefs` See [ComponentGroupDefRepository]\n\n### Code Examples\n\n**Retrieving an array of projects**\n```javascript\nlet params = {\n order_by: \"created_at\",\n sort_order: \"asc\",\n per_page: 50\n}\n\ntry {\n let projects = await pvbid.repositories.projects.get(params);\n console.log(projects) //prints an array of project data.\n} catch(error) {\n //handle error;\n}\n```\n\n**Retrieving a line item definition**\n```javascript\nconst lineItemDefId = 123;\ntry {\n const lineItemDef = await pvbid.repositories.lineItemDefs.findById(lineItemDefId);\n} catch (e) {\n // handle error\n}\n```\n\n\n[BidRepository]: ../class/src/repositories/BidRepository.js~BidRepository.html\n[ProjectRepository]: ../class/src/repositories/ProjectRepository.js~ProjectRepository.html\n[ProjectStatusRepository]: ../class/src/repositories/ProjectStatusRepository.js~ProjectStatusRepository.html\n[TagRepository]: ../class/src/repositories/TagRepository.js~TagRepository.html\n[SnapshotRepository]: ../class/src/repositories/SnapshotRepository.js~SnapshotRepository.html\n[AssemblyRepository]: ../class/src/repositories/AssemblyRepository.js~AssemblyRepository.html\n[UserRepository]: ../class/src/repositories/UserRepository.js~UserRepository.html\n[PredictionModelRepository]: ../class/src/repositories/PredictionModelRepository.js~PredictionModelRepository.html\n[IndustryWidePredictionModelRepository]: ../class/src/repositories/IndustryWidePredictionModelRepository.js~IndustryWidePredictionModelRepository.html\n[PVBidContext]: ../class/src/PVBidContext.js~PVBidContext.html\n[AssemblyDefRepository]: ../class/src/repositories/AssemblyDefRepository.js~AssemblyDefRepository.html\n[LineItemDefRepository]: ../class/src/repositories/LineItemDefRepository.js~LineItemDefRepository.html\n[FieldDefRepository]: ../class/src/repositories/FieldDefRepository.js~FieldDefRepository.html\n[FieldGroupDefRepository]: ../class/src/repositories/FieldGroupDefRepository.js~FieldGroupDefRepository.html\n[MetricDefRepository]: ../class/src/repositories/MetricDefRepository.js~MetricDefRepository.html\n[ComponentDefRepository]: ../class/src/repositories/ComponentDefRepository.js~ComponentDefRepository.html\n[ComponentGroupDefRepository]: ../class/src/repositories/ComponentGroupDefRepository.js~ComponentGroupDefRepository.html\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/justin/Projects/sdk/manual/data_models.md", "name": "./manual/data_models.md", "content": "# Data Models\n\n### Project\n\n```\n{\n \"id\": 461,\n \"account_id\": 3,\n \"title\": \"New Project\",\n \"cost\": 1200,\n \"taxable_cost\": 0,\n \"price\": 1587,\n \"tax_percent\": 0,\n \"markup_percent\": 0,\n \"margin_percent\": 13.0435,\n \"labor_cost\": 0,\n \"labor_hours\": 0,\n \"tax\": 180,\n \"markup\": 207,\n \"watts\": 1350,\n \"created_at\": \"2017-09-26T23:04:55+00:00\",\n \"updated_at\": \"2017-09-27T01:10:54+00:00\",\n \"project_status_id\": 28,\n \"closed_at\": null,\n \"reconciled_at\": null,\n \"actual_hours\": null,\n \"actual_cost\": null,\n \"project_status\": {\n \"id\": 28,\n \"account_id\": 3,\n \"title\": \"Open\",\n \"core_status\": \"open\",\n \"is_reserved\": true,\n \"is_won\": false,\n \"order_index\": 0,\n \"created_at\": \"2017-09-26T22:46:28+00:00\",\n \"updated_at\": \"2017-09-26T22:46:28+00:00\"\n },\n \"bids\": [\n {\n \"id\": 190,\n \"project_id\": 461\n }\n ]\n}\n```\n\n### Bid\n\n```\n{\n \"id\": 190,\n \"account_id\": 3,\n \"user_id\": 7,\n \"title\": \"New Bid\",\n \"cost\": 1200,\n \"taxable_cost\": 1200,\n \"price\": 1587,\n \"tax_percent\": 0,\n \"markup_percent\": 0,\n \"margin_percent\": 13.04,\n \"tax\": 180,\n \"markup\": 207,\n \"variables\": {\n \"tax\": {\n \"type\": \"number\",\n \"title\": \"Tax Percent\",\n \"value\": 15,\n \"is_reserved\": true\n },\n \"wage\": {\n \"type\": \"number\",\n \"title\": \"Wage\",\n \"value\": 35,\n \"is_reserved\": true\n },\n \"burden\": {\n \"type\": \"number\",\n \"title\": \"Burden\",\n \"value\": 5,\n \"is_reserved\": true\n },\n \"labels\": {\n \"type\": \"list\",\n \"title\": \"Labels\",\n \"value\": [\n {\n \"text\": \"Labor\"\n },\n {\n \"text\": \"Materials\"\n },\n {\n \"text\": \"Equipment\"\n }\n ],\n \"is_reserved\": true\n },\n \"markup\": {\n \"type\": \"number\",\n \"title\": \"Markup Percent\",\n \"value\": 15,\n \"is_reserved\": true\n },\n \"escalator\": {\n \"type\": \"number\",\n \"title\": \"Escalator\",\n \"value\": 1,\n \"is_reserved\": true\n },\n \"sub_margins\": {\n \"type\": \"input_list\",\n \"title\": \"Sub Margins\",\n \"value\": [],\n \"is_reserved\": true\n },\n \"markup_strategy\": {\n \"type\": \"boolean\",\n \"title\": \"Include Tax in Markup\",\n \"value\": true,\n \"is_reserved\": true\n },\n \"predictive_pricing\": {\n \"type\": \"boolean\",\n \"title\": \"Predictive Pricing Enabled\",\n \"value\": false,\n \"is_reserved\": true\n },\n \"use_computed\": {\n \"type\": \"boolean\",\n \"title\": \"Use computed values when available (Predictive Pricing)\",\n \"value\": true,\n \"is_reserved\": true\n },\n\n },\n \"system_version\": 1,\n \"definition_id\": 0,\n \"definition_version\": 1,\n \"created_at\": \"2017-09-26T23:04:55+00:00\",\n \"updated_at\": \"2017-09-27T01:10:54+00:00\",\n \"integrations\": [],\n \"config\": {\n \"predicted_values\": [],\n \"undefined_prop_flags\": [],\n },\n \"is_locked\": false,\n \"is_shell\": false,\n \"reconciled_at\": null,\n \"actual_hours\": null,\n \"actual_cost\": null,\n \"bid_status_id\": null,\n \"closed_at\": null,\n \"project_id\": 461,\n \"watts\": 1350,\n \"labor_hours\": 0,\n \"labor_cost\": 0,\n \"margin_of_error\": 0,\n \"is_active\": true,\n \"user\": {\n \"id\": 7,\n \"name\": \"Test User\",\n \"license\": \"estimator\",\n \"roles\": [\n {\n \"id\": 2,\n \"name\": \"admin\",\n \"display_name\": \"Admin\",\n \"description\": \"User is allowed to manage account wide settings, bids, and definitions.\",\n \"created_at\": \"2017-09-12 18:13:37\",\n \"updated_at\": \"2017-09-12 18:13:37\",\n \"pivot\": {\n \"user_id\": 7,\n \"role_id\": 2\n }\n },\n {\n \"id\": 4,\n \"name\": \"estimator\",\n \"display_name\": \"Estimator\",\n \"description\": \"User is allowed to create and edit bids with advance estimating tools.\",\n \"created_at\": \"2017-09-12 18:13:37\",\n \"updated_at\": \"2017-09-12 18:13:37\",\n \"pivot\": {\n \"user_id\": 7,\n \"role_id\": 4\n }\n }\n ]\n }\n}\n```\n\n### Line Item\n\n```\n{\n \"id\": 49661,\n \"bid_id\": 190,\n \"account_id\": 3,\n \"title\": \"General Line Item\",\n \"is_active\": true,\n \"is_included\": true,\n \"config\": {\n \"comments\": [],\n \"order_index\": 0,\n \"assembly_id\": null,\n \"type\": \"dollar\",\n \"quantity\": {\n \"type\": \"value\",\n \"value\": 0\n },\n \"per_quantity\": {\n \"type\": \"value\",\n \"value\": 0\n },\n \"base\": 0,\n \"formula\": \"1\",\n \"is_predicted_cost\": false,\n \"is_predicted_labor_hours\": false,\n \"dependencies\": {\n \"tax\": {\n \"type\": \"bid_variable\",\n \"field\": \"tax\",\n \"bid_entity_id\": \"bid_variable\"\n },\n \"wage\": {\n \"type\": \"bid_variable\",\n \"field\": \"wage\",\n \"bid_entity_id\": \"bid_variable\"\n },\n \"burden\": {\n \"type\": \"bid_variable\",\n \"field\": \"burden\",\n \"bid_entity_id\": \"bid_variable\"\n },\n \"markup\": {\n \"type\": \"bid_variable\",\n \"field\": \"markup\",\n \"bid_entity_id\": \"bid_variable\"\n },\n \"scalar\": [],\n \"quantity\": [],\n \"escalator\": {\n \"type\": \"bid_variable\",\n \"field\": \"escalator\",\n \"bid_entity_id\": \"bid_variable\"\n },\n \"per_quantity\": []\n },\n \"rules\": [\n {\n \"type\": \"always_include\",\n \"title\": \"Always Include\"\n }\n ],\n \"undefined_prop_flags\": [],\n \"rule_inclusion\": \"any\",\n \"overrides\": {},\n \"short_code\": \"line:general_line_item\",\n \"description\": \"\"\n },\n \"cost\": 0,\n \"taxable_cost\": 0,\n \"price\": 0,\n \"tax\": 0,\n \"tax_percent\": 15,\n \"markup\": 0,\n \"markup_percent\": 15,\n \"quantity\": 0,\n \"per_quantity\": 0,\n \"multiplier\": 1,\n \"burden\": 5,\n \"wage\": 35,\n \"base\": 0,\n \"escalator\": 1,\n \"labor_hours\": 0,\n \"actual_cost\": null,\n \"acutal_hours\": null,\n \"definition_id\": 1577,\n \"definition_version\": 2,\n \"type\": \"line_item\",\n \"created_at\": \"2017-09-26 23:04:55\",\n \"updated_at\": \"2017-09-27 01:10:55\",\n \"prediction_model\": {}\n}\n```\n\n### Field\n\n```\n{\n \"id\": 18262,\n \"account_id\": 3,\n \"bid_id\": 190,\n \"title\": \"Module Type\",\n \"value\": \"mhzk\",\n \"is_active\": true,\n \"anchor\": \"module_type\",\n \"anchor_id\": 2,\n \"config\": {\n \"type\": \"list\",\n \"constraint\": \"Whole\",\n \"short_code\": \"field:module_type\",\n \"description\": \"\",\n \"dependencies\": {\n \"auto_a\": {\n \"type\": null,\n \"field\": null\n },\n \"datatable\": {\n \"type\": \"datatable\",\n \"field\": null,\n \"bid_entity_id\": 7580\n }\n },\n \"has_null_dependency\": false,\n \"is_auto_selected\": false\n },\n \"definition_id\": 903,\n \"definition_version\": 2,\n \"created_at\": \"2017-09-26T23:04:55+00:00\",\n \"updated_at\": \"2017-09-27T01:10:55+00:00\",\n \"actual_value\": null,\n \"type\": \"field\"\n}\n```\n\n### Metric\n\n```\n{\n \"id\": 36093,\n \"account_id\": 3,\n \"bid_id\": 190,\n \"title\": \"Watts\",\n \"value\": 1350,\n \"config\": {\n \"formula\": \"a*b\",\n \"short_code\": \"metric:watts\",\n \"dependencies\": {\n \"a\": {\n \"type\": \"field\",\n \"field\": \"clpa\",\n \"bid_entity_id\": 18262\n },\n \"b\": {\n \"type\": \"field\",\n \"field\": \"value\",\n \"bid_entity_id\": 18263\n }\n }\n },\n \"definition_id\": 840,\n \"definition_version\": 9,\n \"created_at\": \"2017-09-26T23:04:55+00:00\",\n \"updated_at\": \"2017-09-27T01:10:55+00:00\",\n \"has_null_dependency\": false,\n \"actual_value\": null,\n \"is_active\": true,\n \"type\": \"metric\"\n}\n```\n\n### Datatable\n\n```\n {\n \"id\": 7580,\n \"account_id\": 3,\n \"bid_id\": 190,\n \"title\": \"Modules\",\n \"config\": {\n \"rows\": [\n {\n \"id\": \"mhzk\",\n \"values\": [\"Module 1\", \"400.00\", \"450\"],\n \"$$hashKey\": \"object:527\"\n },\n {\n \"id\": \"be6f\",\n \"values\": [\"Module 2\", \"300.00\", \"250\"],\n \"$$hashKey\": \"object:528\"\n }\n ],\n \"columns\": [\n {\n \"id\": \"at57\",\n \"type\": \"string\",\n \"title\": \"Module\",\n \"is_key\": true,\n \"$$hashKey\": \"object:521\"\n },\n {\n \"id\": \"tp7q\",\n \"type\": \"string\",\n \"title\": \"Unit Price\",\n \"is_key\": false,\n \"$$hashKey\": \"object:522\"\n },\n {\n \"id\": \"clpa\",\n \"type\": \"string\",\n \"title\": \"Watts\",\n \"is_key\": false,\n \"$$hashKey\": \"object:523\"\n }\n ]\n },\n \"definition_id\": 266,\n \"definition_version\": 3,\n \"created_at\": \"2017-09-26T23:04:55+00:00\",\n \"updated_at\": \"2017-09-27T01:10:55+00:00\",\n \"is_active\": 1,\n \"type\": \"datatable\"\n}\n```\n\n### Component\n\n```\n{\n \"id\": 62470,\n \"bid_id\": 190,\n \"account_id\": 3,\n \"title\": \"Modules\",\n \"is_active\": true,\n \"config\": {\n \"is_nested\": false,\n \"components\": [],\n \"line_items\": [49665],\n \"component_group_id\": 813,\n \"parent_component_id\": null,\n \"comments\": [],\n \"description\": null,\n \"order_index\": 0,\n \"undefined_prop_flags\": [],\n \"predicted_values\": [],\n \"short_code\": \"component:modules\"\n },\n \"properties\": {\n \"base\": {\n \"value\": 0,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"wage\": {\n \"value\": 35,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"burden\": {\n \"value\": 5,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"base_avg\": {\n \"value\": 0,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"quantity\": {\n \"value\": 3,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"wage_avg\": {\n \"value\": 0,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"burden_avg\": {\n \"value\": 0,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"per_quantity\": {\n \"value\": 400,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"quantity_avg\": {\n \"value\": 3,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"included_count\": {\n \"value\": 1,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"per_quantity_avg\": {\n \"value\": 400,\n \"config\": {\n \"data_type\": \"number\"\n }\n },\n \"included_labor_count\": {\n \"value\": 0,\n \"config\": {\n \"data_type\": \"number\"\n }\n }\n },\n \"cost\": 1200,\n \"taxable_cost\": 1200,\n \"price\": 1587,\n \"tax_percent\": 15,\n \"markup_percent\": 15,\n \"tax\": 180,\n \"markup\": 207,\n \"labor_hours\": 0,\n \"labor_cost\": 0,\n \"non_labor_cost\": 1200,\n \"actual_hours\": null,\n \"actual_cost\": null,\n \"definition_id\": 1726,\n \"definition_version\": 3,\n \"type\": \"component\",\n \"created_at\": \"2017-09-26 23:04:55\",\n \"updated_at\": \"2017-09-27 01:10:55\"\n}\n```\n\n### Component Group\n\n```\n {\n \"id\": 813,\n \"account_id\": 3,\n \"bid_id\": 190,\n \"title\": \"Cost Codes\",\n \"config\": [],\n \"definition_id\": 43,\n \"definition_version\": 2,\n \"created_at\": \"2017-09-26T23:04:55+00:00\",\n \"updated_at\": \"2017-09-26T23:04:55+00:00\",\n \"is_active\": 1,\n \"type\": \"component_group\"\n}\n```\n\n### Dynamic Group\n\n```\n{\n \"bid_id\": 556\n \"burden\": {\"value\": 8.3, \"is_overridden\": false, \"has_null_dependency\": false, \"is_predicted\": false}\n \"components\": []\n \"cost\": {\"value\": 1000, \"is_overridden\": true, \"has_null_dependency\": false, \"is_predicted\": false}\n \"created_at\": \"2019-08-27 11:06:44\"\n \"definition_id\": null\n \"dynamic_groups\": [\"5d680c53b8e45d471141d1d2\", \"5d680c50b8e45d41af5d2ef2\", \"5d680c4cb8e45d41b030d844\"]\n \"id\": \"5d650ec4b8e45d03471a7d54\"\n \"included_count\": 1\n \"is_included\": {\"value\": true, \"is_overridden\": false}\n \"is_rootable\": true\n \"line_items\": [1234, 55]\n \"markup\": {\"value\": 150, \"is_overridden\": false, \"has_null_dependency\": false, \"is_predicted\": false}\n \"markup_percent\": {\"value\": 15}\n \"non_labor_cost\": {\"value\": 1000, \"is_overridden\": true, \"has_null_dependency\": false, \"is_predicted\": false}\n \"order_index\": 0\n \"price\": {\"value\": 1210, \"is_overridden\": false, \"has_null_dependency\": false, \"is_predicted\": false}\n \"tax\": {\"value\": 60, \"is_overridden\": false, \"has_null_dependency\": false, \"is_predicted\": false}\n \"tax_percent\": {\"value\": 6}\n \"taxable_cost\": {\"value\": 1000, \"is_overridden\": true, \"has_null_dependency\": false, \"is_predicted\": false}\n \"title\": \"Racking labor DG\"\n \"type\": \"dynamic_group\"\n \"updated_at\": \"2019-08-30 20:44:19\"\n \"wage\": {\"value\": 22, \"is_overridden\": false, \"has_null_dependency\": false, \"is_predicted\": false}\n}\n```\n\n### Field Group\n\n```\n{\n \"id\": 4108,\n \"account_id\": 3,\n \"bid_id\": 190,\n \"title\": \"General\",\n \"config\": {\n \"fields\": [18262, 18263],\n \"order_index\": 0\n },\n \"definition_id\": 109,\n \"definition_version\": 4,\n \"created_at\": \"2017-09-26T23:04:55+00:00\",\n \"updated_at\": \"2017-09-26T23:04:55+00:00\",\n \"is_active\": 1,\n \"type\": \"field_group\"\n}\n```\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/justin/Projects/sdk/CHANGELOG.md", "name": "./CHANGELOG.md", "content": "# CHANGELOG\n\n### 1.3.50 (2024-06-25)\n- Industry Wide Predictions\n\n### 1.3.49 (2024-02-09)\n- Patch minor issues during Bid Creation\n\n### 1.3.48 (2024-02-08)\n- Add Industry Wide Predictions Sanity Checks\n\n### 1.3.47 (2024-02-01)\n- Add Industry Wide Prediction Basics\n\n### 1.3.46 (2024-01-29)\n- Add \"predictedType\" to cache values as either 'labor' or 'cost'\n\n### 1.3.45 (2023-06-14)\n- Skip Null Line Items in Bid Validator.\n\n### 1.3.44 (2023-06-12)\n- Skip Null Line Items in Components.\n\n### 1.3.43 (2023-05-11)\n- Fix Base Repository save that was broken by code auto-formatting.\n\n### 1.3.41 (2023-05-09)\n- Add API Queue Service and Queue the majority of Repository Endpoints to improve Concurrency.\n\n### 1.3.40 (2023-04-24)\n- Figure out why Build Number is being included in semver when releasing new versions of the SDK and update documentation.\n\n### 1.3.40 (2023-04-13)\n- Disabled console logging for most output to increase performance and resolved an issue with Calculations -vs- Predictions not being saved on a per Bid Line Item basis.\n\n### 1.3.39 (2023-04-13)\n- Implemented Z-Factors which allow the values of certain Bid Line Items to be multiplied using specific Bid Metric Formulas.\n\n### 1.3.38 (2023-02-01)\n- Improve performance by only calling math ceiling when absolutely necessary and checking for exponential in numbers.\n\n### 1.3.37 (2023-01-26)\n- Reduced the math ceiling by half due to dependent calculations hitting validation errors in the MySQL database.\n\n### 1.3.36 (2023-01-26)\n- Raise math ceiling to the maximum - 1, to the whole number, for a 17 precision decimal to be safe.\n\n### 1.3.35 (2023-01-25)\n- Added a math ceiling to deal with exponentials from Prediction Models\n\n### 1.3.34 (2022-10-19)\nImprovements\n\n**Bids, Projects, & All Bid Entities**\n\n- Updated the entity change log to be disabled or enabled via bid creation\n\n### 1.3.33 (2022-09-18)\nImprovements\n\n**Bids, Projects, & All Bid Entities**\n\n- Implemented a change log to keep a history of changes to bids, projects and bid entities\n\n### 1.3.32 (2022-08-01)\nBugFix\n\n- **Bids & Projects** - Fixes a bug where the `total kw ac (pv)` or `total kw ac` metrics predicted values were not displaying correctly. \n- **Bids & Projects** - Path 1.3.31 follow up with assembly deletion auto save and reload race conditions.\n\n### 1.3.31 (2022-07-21)\nBugFix\n\n- **Bids & Projects** - Applies changes that prevents bid validation errors during project auto saving when removing assemblies\n\n### 1.3.30 (2022-07-19)\nBugFix\n\n- **Bids** - Applied changes to enable predictions when Total Kw AC is non-zero in addition to watts. \nEssentially creating a conditional that states *If Watts or Total Kw AC is non-zero, then enable predictions*\n\n### 1.3.29 (2022-06-3)\nBugFix\n\n- **Bids** - Fixed a bug where when a bid is set to **locked** and requires a **indicative pricing** calculation,\nthe application would not render the price correctly. \n\n### 1.3.28 (2022-05-13)\nImprovements\n\nUpdated **Projects & Bids** with the ability to move bids to another project.\n\n### 1.3.27 (2021-10-09)\nImprovements\n\nFor **Metrics**, **LineItems**, and **Fields** - Previous patch changes now only apply to bids created on or after October 9th, 2021\n\n### 1.3.26 (2021-09-25)\nImprovements\n\nFor **Metrics**, **LineItems**, and **Fields** - Updated the assessment of these entities when reading from a datatable reference.\nEntities now properly determine if referencing a null or undefined entity that is a datatable where the referenced column/row value is empty or is linked to a pvbid_inventory part with an empty or undefined value.\n\n**Note** This only applies to bids created after 09/24/2021\n\n### 1.3.25 (2021-07-21) \nImprovements \n\n- **Datatables** - Added audit log information to all datatables logging the user name and datetime of their latest changes\n\n### 1.3.24 (2021-06-16) \n\nBug Fix\n\n- **Field** - Minor Tweak/Bugfix to handle reference chains for number fields referencing invalidated dependencies \n\n### 1.3.23 (2021-05-19) \n\nMinor Tweaks\n\n- **FieldAutoPopulateService** - Minor Tweak/Bugfix to handle field reference chains.\n\n### 1.3.22 (2021-05-17) \n\nClean Up \n\n- **FieldAutoPopulateService** - Small statement clean up within the autoToggleBoolean function.\n\n### 1.3.21 (2021-05-14) \n\nImprovements \n\n- **Field** - Boolean toggles and fields referencing boolean toggles now properly flag predictions on or off based on their value. \n\n### 1.3.20 (2021-05-12) \n\nBug Fixes: \n\n- **Field** - More improvements and tweaks to the new dependency referencing, auto-population and auto-toggle functionality for boolean and text fields. \n\n### 1.3.19 (2021-05-07) \n\nImprovements: \n\n- **Field** - Improve the dependency referencing, auto-population and auto-toggle functionality.\n\n### 1.3.18 (2021-04-29) \n\nBug Fixes: \n\n- **Field** - This update includes fixed to dependency referencing, auto-population and auto-toggle functionality.\n\n### 1.3.17 (2021-04-20) \n\nAdjustments: \n\n- **Field** - Added bid dependency referencing, auto-population and auto-toggle functionality to boolean and text fields.\n\n### 1.3.16 (2021-04-05) \n\nAdjustments: \n\n- **Bid** - Re-added the `errorAdjustedMarginMultipler`. This value is multiplied by the bid price when the margin of error is greater than zero.\n\n### 1.3.15 (2021-03-30) \n\nBug Fixs:\n\n- **Bid** - Updated the indicative pricing helper to properly calculate the indicative price based on the bounds (WeightedValues of a Bid.)\n\n### 1.3.14 (2021-03-25) \n\nImprovements:\n\n- **Stoplight Indicator:** - Improved the indicator's bid level calculation speed.\n- **Bid** - Updated the Indicative Pricing Helper to calculate the Indicative Price based on the calculated weighted values.\n\n### 1.3.13 (2021-03-18) \n\nImprovements:\n\n- **Stoplight Indicator:** \n - **LineItem Level** - Modified calculations to properly apply contribution weight to weighted normal values.\n - **Component Level** - Minor optimization for fast calculation times\n - **Bid Level** - Added stoplight indicator to bid summary and fields page.\n - **System** - Removed the unnecessary `Yellow !` icon and re-aligned the logic to determine the stoplight prediction.\n\n### 1.3.12 (2021-03-08) \n\nBug Fix:\n\n- **Stoplight Indicator:** - Modified line item and component level calculations to properly apply contribution weight to line item values.\n\n### 1.3.11 (2021-03-04) \n\nImprovements:\n\n- **Stoplight Indicator:** \n - Modified **Component level** stoplight indicator to properly display the correct indicator based on whether or not \n a line item is predicted, has prediction models, and is included in calculations. \n \n - Modified **Component level** `getWeightedNormalValue` & `getPredictedValue` to filter the line items by their \n `isincluded` property.\n \n - Modified **LineItem level** stoplight indicator to properly display the correct indicator based on \n whether or not a line item is predicted, has prediction models, and is included in calculations. \n \n - Minor calculation fixes to the **Component level** when calculating the `weightedLaborHourCost` for `labor` line items.\n\n### 1.3.10 (2021-03-02) \n\nImprovements:\n\n- **Stoplight Indicator:** - Component level stoplight indication now accurately calculates its prediction from the associated line items.\n\n### 1.3.9 (2021-02-26) \n\nBug Fix:\n\n- **Stoplight Indicator:** Fixed a bug where line items with a predicted value equal to zero were skewing component level calculations\n\n### 1.3.8 (2021-02-25) \n\nBug Fix:\n\n- **Stoplight Indicator:** The indicator has been updated to properly calculate the `weightedNormalValue`s for a line item.\n \n### 1.3.7 (2021-02-22) \n\nImprovements:\n\n- **Stoplight Indicator:** \n - Modified the stoplight calculations to pass up the line items calculated value to the component \n level if the line item is contributing but does not have any prediction models. \n - Modified distribution ranges to be received from bid variables instead of being hardcoded. This allows the ranges to\n be dynamically inserted by the user in Admin->BidVariables.\n\n### 1.3.6 (2021-02-12) \n\nImprovements:\n\n- **Stoplight Indicator:** The indicator now displays a `Data Not Available` for line items that are currently being predicted\n\n- **Line Item:** Modified `getWeightedNormalValues` to filter out all values less than 0\n\nBug Fixes:\n\n- **Stoplight Indicator:** Fixed a bug where the indicator was not properly calculating the converted weighted normal values for labor line items.\n \n### 1.3.5 (2021-02-11) \n\nImprovements:\n\n- **Stoplight Indicator:** \n - Added a check to determine if a line item’s predicted value exists and is not zero. \n This will prevent the indicator from showing for line items without predicted values \n - Added a check to **line items** that include or exclude the **line item** from stoplight calculations \n based on its set `isIncluded` attribute.\n \n- **Line Item:**\n - Added two new functions called `getWeightedLaborHourCost` and `calculateWeightedLaborCost` \n that converts the weighted normal values for line items typed as `labor` into weighted labor cost. \n This function is called upon at the **`component` level** to convert the labor hours for those line items into a centralized value (cost)\n\n### 1.3.4 (2021-02-09) \n\nBug Fixes:\n\n- **Line Item:** Fixed a bug where the stoplight indicator was pulling `cost` instead of `labor_hours` for line items typed as `labor_hours`\n\n### 1.3.3 (2021-02-04) \n\nImprovements:\n\n- **Line Item:** Optimized the `_getStoplightIndicator` for better performance.\n- **Component:** Added `getStoplightIndicator` to return stoplight predictions and a related indicator for **components** and **subcomponents**\n\n### 1.3.2 (2021-01-27) \n\nImprovements:\n\n- **PVBid:** Updated the SDK's dependencies \n- **Line Item:** Changed `_getStoplightPredictions` to `_getStoplightIndicator`\n- **Line Item:** Updated the stoplight indicator to show `positive` and `negative` `Out of Bounds` for a lineItem \nif its cost is too far above or too far below its predicted value.\n- **Line Item:** Added a check to prevent the stoplight indicator from showing for a specific \nlineItem if its cost or labor cost is predicted\n- **Line Item:** Removed the check preventing the stoplight indicator from showing if predictions are enabled\n- **Line Item:** Updated Line Item tests\n\n\n### 1.3.1 (2021-01-26) \n\nImprovements:\n\n- **PVBid:** Updated the SDK's dependencies \n\n### 1.3.0 (2021-01-25) \n\nImprovements:\n\n- **Line Item:** Added `_getStoplightPrediction` to return stoplight predictions and a related indicator \n\n### 1.2.20 (2020-06-20)\n\n- **Project:** Only enable the change event listener on Bids if the Project's `autoSave` flag is enabled\n\n### 1.2.19 (2020-06-19)\n\nImprovements:\n\n- **Helpers:** Removed stripping of square brackets in `_cleanFormula` and made `_cleanValues` safer with types\n\n### 1.2.18 (2020-06-11)\n\nBug Fixes:\n\n- **Component:** Updated Component `wage` and `burden` aggregation calculations. The new formulas are:\n `wage` = sum of all labor Line Items' (wage _ hours) / sum of all labor Line Items' hours\n `burden` = sum of all labor Line Items' (burden _ hours) / sum of all labor Line Items' hours\n\n### 1.2.17 (2020-04-16)\n\nBug Fixes:\n\n- **Line Item:** Ensure prediction status flags are updated to false when cost is overridden.\n\n### 1.2.16 (2020-04-09)\n\nImprovements:\n\n- **Project:** Added `batchUpdate` auto save flag (as query string parameter). Improves visibility into when auto save requests are being made.\n- **Project:** Added `disableAutoSave` setting to be used in congruence with `enableAutoSave`.\n\nBug Fixes:\n\n- **PVBid:** Include prediction models in the virtual project clone's line items.\n\n### 1.2.15 (2020-03-24)\n\nImprovements:\n\n- **Bid:** `getUncategorizedLineItems` now returns the line items keyed by their ID instead of an array\n\n### 1.2.14 (2020-03-20)\n\nImprovements:\n\n- **Bid Entities:** Added getDatatableByDefId method.\n- **Bid Entities:** Added 'component', 'datatable' & 'line_item' types to getBidEntitiesByDefId method. These will return an array with a single entity and it is still recommended to use the more specific get\\*ByDefId for datatables and components if you can.\n\n### 1.2.13 (2020-02-26)\n\nImprovements:\n\n- **Bid|Component|DynamicGroup:** Added \"Cost w/Markup\" property.\n\n### 1.2.12 (2020-02-19)\n\nImprovements:\n\n- **Bid**: Price overrides are applied as a markup adjustment.\n\nFeatures:\n\n- **Bid Variables:** - Include a variable option for applying tax after markup.\n\n### 1.2.11 (2020-01-17)\n\nImprovements:\n\n- **Line Item**: Better handling for prediction model results\n\n### 1.2.10 (2020-01-10)\n\nImprovements:\n\n- **Line Item:** Minor performance improvements when saving.\n- **Validator:** Now checks for line item duplicates within component groups.\n\nBug Fixes:\n\n- **Field Group:** Fixed the potential to return an undefined field entity if an invalid field reference exists in the group\n\n### 1.2.9 (2019-12-24)\n\nBug Fixes:\n\n- **Bid Entities:** Return null from `bid.entities.getDependency(contract)` when `contract.bid_entity_id` is not defined.\n\n### 1.2.8 (2019-12-16)\n\nBug Fixes:\n\n- **Line Item:** Empty workups were sometimes unable to be edited.\n\n### 1.2.7 (2019-12-05)\n\nFeatures:\n\n- **Bid:** `bid.costWithTax` property is now available representing the sum of the bid's cost and tax value.\n\n### 1.2.6 (2019-11-15)\n\nImprovements:\n\n- **LineItem:** Rules will no longer consider whether or not their dependencies are fully defined when predictive pricing is not being used.\n\n### 1.2.5 (2019-11-08)\n\nImprovements:\n\n- **Helpers:** `calculateFormula` method now accepts an `options` object. This may contain the options flag `[castValuesToNumbers=true]` which will force all given values and the formula result to a number. Set the flag to false if you wish to use/evaluate anything with booleans, strings, or nulls.\n\n### 1.2.4 (2019-11-05)\n\nBug Fixes:\n\n- **Component:** Added a helper method for safely accessing virtual properties such as \"included_count\". This method shouldn't be used externally and will likely be deprecated when the component structure is refactored.\n\n### 1.2.3 (2019-10-21)\n\nBug Fixes:\n\n- **Helpers:** The `evalExpression` method (used mostly in line item rules) was casting all variables to numbers. It will now maintain the provided type. Casting to number is appropriate for the formula calculator but not for evaluating logical expressions.\n- **Field:** List fields without a datatable dependency were causing new bids to fail on load. The misconfiguration will now be handled gracefully with a validation warning.\n\n### 1.2.2 (2019-10-03)\n\nImprovements:\n\n- **LineItems:** Prediction Models are now statically embedded in the Line Item so that they are more deterministic.\n- **Project:** Prediction Models are no longer loaded with the Project.\n\n### 1.2.1 (2019-09-10)\n\nBug Fixes:\n\n- **LineItem:** A bug was causing some line item rule expressions to act unexpectedly when there were unused dependencies.\n\n### 1.2.0 (2019-08-30)\n\nFeatures:\n\n- **DynamicGroup:** Introduces a new assessable bid entity type, `DynamicGroup`. Dynamic Groups provide a flexible way to organize Line Items and Components within a bid. They provide an alternative to the rigid organizational elements of components and component groups. `bid.addDynamicGroup()` creates a new dynamic group within the bid. Now just start adding components, line items, or other dynamic groups with `dynamicGroup.addChild(lineItem)`. The group will provide with a similar interface to the component. `dynamicGroup.cost` for example is the sum of its child costs. Dynamic groups are for organization only and they do not contribute to bid totals. If a dynamic group should appear in the UI alongside component groups, set `dynamicGroup.isRootable` to true.\n\nImprovements:\n\n- **Component:** `isIncluded` has been added to the component interface. A component is considered to be included if it contains any included line items.\n\n### 1.1.27 (2019-08-01)\n\nFeatures:\n\n- **LineItem:** Workups have been improved to allow per quantity values to be a reference. Use `lineItem.setWorkupField(field)` to link the workup to a field (list fields only - ie connected to a datatable). Once connected, any workup item's per quantity value can be set to the 4 character string value of the datatable column. Then call `lineItem.assessWorkup()` to recalculate the workup value using the reference. To gain access to a line item's workup instance, use `lineItem.getWorkup()`.\n\n### 1.1.26 (2019-07-11)\n\nImprovements:\n\n- **Bid:** Indicative prices for indicative bids have been \"shifted\" upwards by 25% of the margin of error.\n\n### 1.1.25 (2019-07-01)\n\nFeatures:\n\n- **LineItem:** Now has a \"workup\" value that can contribute to perQuantity through the formula as `WORKUP`. The current workup value can be accessed via `lineItem.workup`. The workup value cannot be set directly at this time and must be edited via a calculator in the PVBid UI.\n\nImprovements:\n\n- **BidEntity:** Added a `hasAssembly` property which indicates whether or not the entity is in an assembly. Line Items, Metrics, Fields, and Field Groups may be in an assembly.\n- **LineItem|Metric|Field|FieldGroup:** added several methods to make working with assemblies easier and more consistent. To get the assembly that the entity belongs to, just call `entity.getAssembly()`. Methods for adding or removing the entity from an assembly have been added as well (`setAssembly(assembly)` and `unsetAssembly()`).\n- **FieldGroup:** Add `getFields()` method that returns the `Field` entities belonging to that group keyed by their reference id.\n- **ComponentGroup:** Add `getComponents()` method that returns the components belonging to that group keyed by their reference id. Pass `componentGroup.getComponents(true)` (passing true as an arg) with return just the top-level components in the group.\n\n### 1.1.24 (2019-06-19)\n\nBug Fixes:\n\n- **Bid:** Fixed bug preventing bid's active status from persisting before bid.load is called.\n\n### 1.1.23 (2019-06-06)\n\nBug Fixes:\n\n- **Datatable:** `findRowByExternalPartId` updated due to data structure changes.\n\n### 1.1.22 (2019-06-04)\n\nFeatures:\n\n- **Repositories:** Account definition can now be accessed (read-only) through the PVBid SDK's repository. Please see the repository documentation for more information.\n\n### 1.1.21 (2019-05-27)\n\nImprovements:\n\n- **PVBid.getProject():** Now accepts options as a second parameter. The `loadBidEntities` option flag determines if the full bid instance (with all entities) should be loaded for each bid in the project. Performance can be increased by setting this flag to false when loading a project with many bids. `loadBidEntities` is set to true by default. Bids loaded without entities may still be renamed, cloned, activated/deactivated, and deleted. They CANNOT be assessed or edited.\n- **Bid:** Bids will need to be loaded before they can be edited or assessed if they are loaded without entities using the `loadBidEntities = false` flag detailed above. The asynchronous `bid.load()` method will fetch the full bid and return a promise which resolves once loading is complete.\n- **Bid:** Bids now have an `isLoaded` property to indicate whether it has been loaded yet or not.\n\n### 1.1.20 (2019-05-13)\n\nImprovements:\n\n- **LineItem:** The default value of perQuantity has been changed from 0 to 1. This is a step to encourage users to favor Scalar over perQuantity. PerQuantity will be deprecated in a future release due to its limitations compared to Scalar.\n\n### 1.1.19 (2019-04-30)\n\nFeatures:\n\n- **Repositories:** `datatables.findById` and `datatables.save` methods are now supported.\n- **Datatable:** Introducing _Inventory Links_. Datatables may now contain reference to items in a shared PVBid inventory. If a datatable is linked, the `inventoryLink` property will indicate which inventory the datatable is linked to. Linked datatables will be able to reference the _columns_ of the linked inventory and rows within the datatable that reference specific inventory items will contain all the data associated with that item. All the existing datatable methods (`getValue`, `getOptions`, `getColumnValues`) support this feature. To access the raw row or column data, the `datatable.columns` and `datatable.rows` properties must be used. Rows and columns should NOT be accessed through the `datatable.config` property.\n- **Datatable:** `datatable.reload()` is an async method that persists and reloads the datatable entity. This is useful in scenarios where an inventory link changes and fresh data is required. Modifying inventory links on a datatable instance is not recommended but it is possible with a Bulk Update in the PVBid application.\n- **Datatable:** add `datatable.findRowByExternalPartId` method to lookup a row in a datatable by its linked part's 3rd party vendor ID. This is useful for making field list selections based on information coming from an external source.\n\n### 1.1.18 (2019-04-29)\n\nImprovements:\n\n- **Bid:** Immediately trigger a save upon toggling the bid's active state.\n\n### 1.1.17 (2019-04-17)\n\nImprovements:\n\n- **Bid:** `reassessAsync` will force assess the bid and all its entities until the price has converged. It returns a promise that resolves when the reassessment is complete. It rejects if the price has not converged within a limited number of reassessments.\n\n### 1.1.16 (2019-04-04)\n\nBug Fixes:\n\n- **Bid:** Fixes bug that prevented watts from automatically recalculating after removing assemblies on some occasions.\n\n### 1.1.15 (2019-04-01)\n\nBug Fixes:\n\n- **pvbid.getAuthToken:** Skips setting the auth token for this request.\n\n### 1.1.14 (2019-03-25)\n\nBug Fixes:\n\n- **LineItem:** `isPredicted(prop)` now checks all properties prediction statuses if the prop is omitted.\n- **Bid:** `markupPercent` is calculated based on the bids line items and can be dynamically overridden.\n\nFeatures:\n\n- **PVBid:** It is now possible to generate virtual clones/copies of a project instance. These virtual clones are fully assessable but have restricted access to repository and persistence related methods. They are useful for \"what if\" scenarios. For instance, you could make a virtual clone and reset all line items and metrics to see what the bid total would be had you not made any overwrites without affecting the original bid. To generate a virtual clone from a project instance: `pvbid.getVirtualProjectClone(projectInstance)`. Optionally, you can limit the bids that will be included in the clone by passing an inclusive array of bid ids as the second parameter.\n- **Assembly:** `getFieldByAnchor(anchor)` is now available to quickly find a field belonging to an assembly by it's anchor string value.\n\nImprovements:\n\n- **Bid:** The bid data object can now be exported from a Bid instance including all its entities with `bid.exportDataWithEntities()`\n- **BidEntity:** The `exportData()` method now accepts a boolean parameter to ensure that the entity's config object is included in the export if set to true. If false, the config will only be included if a change has been detected (this helps with save performance). This parameter is false by default.\n\n### 1.1.13 (2019-03-19)\n\nBug Fixes:\n\n- **Bid:** Resolves an issue that prevented locked bids from saving their active/included status.\n\n### 1.1.12 (2019-02-27)\n\nBug Fixes:\n\n- **Project:** `createBid()` now returns the newly created Bid entity\n\n### 1.1.11 (2019-02-25)\n\nFeatures:\n\n- **Component:** Expose `actualCostConfidenceFactor` and `actualHoursConfidenceFactor` which indicate the confidence of the `actualCost` and `actualHours`. The confidence values are set automatically when the actual values are imported. A confidence of `1` means the value was manually input. Confidence values of `2+` indicate that the actual value was propagated from a related actual value. Higher numbers mean lower confidence. A confidence of `0` indicates that no actual value was given or propagated and the actual value was taken from the bids estimation.\n\n### 1.1.10 (2019-02-22)\n\nBug Fixes:\n\n- **LineItem:** `isDirty()` better indicates changes to the `config` property\n\n### 1.1.9 (2019-02-19)\n\nFeatures:\n\n- **Component:** Add an `isOverridden()` method that returns the override status of the component. A component is considered to be overridden if any of its sub-components or line items are overridden.\n\nImprovements:\n\n- **LineItem:** `isOverridden()`'s parameter is now optional. Calling `isOverridden` without a param returns the override status of the whole line item.\n\n### 1.1.8 (2019-01-30)\n\nDocumentation:\n\n- Added summary of bid and cost breakdown with code examples.\n- Improved anchors documentation\n\n### 1.1.7 (2019-01-28)\n\nImprovements:\n\n- **BidEntities:** Add flag for `exactMatch` when searching for a bid entity by title (`bid.entities.searchByTitle(type, query, exactMatch)`). The exact match flag defaults to false. Think of `exactMatch=false` as wrapping wildcard characters around the query string (`(%%)`). Note that both methods are case insensitive.\n\n### 1.1.7 (2019-01-28)\n\nImprovements:\n\n- **BidEntities:** Add flag for `exactMatch` when searching for a bid entity by title (`bid.entities.searchByTitle(type, query, exactMatch)`). The exact match flag defaults to false. Think of `exactMatch=false` as wrapping wildcard characters around the query string (`(%%)`). Note that both methods are case insensitive.\n\n### 1.1.6 (2019-01-14)\n\nFeatures:\n\n- **Bid Variable:** Add a new bid variables to a bid with `bid.addBidVariable()`.\n- **LineItem:** Labor type line items may now consider tax if the `taxable_labor` bid variable is set to true (false by default).\n\n### 1.1.5 (2019-01-11)\n\nFeatures:\n\n- **Field:** Introduced the `anchor` property. `Anchors` are a means for identifying similar entities universally across any assembly and any account\n\nImprovements:\n\n- **Bid:** `bid.addAssemblies()` now returns the newly created entities.\n- **Assembly:** Exposed `assembly.definitionId`\n\n### 1.1.4 (2018-11-02)\n\nBug Fixes:\n\n- **Formula Constant Evaluation:** Fixed problem with variables and math constants (e.g. `pi`) conflicting during evaluation\n\n### 1.1.3 (2018-10-24)\n\nFeatures:\n\n- **PredictionModels Repository:** `repositories.predictionModels.getData(id)` retrieves specific prediction model and the model data\n\n### 1.1.2 (2018-10-23)\n\nImprovements:\n\n- **Documentation:** Add additional examples to the Getting Started section of the Manual\n\nBug Fixes:\n\n- **Documentation:** Fix broken links\n\n### 1.1.1 (2018-10-18)\n\nFeatures:\n\n- **Predictive Pricing:** Introduced services to handle the evaluation of prediction models\n- **LineItem:** Line items can now determine their value by evaluating a prediction model if configured to do so. A **predicted value** will be used if the `predictive_pricing` bid variable is `true` and the line item's value cannot be computed by evaluating its dependencies. The computed value may be overridden by setting the `use_computed` bid variable to `false` or `lineItem.useComputedValueWhenAvailable` to `false`. The bid must have a non-zero value for Watts.\n- **LineItem:** `LineItem.isWeighted` determine or set a line items weighted switch. Predicted line items can optionally be weighted by their total historic inclusion count\n- **LineItem:** `LineItem.getPredicted('cost')` determines the predicted cost of the line item using its prediction models\n- **Bid|LineItem|Component:** `Bid|LineItem|Component.isPredicted(property)` determines if a property is being predicted\n- **BidEntity:** `BidEntity.hasNullDependency(property)` determines if the property depends on an undefined dependency\n\nImprovements:\n\n- **BidVariable:** Expose `isReserved` property\n- **PredictionModels Repository:** `repositories.predictionModels.get()` retrieves prediction models for account or specified lineItemDefId\n- **Project:** `predictionModels` property allows access to project's prediction models\n\nBug Fixes:\n\n- **BidVariable:** execute a full reassessment when `markup_strategy` is changed\n- **Bid:** `bid.entities.getDependencyValue` now returns `null` instead of `0` for undefined dependencies\n\n### 1.0.39 (2018-08-30)\n\nBug Fixes:\n\n- **Project:** Improve tracking of changes to the data while project is saving\n\n### 1.0.38 (2018-08-29)\n\nBug Fixes:\n\n- **Bid:** Fix bug in submargin back-calculation\n\n### 1.0.37 (2018-08-20)\n\nChanges:\n\n- **Field:** For number type fields, getters return value typed as number (instead of string)\n\n### 1.0.36 (2018-07-12)\n\nBug Fixes:\n\n- **Bid Validation** Improved formula reference validation\n\n### 1.0.35 (2018-06-21)\n\nImprovements:\n\n- **LineItem & Component** Added new editable and computable `costWatt` and `priceWatt` properties.\n- **LineItem & Component** Added new read-only `costWithTax` property.\n\n### 1.0.34 (2018-06-19)\n\nBug Fixes:\n\n- **ProjectRepository:** Project `save()` hotfix to prevent saving when a project is pristine.\n\n### 1.0.33 (2018-06-18)\n\nBug Fixes:\n\n- **ProjectRepository:** Project `save()` persists changes even if no bids were modified\n\n### 1.0.32 (2018-05-30)\n\nChanges:\n\n- **Component:** Expose the componentGroupId property\n\n### 1.0.31 (2018-05-29)\n\nBug Fixes:\n\n- **Snapshot:** Expose the save() method from the snapshot repository\n- **CacheRepository:** The cache is invalidated when the `create()` method is used\n\n### 1.0.30 (2018-05-24)\n\nBug Fixes:\n\n- **Documentation:** Link to the changelog from the docs\n\n### 1.0.29 (2018-05-24)\n\nBug Fixes:\n\n- **Bid:** Return a promise rejection from the `bid.lock()` method if the bid cannot be locked\n", "static": true, "access": "public" }, { "kind": "manual", "longname": "/home/justin/Projects/sdk/LICENSE.md", "name": "./LICENSE.md", "content": "\n\n\n# LICENSE\n\n **1. Preamble:** This Agreement, signed on Sep 16, 2017 (hereinafter: Effective Date) governs the relationship between any Entity, (hereinafter: Licensee) and PVBid, Inc, a duly registered company in whose principal place of business is Denver (hereinafter: Licensor). This Agreement sets the terms, rights, restrictions and obligations on using PVBid SDK (hereinafter: The Software) created and owned by Licensor, as detailed herein\n \n**2. License Grant:** Licensor hereby grants Licensee a Personal, Non-assignable & non-transferable, Commercial, Royalty free, Without the rights to create derivative works, Non-exclusive license, all with accordance with the terms set forth and other legal restrictions set forth in 3rd party software used while running Software. \n\n- **2.1. Limited:** Licensee may use Software for the purpose of:\n\t- 2.1.1. Running Software on Licensee’s Website[s] and Server[s];\n\t- 2.1.2. Allowing 3rd Parties to run Software on Licensee’s Website[s] and Server[s];\n\t- 2.1.3. Publishing Software’s output to Licensee and 3rd Parties;\n\t- 2.1.4. Distribute verbatim copies of Software’s output (including compiled binaries);\n\t- 2.1.5. Modify Software to suit Licensee’s needs and specifications.\n- **2.2. Binary Restricted:** Licensee may sublicense Software as a part of a larger work containing more than Software, distributed solely in Object or Binary form under a personal, non-sublicensable, limited license. Such redistribution shall be limited to unlimited codebases.\n- **2.3. Non Assignable & Non-Transferable:** Licensee may not assign or transfer his rights and duties under this license.\n- **2.4. Commercial, Royalty Free:** Licensee may use Software for any purpose, including paid-services, without any royalties\n\n**3. Term & Termination:** The Term of this license shall be until terminated. Licensor may terminate this Agreement, including Licensee’s license in the case where Licensee :\n\n- 3.1. became insolvent or otherwise entered into any liquidation process; or\n- 3.2. exported The Software to any jurisdiction where licensor may not enforce his rights under this agreements in; or\n- 3.3. Licensee was in breach of any of this license's terms and conditions and such breach was not cured, immediately upon notification; or\n- 3.4. Licensee in breach of any of the terms of clause 2 to this license; or\n- 3.5. Licensee otherwise entered into any arrangement which caused Licensor to be unable to enforce his rights under this License.\n\n**4. Payment:** In consideration of the License granted under clause 2, Licensee shall pay Licensor a fee, via Credit-Card, PayPal or any other mean which Licensor may deem adequate. Failure to perform payment shall construe as material breach of this Agreement.\n\n**5. Upgrades, Updates and Fixes:** Licensor may provide Licensee, from time to time, with Upgrades, Updates or Fixes, as detailed herein and according to his sole discretion. Licensee hereby warrants to keep The Software up-to-date and install all relevant updates and fixes, and may, at his sole discretion, purchase upgrades, according to the rates set by Licensor. Licensor shall provide any update or Fix free of charge; however, nothing in this Agreement shall require Licensor to provide Updates or Fixes.\n\n- **5.1. Upgrades:** for the purpose of this license, an Upgrade shall be a material amendment in The Software, which contains new features and or major performance improvements and shall be marked as a new version number. For example, should Licensee purchase The Software under version 1.X.X, an upgrade shall commence under number 2.0.0. \n- **5.2. Updates** for the purpose of this license, an update shall be a minor amendment in The Software, which may contain new features or minor improvements and shall be marked as a new sub-version number. For example, should Licensee purchase The Software under version 1.1.X, an upgrade shall commence under number 1.2.0.\n- **5.3. Fix:** for the purpose of this license, a fix shall be a minor amendment in The Software, intended to remove bugs or alter minor features which impair the The Software's functionality. A fix shall be marked as a new sub-sub-version number. For example, should Licensee purchase Software under version 1.1.1, an upgrade shall commence under number 1.1.2.\n\n**6. Support:** Software is provided under an AS-IS basis and without any support, updates or maintenance. Nothing in this Agreement shall require Licensor to provide Licensee with support or fixes to any bug, failure, mis-performance or other defect in The Software.\n\n- **6.1. Bug Notification:** Licensee may provide Licensor of details regarding any bug, defect or failure in The Software promptly and with no delay from such event; Licensee shall comply with Licensor's request for information regarding bugs, defects or failures and furnish him with information, screenshots and try to reproduce such bugs, defects or failures.\n- **6.2. Feature Request:** Licensee may request additional features in Software, provided, however, that (i) Licensee shall waive any claim or right in such feature should feature be developed by Licensor; (ii) Licensee shall be prohibited from developing the feature, or disclose such feature request, or feature, to any 3rd party directly competing with Licensor or any 3rd party which may be, following the development of such feature, in direct competition with Licensor; (iii) Licensee warrants that feature does not infringe any 3rd party patent, trademark, trade-secret or any other intellectual property right; and (iv) Licensee developed, envisioned or created the feature solely by himself.\n\n**7. Liability:** To the extent permitted under Law, The Software is provided under an AS-IS basis. Licensor shall never, and without any limit, be liable for any damage, cost, expense or any other payment incurred by Licensee as a result of Software’s actions, failure, bugs and/or any other interaction between The Software and Licensee’s end-equipment, computers, other software or any 3rd party, end-equipment, computer or services. Moreover, Licensor shall never be liable for any defect in source code written by Licensee when relying on The Software or using The Software’s source code.\n\n**8. Warranty:** \n\n - **8.1. Intellectual Property:** Licensor hereby warrants that The Software does not violate or infringe any 3rd party claims in regards to intellectual property, patents and/or trademarks and that to the best of its knowledge no legal action has been taken against it for any infringement or violation of any 3rd party intellectual property rights.\n - **8.2. No-Warranty:** The Software is provided without any warranty; Licensor hereby disclaims any warranty that The Software shall be error free, without defects or code which may cause damage to Licensee’s computers or to Licensee, and that Software shall be functional. Licensee shall be solely liable to any damage, defect or loss incurred as a result of operating software and undertake the risks contained in running The Software on License’s Server[s] and Website[s].\n - **8.3. Prior Inspection:** Licensee hereby states that he inspected The Software thoroughly and found it satisfactory and adequate to his needs, that it does not interfere with his regular operation and that it does meet the standards and scope of his computer systems and architecture. Licensee found that The Software interacts with his development, website and server environment and that it does not infringe any of End User License Agreement of any software Licensee may use in performing his services. Licensee hereby waives any claims regarding The Software's incompatibility, performance, results and features, and warrants that he inspected the The Software.\n\n**9. No Refunds:** Licensee warrants that he inspected The Software according to clause 7(c) and that it is adequate to his needs. Accordingly, as The Software is intangible goods, Licensee shall not be, ever, entitled to any refund, rebate, compensation or restitution for any reason whatsoever, even if The Software contains material flaws.\n\n**10. Indemnification:** Licensee hereby warrants to hold Licensor harmless and indemnify Licensor for any lawsuit brought against it in regards to Licensee’s use of The Software in means that violate, breach or otherwise circumvent this license, Licensor's intellectual property rights or Licensor's title in The Software. Licensor shall promptly notify Licensee in case of such legal action and request Licensee’s consent prior to any settlement in relation to such lawsuit or claim.\n\n**11. Governing Law, Jurisdiction:** Licensee hereby agrees not to initiate class-action lawsuits against Licensor in relation to this license and to compensate Licensor for any legal fees, cost or attorney fees should any claim brought by Licensee against Licensor be denied, in part or in full.", "static": true, "access": "public" } ]