Diffo.Provider.Extension.Info (Diffo v0.4.1)

Copy Markdown View Source

Summary

Functions

characteristic?(module)

Returns true if the module is a BaseCharacteristic-derived resource (or Characteristic itself)

instance?(module)

Returns true if the module is a BaseInstance-derived resource

party?(module)

Returns true if the module is a BaseParty-derived resource

place?(module)

Returns true if the module is a BasePlace-derived resource

provider_behaviour_actions(dsl_or_extended)

provider.behaviour.actions DSL entities

provider_characteristics(dsl_or_extended)

provider.characteristics DSL entities

provider_features(dsl_or_extended)

provider.features DSL entities

provider_instances(dsl_or_extended)

provider.instances DSL entities

provider_parties(dsl_or_extended)

provider.parties DSL entities

provider_places(dsl_or_extended)

provider.places DSL entities

provider_pools(dsl_or_extended)

provider.pools DSL entities

provider_relationships(dsl_or_extended)

provider.relationships DSL entities

provider_specification_category(dsl_or_extended)

The category the specified service or resource belongs to.

provider_specification_category!(dsl_or_extended)

The category the specified service or resource belongs to.

provider_specification_description(dsl_or_extended)

A generic description of the specified service or resource.

provider_specification_description!(dsl_or_extended)

A generic description of the specified service or resource.

provider_specification_id(dsl_or_extended)

The id of the specification, a uuid4 the same in all environments, unique for name and major_version.

provider_specification_id!(dsl_or_extended)

The id of the specification, a uuid4 the same in all environments, unique for name and major_version.

provider_specification_major_version(dsl_or_extended)

The major version of the specification.

provider_specification_major_version!(dsl_or_extended)

The major version of the specification.

provider_specification_minor_version(dsl_or_extended)

The minor version of the specification.

provider_specification_minor_version!(dsl_or_extended)

The minor version of the specification.

provider_specification_name(dsl_or_extended)

The name of the specification.

provider_specification_name!(dsl_or_extended)

The name of the specification.

provider_specification_options(dsl_or_extended)

provider.specification DSL options

provider_specification_patch_version(dsl_or_extended)

The patch version of the specification.

provider_specification_patch_version!(dsl_or_extended)

The patch version of the specification.

provider_specification_tmf_version(dsl_or_extended)

The TMF API version of the specification, e.g. 4.

provider_specification_tmf_version!(dsl_or_extended)

The TMF API version of the specification, e.g. 4.

provider_specification_type(dsl_or_extended)

The type of the specification.

provider_specification_type!(dsl_or_extended)

The type of the specification.

Functions

characteristic?(module)

@spec characteristic?(module()) :: boolean()

Returns true if the module is a BaseCharacteristic-derived resource (or Characteristic itself)

instance?(module)

@spec instance?(module()) :: boolean()

Returns true if the module is a BaseInstance-derived resource

party?(module)

@spec party?(module()) :: boolean()

Returns true if the module is a BaseParty-derived resource

place?(module)

@spec place?(module()) :: boolean()

Returns true if the module is a BasePlace-derived resource

provider_behaviour_actions(dsl_or_extended)

@spec provider_behaviour_actions(dsl_or_extended :: module() | map()) :: [struct()]

provider.behaviour.actions DSL entities

provider_characteristics(dsl_or_extended)

@spec provider_characteristics(dsl_or_extended :: module() | map()) :: [struct()]

provider.characteristics DSL entities

provider_features(dsl_or_extended)

@spec provider_features(dsl_or_extended :: module() | map()) :: [struct()]

provider.features DSL entities

provider_instances(dsl_or_extended)

@spec provider_instances(dsl_or_extended :: module() | map()) :: [struct()]

provider.instances DSL entities

provider_parties(dsl_or_extended)

@spec provider_parties(dsl_or_extended :: module() | map()) :: [struct()]

provider.parties DSL entities

provider_places(dsl_or_extended)

@spec provider_places(dsl_or_extended :: module() | map()) :: [struct()]

provider.places DSL entities

provider_pools(dsl_or_extended)

@spec provider_pools(dsl_or_extended :: module() | map()) :: [struct()]

provider.pools DSL entities

provider_relationships(dsl_or_extended)

@spec provider_relationships(dsl_or_extended :: module() | map()) :: [struct()]

provider.relationships DSL entities

provider_specification_category(dsl_or_extended)

@spec provider_specification_category(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

The category the specified service or resource belongs to.

provider_specification_category!(dsl_or_extended)

@spec provider_specification_category!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

The category the specified service or resource belongs to.

provider_specification_description(dsl_or_extended)

@spec provider_specification_description(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

A generic description of the specified service or resource.

provider_specification_description!(dsl_or_extended)

@spec provider_specification_description!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

A generic description of the specified service or resource.

provider_specification_id(dsl_or_extended)

@spec provider_specification_id(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

The id of the specification, a uuid4 the same in all environments, unique for name and major_version.

provider_specification_id!(dsl_or_extended)

@spec provider_specification_id!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

The id of the specification, a uuid4 the same in all environments, unique for name and major_version.

provider_specification_major_version(dsl_or_extended)

@spec provider_specification_major_version(dsl_or_extended :: module() | map()) ::
  {:ok, integer()} | :error

The major version of the specification.

provider_specification_major_version!(dsl_or_extended)

@spec provider_specification_major_version!(dsl_or_extended :: module() | map()) ::
  integer() | no_return()

The major version of the specification.

provider_specification_minor_version(dsl_or_extended)

@spec provider_specification_minor_version(dsl_or_extended :: module() | map()) ::
  {:ok, integer()} | :error

The minor version of the specification.

provider_specification_minor_version!(dsl_or_extended)

@spec provider_specification_minor_version!(dsl_or_extended :: module() | map()) ::
  integer() | no_return()

The minor version of the specification.

provider_specification_name(dsl_or_extended)

@spec provider_specification_name(dsl_or_extended :: module() | map()) ::
  {:ok, String.t()} | :error

The name of the specification.

provider_specification_name!(dsl_or_extended)

@spec provider_specification_name!(dsl_or_extended :: module() | map()) ::
  String.t() | no_return()

The name of the specification.

provider_specification_options(dsl_or_extended)

@spec provider_specification_options(dsl_or_extended :: module() | map()) :: %{
  required(atom()) => any()
}

provider.specification DSL options

Returns a map containing the and any configured or default values.

provider_specification_patch_version(dsl_or_extended)

@spec provider_specification_patch_version(dsl_or_extended :: module() | map()) ::
  {:ok, integer()} | :error

The patch version of the specification.

provider_specification_patch_version!(dsl_or_extended)

@spec provider_specification_patch_version!(dsl_or_extended :: module() | map()) ::
  integer() | no_return()

The patch version of the specification.

provider_specification_tmf_version(dsl_or_extended)

@spec provider_specification_tmf_version(dsl_or_extended :: module() | map()) ::
  {:ok, integer()} | :error

The TMF API version of the specification, e.g. 4.

provider_specification_tmf_version!(dsl_or_extended)

@spec provider_specification_tmf_version!(dsl_or_extended :: module() | map()) ::
  integer() | no_return()

The TMF API version of the specification, e.g. 4.

provider_specification_type(dsl_or_extended)

@spec provider_specification_type(dsl_or_extended :: module() | map()) ::
  {:ok, atom()} | :error

The type of the specification.

provider_specification_type!(dsl_or_extended)

@spec provider_specification_type!(dsl_or_extended :: module() | map()) ::
  atom() | no_return()

The type of the specification.