commonMain.city.smartb.im.organization.domain.features.query.OrganizationRefListFunction.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of organization-domain Show documentation

Identity Management

There is a newer version: 0.14.2

package city.smartb.im.organization.domain.features.query

import city.smartb.im.organization.domain.model.OrganizationRef
import city.smartb.im.organization.domain.model.OrganizationRefDTO
import f2.dsl.cqrs.Event
import f2.dsl.cqrs.Query
import f2.dsl.fnc.F2Function
import kotlin.js.JsExport
import kotlin.js.JsName

/**
 * Get all organization refs.
 * @d2 function
 * @parent [city.smartb.im.organization.domain.D2OrganizationPage]
 * @order 40
 */
typealias OrganizationRefListFunction = F2Function

@JsExport
@JsName("OrganizationRefListQueryDTO")
interface OrganizationRefListQueryDTO: Query {
	val withDisabled: Boolean
}

/**
 * @d2 query
 * @parent [OrganizationRefListFunction]
 */
data class OrganizationRefListQuery(
	/**
	 * If false, filter out the disabled organizations. (default: false)
	 * @example false
	 */
	override val withDisabled: Boolean = false,
): OrganizationRefListQueryDTO

@JsExport
@JsName("OrganizationRefListResultDTO")
interface OrganizationRefListResultDTO: Event {
	val items: List
}

/**
 * @d2 result
 * @parent [OrganizationRefListFunction]
 */
data class OrganizationRefListResult(
	/**
	 * All Organization Refs.
	 */
	override val items: List
): OrganizationRefListResultDTO