Class ReadResource

Hierarchy

ReadWriteResource
- ReadResource

Properties

arkUrl

arkUrl: string = ""

attachedToProject

attachedToProject: string = ""

attachedToUser

attachedToUser: string = ""

creationDate

creationDate: string = ""

entityInfo

entityInfo: ResourceClassAndPropertyDefinitions

hasPermissions

hasPermissions: string = ""

id

id: string = ""

incomingReferences

incomingReferences: ReadResource[] = []

label

label: string = ""

Optional lastModificationDate

lastModificationDate: undefined | string = undefined

outgoingReferences

outgoingReferences: ReadResource[] = []

properties

properties: object

Type declaration

[index: string]: ReadValue[]

Optional resourceClassComment

resourceClassComment: undefined | string

Optional resourceClassLabel

resourceClassLabel: undefined | string

type

type: string = ""

userHasPermission

userHasPermission: string = ""

versionArkUrl

versionArkUrl: string = ""

Methods

getLinkPropertyIriFromLinkValuePropertyIri

getLinkPropertyIriFromLinkValuePropertyIri(linkValueProperty: string): string

- Defined in src/models/v2/resources/read/read-resource.ts:99
Given the IRI of a property pointing to a link value, returns the corresponding link property IRI.

Parameters
- linkValueProperty: string
  
  IRI of the link value property.
Returns string

getNumberOfProperties

getNumberOfProperties(): number

- Defined in src/models/v2/resources/read/read-resource.ts:62
Gets number of resource properties for this resource. Each resource property is counted once, regardless of how many values it has (if number of values > 1).

Returns number

getNumberOfValues

getNumberOfValues(property: string): number

- Defined in src/models/v2/resources/read/read-resource.ts:71
Gets the number of values for a given resource property.

Parameters
- property: string
  
  the IRI of the property.
Returns number

getValueType

getValueType(property: string): string | false

- Defined in src/models/v2/resources/read/read-resource.ts:85
Gets the value type of a given resource property, or false if cannot be determined.

Parameters
- property: string
  
  the IRI of the property.
Returns string | false

getValues

getValues(property: string): ReadValue[]

- Defined in src/models/v2/resources/read/read-resource.ts:124
Gets all the values for a given resource property.

Parameters
- property: string
  
  the IRI of the property.
Returns ReadValue[]

getValuesAs

getValuesAs<T>(property: string, valueType: Constructor<T>): T[]

- Defined in src/models/v2/resources/read/read-resource.ts:152
Gets all the values for a given resource property as instances of the requested type. If the value cannot be casted to the requested type, an error is thrown.

Type parameters
- T: ReadValue
Parameters
- property: string
  
  the IRI of the property.
- valueType: Constructor<T>
  
  the requested type of the value.
Returns T[]

getValuesAsStringArray

getValuesAsStringArray(property: string, defaultStr?: string): string[]

- Defined in src/models/v2/resources/read/read-resource.ts:138
Gets an array of string values representing the values of a property.

Parameters
- property: string
  
  the IRI of the property.
- Default value defaultStr: string = "?"
  
  placeholder if there is no string representation of a value.
Returns string[]

Generated using TypeDoc