@twin.org/standards-w3c-dcat
Version:
Models which define the structure of W3C DCAT Standard
275 lines (139 loc) • 5.6 kB
Markdown
# Interface: IResource
Base interface for DCAT catalogued resources.
This is the parent class of dcat:Dataset, dcat:DataService, and dcat:Catalog.
## See
https://www.w3.org/TR/vocab-dcat-3/#Class:Resource
## Extends
- `IJsonLdNodeObject`
## Extended by
- [`IDataService`](IDataService.md)
- [`IDataset`](IDataset.md)
## Indexable
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
## Properties
### @context?
> `optional` **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
The JSON-LD context for the resource.
#### Overrides
`IJsonLdNodeObject.@context`
***
### @type
> **@type**: `"Catalog"` \| `"Resource"` \| `"Dataset"` \| `"DataService"` \| `"DatasetSeries"`
The type of the resource.
Typically "Catalog", "Dataset", "DataService", "DatasetSeries", or the base "Resource".
#### Overrides
`IJsonLdNodeObject.@type`
***
### dcterms:title?
> `optional` **dcterms:title**: [`LiteralType`](../type-aliases/LiteralType.md)
A name given to the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_title
***
### dcterms:description?
> `optional` **dcterms:description**: [`LiteralType`](../type-aliases/LiteralType.md)
A free-text account of the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_description
***
### dcterms:identifier?
> `optional` **dcterms:identifier**: [`LiteralType`](../type-aliases/LiteralType.md)
A unique identifier of the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_identifier
***
### dcterms:issued?
> `optional` **dcterms:issued**: `string`
Date of formal issuance (publication) of the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_release_date
***
### dcterms:modified?
> `optional` **dcterms:modified**: `string`
Most recent date on which the resource was changed, updated or modified.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_update_date
***
### dcterms:language?
> `optional` **dcterms:language**: `ObjectOrArray`\<`string`\>
A language of the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_language
***
### dcterms:publisher?
> `optional` **dcterms:publisher**: `string` \| `IAgent`
An entity responsible for making the resource available.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_publisher
***
### dcterms:creator?
> `optional` **dcterms:creator**: `IAgent`
An entity responsible for producing the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_creator
***
### dcterms:accessRights?
> `optional` **dcterms:accessRights**: `string` \| `IJsonLdNodeObject`
Information about who can access the resource or an indication of its security status.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_access_rights
***
### dcterms:license?
> `optional` **dcterms:license**: `string` \| `IJsonLdNodeObject`
A legal document under which the resource is made available.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_license
***
### dcterms:rights?
> `optional` **dcterms:rights**: `string` \| `IJsonLdNodeObject`
Information about rights held in and over the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_rights
***
### dcterms:conformsTo?
> `optional` **dcterms:conformsTo**: `ObjectOrArray`\<`string`\>
An established standard to which the resource conforms.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_conforms_to
***
### dcterms:type?
> `optional` **dcterms:type**: `string`
The nature or genre of the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_type
***
### dcat:contactPoint?
> `optional` **dcat:contactPoint**: `string` \| `IJsonLdNodeObject`
Relevant contact information for the catalogued resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_contact_point
***
### dcat:keyword?
> `optional` **dcat:keyword**: [`LiteralType`](../type-aliases/LiteralType.md)
A keyword or tag describing the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_keyword
***
### dcat:theme?
> `optional` **dcat:theme**: `ObjectOrArray`\<`string`\>
A main category of the resource. A resource can have multiple themes.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_theme
***
### dcat:landingPage?
> `optional` **dcat:landingPage**: `ObjectOrArray`\<`string`\>
A Web page that can be navigated to gain access to the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_landing_page
***
### dcat:qualifiedRelation?
> `optional` **dcat:qualifiedRelation**: `string` \| [`IRelationship`](IRelationship.md)
Link to a description of a relationship with another resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_qualified_relation
***
### odrl:hasPolicy?
> `optional` **odrl:hasPolicy**: `IOdrlPolicy`
An ODRL conformant policy expressing the rights associated with the resource.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_has_policy