core/gropius.model.architecture/InterfaceSpecification

InterfaceSpecification

@DomainNode(searchQueryName = "searchInterfaceSpecifications")

@Authorization(name = "READ", allowFromRelated = ["component", "versions"])

@Authorization(name = "ADMIN", allowFromRelated = ["component"])

@Authorization(name = "AFFECT_ENTITIES_WITH_ISSUES", allowFromRelated = ["component"])

@Authorization(name = "RELATED_ISSUE_AFFECTED_ENTITY", allowFromRelated = ["versions", "component"])

class InterfaceSpecification(name: String, description: String, val templatedFields: MutableMap<String, String>) : NamedAffectedByIssue, MutableTemplatedNode

Specification of an Interface. Defined on a Component, but can be visible and invisible on different ComponentVersions. Can be affected by Issues, and be used as start / end of ServiceEffectSpecifications. Defines InterfaceParts, but active parts depend on the InterfaceSpecificationVersion. READ is granted if READ is granted on `component`, or any InterfaceSpecificationVersion in `versions`.

Constructors

InterfaceSpecification

constructor(name: String, description: String, templatedFields: MutableMap<String, String>)

Types

Companion

object Companion

Properties

affectingIssues

@NodeRelationship(type = "AFFECTS", direction = Direction.INCOMING)

@FilterProperty

val affectingIssues: LazyLoadingDelegate<Issue, NodeSetPropertyDelegate.NodeSetProperty>

The issues which affect this entity

component

@NodeRelationship(type = "COMPONENT", direction = Direction.OUTGOING)

@FilterProperty

val component: LazyLoadingDelegate<Component, NodePropertyDelegate.NodeProperty>

The Component this InterfaceSpecification is part of.

description

@FilterProperty

@SearchProperty

open override var description: String

The description of this entity.

fieldCache

internal var fieldCache: MutableMap<String, Any?>

graphQLId

val graphQLId: ID

The unique id of this node

@Id

@GeneratedValue(generatorRef = "nodeIdGenerator")

internal var id: String?

isPersisted

val isPersisted: Boolean

isSaved

internal var isSaved: Boolean

lazyLoadingContext

@ConvertWith(converter = LazyLoadingContextConverter::class)

internal var lazyLoadingContext: LazyLoadingContext?

name

@FilterProperty

@OrderProperty

@SearchProperty

open override var name: String

The name of this entity.

nodeVersion

@Version

private var nodeVersion: Long

Version used for optimistic locking

orderFields

internal var orderFields: MutableMap<String, Any?>?

propertyLookup

internal val propertyLookup: MutableMap<String, PropertyDelegate<*>>

rawId

val rawId: String?

template

@NodeRelationship(type = "USED_IN", direction = Direction.INCOMING)

@FilterProperty

@OrderProperty

open override val template: LazyLoadingDelegate<InterfaceSpecificationTemplate, NodePropertyDelegate.NodeProperty>

Template associated with the TemplatedNode

templatedFields

open override val templatedFields: MutableMap<String, String>

The values for all templated fields. The schema is defined by the Template of this node

versions

@NodeRelationship(type = "VERSION", direction = Direction.OUTGOING)

@FilterProperty

val versions: LazyLoadingDelegate<InterfaceSpecificationVersion, NodeSetPropertyDelegate.NodeSetProperty>

Versions of this InterfaceSpecification.

Functions

equals

operator override fun equals(other: Any?): Boolean

getFromGraphQL

internal suspend fun getFromGraphQL(@Autowired nodeQueryParser: NodeQueryParser, dataFetchingEnvironment: DataFetchingEnvironment): Any?

getProperty

internal fun <T : PropertyDelegate<*>> getProperty(property: KProperty1<*, *>): T

graphQLKotlinDummyFunction

private fun graphQLKotlinDummyFunction()

Dummy function to avoid GraphQL kotlin optimization weirdness

hashCode

override fun hashCode(): Int

loadNodesOfRelationship

internal suspend fun <T : Node?> loadNodesOfRelationship(property: KProperty1<*, *>, loader: LazyLoadingSubqueryGenerator<T>.() -> Unit?)

NodeProperty

protected fun <T : Node?> NodeProperty(): PropertyDelegateProvider<Node, NodePropertyDelegate<T>>

NodeSetProperty

protected fun <T : Node> NodeSetProperty(): PropertyDelegateProvider<Node, NodeSetPropertyDelegate<T>>

registerQueryResult

internal fun registerQueryResult(entry: NodeQueryEntry<*>, queryResult: Any?)

templatedField

open fun templatedField(name: String, @Autowired objectMapper: ObjectMapper): JsonNode?

Value of a field defined by the template. Error if such a field is not defined.

templatedFields

open fun templatedFields(names: List<String>?, prefixMatching: Boolean?, @Autowired objectMapper: ObjectMapper): List<JSONField>

All templatedFields If `names` is provided, only those matching the name. If `prefixMatching` is true, matching is done by prefix, otherwise by full name.

toString

open override fun toString(): String

InterfaceSpecification ​

Constructors

Types

Properties

Functions

InterfaceSpecification