Class Usecase

Describes how and optionally where a data asset may be used.

Hierarchy

Usecase

Index

Constructors

Properties

Methods

common custom from

Constructors

`Private` constructor

new Usecase(usecase): Usecase
Private
Constructs a new Usecase with the provided value. This constructor is private. To create a Usecase instance, use the static factory methods.
Parameters
- usecase: string
  
  The use case value.
Returns Usecase
- Defined in usecase.ts:24

Properties

`Readonly` value

value: string

The raw value of the use case.

Methods

`Static` common

common(usecase): Usecase
Creates a Usecase from one of the CommonUsecases
Parameters
- usecase: CommonUsecases
  
  The common use case to use.
Returns Usecase
A Usecase instance.

Static
- Defined in usecase.ts:59

`Static` custom

custom(usecase): Usecase
Creates a custom Usecase with the provided use case value.
Parameters
- usecase: string
  
  The custom use case value.
Returns Usecase
A Usecase instance.

Static
- Defined in usecase.ts:50

`Static` from

from(usecase): Usecase
Creates a Usecase from a provided use case value. If the use case value matches a common use case, a pre-defined Usecase is returned. Otherwise, a custom Usecase is created.
Parameters
- usecase: string
  
  The use case value.
Returns Usecase
A Usecase instance.

Static
- Defined in usecase.ts:37

Generated using TypeDoc