Defense Ontology

Unit Hierarchy Group

Palantir Defense Ontology

[Palantir Defense Ontology] A group of hierarchies that are closely related by some common factor. For example, the hierarchy group could be composed of three unit hierarchies that represent different ways to organize the same task force.

Properties

Unit Hierarchy Group Id

string

[Palantir Defense Ontology] Uniquely identifies a related group of unit hierarchies.

Unit Hierarchy Group Name

string

[Palantir Defense Ontology] Captures the name of a related group of unit hierarchies.

Unit Hierarchy Group Description

string

[Palantir Defense Ontology] Captures additional information for a unit hierarchy group.

Link constraints

One To Many

optional

[Palantir Defense Ontology] A Unit Hierarchy Group links to many related Unit Hierarchies.

Code snippets

TypeScript

Load ordered Unit Hierarchy Group

Copied!

import { com.palantir.defense.ontology.UnitHierarchyGroup } from "@osdk/defense-ontology";
// Edit this import if your client location differs
import { client } from "./client";
import { isOk, type Osdk, type PageResult, type Result } from "@osdk/client";

const page: Result<PageResult<Osdk<com.palantir.defense.ontology.UnitHierarchyGroup>>> = await client(com.palantir.defense.ontology.UnitHierarchyGroup)
    .fetchPageWithErrors({
        $orderBy: {"someProperty": "asc"},
        $pageSize: 30
    });

if (isOk(page)) {
    const interfaces = page.value.data;
    const interface1 = interfaces[0];
}

Filtering

Copied!

import { com.palantir.defense.ontology.UnitHierarchyGroup } from "@osdk/defense-ontology";
// Edit this import if your client location differs
import { client } from "./client";
import { isOk, type Osdk, type PageResult, type Result } from "@osdk/client";

const page: Result<PageResult<Osdk<com.palantir.defense.ontology.UnitHierarchyGroup>>> = await client(com.palantir.defense.ontology.UnitHierarchyGroup)
    .where({
        $and:[
            { $not: { someProperty: { $isNull: true }}},
            { someProperty: { $eq: "foo" }}
        ]
    })
    .fetchPageWithErrors({
        $pageSize: 30
    });

if (isOk(page)) {
    const interfaces = page.value.data;
    const interface1 = interfaces[0];
}

Load Unit Hierarchy Group metadata

Copied!

import { com.palantir.defense.ontology.UnitHierarchyGroup } from "@osdk/defense-ontology";
// Edit this import if your client location differs
import { client } from "./client";

const interfaceTypeMetadata = await client.fetchMetadata(com.palantir.defense.ontology.UnitHierarchyGroup);

const implementingObjectTypes = interfaceTypeMetadata.implementedBy;
const interfaceRid = interfaceTypeMetadata.rid;

Subscribe to object sets

Copied!

import { com.palantir.defense.ontology.UnitHierarchyGroup } from "@osdk/defense-ontology";
// Edit this import if your client location differs
import { client } from "./client";

// A map of primary keys to objects loaded through the SDK
const objects: { [key: string]: com.palantir.defense.ontology.UnitHierarchyGroup.OsdkInstance } = ...

const subscription = client(com.palantir.defense.ontology.UnitHierarchyGroup).subscribe(         {
            onChange(update) {
                if (update.state === "ADDED_OR_UPDATED") {
                    // An object has received an update or an object was added to the object set
                    const currentObject = objects[update.object.$primaryKey];
                    if (currentObject !== undefined) {
                        currentObject["<propertyName>"] = update.object["<propertyName>"] ?? currentObject["<propertyName>"];
                    }
                }
                else if (update.state === "REMOVED") {
                    // The object was removed from the object set, which could mean it was deleted or no longer meets the filter criteria
                    delete objects[update.object.$primaryKey];
                }
            },
            onSuccessfulSubscription() {
                // The subscription was successful and you can expect to receive updates
            },
            onError(err) {
                // There was an error with the subscription and you will not receive any more updates
                console.error(err);
            },
            onOutOfDate() {
                // We could not keep track of all changes. Please reload the objects in your set.
            },
        },
        { properties: [ "com.palantir.defense.ontology.unitHierarchyGroupId", "com.palantir.defense.ontology.unitHierarchyGroupName", "com.palantir.defense.ontology.unitHierarchyGroupDescription", ]}
    );

subscription.unsubscribe();

Load all Unit Hierarchy Group

Copied!

import { com.palantir.defense.ontology.UnitHierarchyGroup } from "@osdk/defense-ontology";
// Edit this import if your client location differs
import { client } from "./client";
import type { Osdk } from "@osdk/client";

const interfaces: Osdk<com.palantir.defense.ontology.UnitHierarchyGroup>[] = [];

for await(const int of client(com.palantir.defense.ontology.UnitHierarchyGroup).asyncIter()) {
    interfaces.push(int);
}
const interface1 = interfaces[0];

Load pages of Unit Hierarchy Group

Copied!

import { com.palantir.defense.ontology.UnitHierarchyGroup } from "@osdk/defense-ontology";
// Edit this import if your client location differs
import { client } from "./client";
import { type Osdk, type PageResult, type Result } from "@osdk/client";

const response:  Result<PageResult<Osdk<com.palantir.defense.ontology.UnitHierarchyGroup>>>
    = await client(com.palantir.defense.ontology.UnitHierarchyGroup).fetchPageWithErrors({ $pageSize: 30 });

// To fetch a page without a result wrapper, use fetchPage instead
const responseNoErrorWrapper: PageResult<Osdk<com.palantir.defense.ontology.UnitHierarchyGroup>>
    = await client(com.palantir.defense.ontology.UnitHierarchyGroup).fetchPage({ $pageSize: 30 });