core/gropius.model.architecture/Interface

Interface

@DomainNode

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

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

@Authorization(name = "RELATE_FROM_COMPONENT", allowFromRelated = ["interfaceDefinition"])

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

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

@Authorization(name = "PART_OF_PROJECT", allowFromRelated = ["interfaceDefinition"])

class Interface : RelationPartner

An interface which is part of a specific ComponentVersion. Its semantics depend on the InterfaceSpecification it is specified by, e.g. an Interface can represent a REST API. Can be used in Relations and affected by Issues. READ is granted if READ is granted on `interfaceDefinition`.

Constructors

constructor()

Types

object Companion

Properties

affectingIssues

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

@FilterProperty

val affectingIssues: LazyLoadingDelegate<Issue, NodeSetPropertyDelegate.NodeSetProperty>

The issues which affect this entity

aggregatedIssues

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

@FilterProperty

val aggregatedIssues: LazyLoadingDelegate<AggregatedIssue, NodeSetPropertyDelegate.NodeSetProperty>

AggregatedIssues on this RelationPartner.

internal var fieldCache: MutableMap<String, Any?>

val graphQLId: ID

The unique id of this node

@Id

@GeneratedValue(generatorRef = "nodeIdGenerator")

internal var id: String?

incomingRelations

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

@FilterProperty

val incomingRelations: LazyLoadingDelegate<Relation, NodeSetPropertyDelegate.NodeSetProperty>

Relations which use this as the end of the Relation.

interfaceDefinition

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

@FilterProperty

val interfaceDefinition: LazyLoadingDelegate<InterfaceDefinition, NodePropertyDelegate.NodeProperty>

The definition of this interface.

intraComponentDependencyParticipants

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

@FilterProperty

val intraComponentDependencyParticipants: LazyLoadingDelegate<IntraComponentDependencyParticipant, NodeSetPropertyDelegate.NodeSetProperty>

Participants of IntraComponentDependencySpecifications where this is used.

val isPersisted: Boolean

internal var isSaved: Boolean

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

val layouts: LazyLoadingDelegate<RelationPartnerLayout, NodeSetPropertyDelegate.NodeSetProperty>

lazyLoadingContext

@ConvertWith(converter = LazyLoadingContextConverter::class)

internal var lazyLoadingContext: LazyLoadingContext?

@Version

private var nodeVersion: Long

Version used for optimistic locking

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

outgoingRelations

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

@FilterProperty

val outgoingRelations: LazyLoadingDelegate<Relation, NodeSetPropertyDelegate.NodeSetProperty>

Relations which use this as the start of the Relation.

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

val rawId: String?

Functions

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

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

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

override fun hashCode(): Int

loadNodesOfRelationship

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

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?)

relationPartnerTemplate

open suspend override fun relationPartnerTemplate(cache: NodeCache? = null): RelationPartnerTemplate<*, *>

Helper function to get the associated RelationPartnerTemplate

open override fun toString(): String