SmeeView.Aspects.Organization (SmeeView v0.1.0) View Source

Represents and processes <Organization> elements in entity metadata as Aspect structs.

The functions in this module are intended to be applied to individual Aspect structs - for extracting and processing collections of these records please use the matching View module.

Link to this section Summary

Functions

Lists all displaynames for this organization (one for each language)

Is this aspect relevant to the IdP role?

Lists all names for this organization (one for each language)

Returns the associated role for this aspect: :sp, :idp or :all

Is this aspect relevant to the SP role?

Lists all URLs for this organization (one for each language)

Link to this section Types

Specs

t() :: %SmeeView.Aspects.Organization{
  displaynames: list(),
  names: list(),
  urls: list()
}

Link to this section Functions

Specs

displaynames(aspect :: t()) :: list()

Lists all displaynames for this organization (one for each language)

Organization.displaynames(aspect)
# => [OrganizationDisplayname{}, OrganizationDisplayname{}, OrganizationDisplayname{}]

Specs

idp?(aspect :: t()) :: boolean()

Is this aspect relevant to the IdP role?

Will return true if the aspect has been derived from an IdP role, or is applicable to all roles.

Organization.idp?(aspect)
# => true

Specs

names(aspect :: t()) :: list()

Lists all names for this organization (one for each language)

Organization.names(aspect)
# => [OrganizationName{}, OrganizationName{}, OrganizationName{}]

Specs

role(aspect :: t()) :: atom()

Returns the associated role for this aspect: :sp, :idp or :all

The role type is useful when handling a mixed list of aspects that may be specific to certain roles of an entity.

Organization.role(aspect)
# => :idp

Specs

sp?(aspect :: t()) :: boolean()

Is this aspect relevant to the SP role?

Will return true if the aspect has been derived from an SP role, or is applicable to all roles.

Organization.sp?(aspect)
# => false

Specs

urls(aspect :: t()) :: list()

Lists all URLs for this organization (one for each language)

Organization.urls(aspect)
# => [OrganizationURL{}, OrganizationURL{}, OrganizationURL{}]