Interface AuxiliaryIdentifierStrategy

A strategy for handling auxiliary related ResourceIdentifiers.

Hierarchy

Implemented by

Properties

getAuxiliaryIdentifier: ((identifier: ResourceIdentifier) => ResourceIdentifier)

Type declaration

    • (identifier: ResourceIdentifier): ResourceIdentifier
    • Returns the identifier of the auxiliary resource corresponding to the given resource. This does not guarantee that this auxiliary resource exists.

      Should error if there are multiple results: see getAuxiliaryIdentifiers.

      Returns

      The ResourceIdentifier of the corresponding auxiliary resource.

      Parameters

      • identifier: ResourceIdentifier

        The ResourceIdentifier of which we need the corresponding auxiliary resource.

      Returns ResourceIdentifier

getAuxiliaryIdentifiers: ((identifier: ResourceIdentifier) => ResourceIdentifier[])

Type declaration

    • (identifier: ResourceIdentifier): ResourceIdentifier[]
    • Returns all the identifiers of corresponding auxiliary resources. This can be used when there are potentially multiple results. In the case of a single result this should be an array containing the result of getAuxiliaryIdentifier.

      Returns

      The ResourceIdentifiers of the corresponding auxiliary resources.

      Parameters

      • identifier: ResourceIdentifier

        The ResourceIdentifier of which we need the corresponding auxiliary resources.

      Returns ResourceIdentifier[]

getSubjectIdentifier: ((identifier: ResourceIdentifier) => ResourceIdentifier)

Type declaration

isAuxiliaryIdentifier: ((identifier: ResourceIdentifier) => boolean)

Type declaration

    • (identifier: ResourceIdentifier): boolean
    • Checks if the input identifier corresponds to an auxiliary resource. This does not check if that auxiliary resource exists, only if the identifier indicates that there could be an auxiliary resource there.

      Returns

      true if the input identifier points to an auxiliary resource.

      Parameters

      Returns boolean