Class Term

Hierarchy

Index

Methods

Methods

public copy(doCopyChildren: boolean): Term

Parameters

  • doCopyChildren: boolean

Returns

Term

public createLabel(labelName: string, lcid: number, isDefault: boolean): Label

Parameters

  • labelName: string
  • lcid: number
  • isDefault: boolean

Returns

Label

public createTerm(name: string, lcid: number, newTermId: Guid): Term

Parameters

  • name: string
  • lcid: number
  • newTermId: Guid

Returns

Term

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public deleteAllCustomProperties()

public deleteAllLocalCustomProperties()

public deleteCustomProperty(name: string)

Parameters

  • name: string

public deleteLocalCustomProperty(name: string)

Parameters

  • name: string

public deleteObject()

public deprecate(doDepricate: boolean)

Parameters

  • doDepricate: boolean

public fromJson(initValue: any)

Parameters

  • initValue: any

public getAllLabels(lcid: number): LabelCollection

Parameters

  • lcid: number

Returns

LabelCollection

public getDefaultLabel(lcid: number): Label

Parameters

  • lcid: number

Returns

Label

public getDescription(lcid: number): StringResult

Parameters

  • lcid: number

Returns

StringResult

public getIsDescendantOf(ancestorTerm: Term): BooleanResult

Parameters

  • ancestorTerm: Term

Returns

BooleanResult

public getPath(lcid: number): StringResult

Parameters

  • lcid: number

Returns

StringResult

public getTerms(pagingLimit: number): TermCollection

Parameters

  • pagingLimit: number

Returns

TermCollection

public getTerms(termLabel: string, lcid: number, defaultLabelOnly: boolean, stringMatchOption: StringMatchOption, resultCollectionSize: number, trimUnavailable: boolean): TermCollection

Parameters

  • termLabel: string
  • lcid: number
  • defaultLabelOnly: boolean
  • stringMatchOption: StringMatchOption
  • resultCollectionSize: number
  • trimUnavailable: boolean

Returns

TermCollection

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_createdDate(): Date

Returns

Date

public get_customProperties(): { [key: string]: string; }

Returns

{ [key: string]: string; }

public get_customSortOrder(): string

Returns

string

public get_description(): string

Returns

string

public get_id(): Guid

Returns

Guid

public get_isAvailableForTagging(): boolean

Returns

boolean

public get_isDeprecated(): boolean

Returns

boolean

public get_isKeyword(): boolean

Returns

boolean

public get_isPinned(): boolean

Returns

boolean

public get_isPinnedRoot(): boolean

Returns

boolean

public get_isReused(): boolean

Returns

boolean

public get_isRoot(): boolean

Returns

boolean

public get_isSourceTerm(): boolean

Returns

boolean

public get_labels(): LabelCollection

Returns

LabelCollection

public get_lastModifiedDate(): Date

Returns

Date

public get_localCustomProperties(): { [key: string]: string; }

Returns

{ [key: string]: string; }

public get_mergedTermIds(): Guid[]

Returns

Guid[]

public get_name(): string

Returns

string

public get_objectVersion(): string

Returns

string

public get_owner(): string

Returns

string

public get_parent(): Term

Returns

Term

public get_path(): ObjectPath

Returns

ObjectPath

public get_pathOfTerm(): string

Returns

string

public get_pinSourceTermSet(): TermSet

Returns

TermSet

public get_reusedTerms(): TermCollection

Returns

TermCollection

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_sourceTerm(): Term

Returns

Term

public get_termSet(): TermSet

Returns

TermSet

public get_termSets(): TermSetCollection

Returns

TermSetCollection

public get_termStore(): TermStore

Returns

TermStore

public get_terms(): TermCollection

Returns

TermCollection

public get_termsCount(): number

Returns

number

public get_typedObject(): ClientObject

Returns

ClientObject

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public merge(termToMerge: Term)

Parameters

public move(newParnt: TermSetItem)

Parameters

public reassignSourceTerm(reusedTerm: Term)

Parameters

public refreshLoad()

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public reuseTerm(sourceTerm: Term, reuseBranch: boolean): Term

Parameters

  • sourceTerm: Term
  • reuseBranch: boolean

Returns

Term

public reuseTermWithPinning(sourceTerm: Term): Term

Parameters

Returns

Term

public setCustomProperty(name: string, value: string)

Parameters

  • name: string
  • value: string

public setDescription(description: string, lcid: number)

Parameters

  • description: string
  • lcid: number

public setLocalCustomProperty(name: string, value: string)

Parameters

  • name: string
  • value: string

public set_customSortOrder(value: string)

Parameters

  • value: string

public set_isAvailableForTagging(value: boolean)

Parameters

  • value: boolean

public set_name(value: string)

Parameters

  • value: string

public set_objectVersion(value: string)

Parameters

  • value: string

public set_owner(value: string)

Parameters

  • value: string