commonMain.ssm.couchdb.dsl.query.CouchdbSsmSessionStateListQuery.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ssm-couchdb-dsl Show documentation

Aggregate all ssm data source to optimize request

The newest version!

package ssm.couchdb.dsl.query

import f2.dsl.cqrs.page.OffsetPaginationDTO
import f2.dsl.cqrs.page.PageQueryDTO
import f2.dsl.cqrs.page.PageQueryResultDTO
import f2.dsl.fnc.F2Function
import kotlin.js.JsExport
import kotlin.js.JsName
import kotlinx.serialization.Serializable
import ssm.chaincode.dsl.model.SsmName
import ssm.chaincode.dsl.model.SsmSessionStateDTO
import ssm.chaincode.dsl.model.uri.ChaincodeUri
import ssm.chaincode.dsl.model.uri.ChaincodeUriDTO

/**
 * Retrieve the list of all known sessions of a given SSM
 * @d2 function
 * @parent [ssm.couchdb.dsl.CouchdbSsmD2Query]
 * @order 40
 * @title List Sessions
 */
typealias CouchdbSsmSessionStateListQueryFunction
		= F2Function

@JsExport
@JsName("CouchdbSsmSessionStateListQueryDTO")
interface CouchdbSsmSessionStateListQueryDTO : PageQueryDTO {
	/**
	 * The unique uri of a channel.
	 */
	val chaincodeUri: ChaincodeUriDTO
	/**
	 * The unique identifier of a ssm.
	 */
	val ssm: SsmName?
}

@JsExport
@JsName("CouchdbSsmSessionStateListQueryResultDTO")
interface CouchdbSsmSessionStateListQueryResultDTO : PageQueryResultDTO {
	/**
	 * Retrieved sessions
	 */
	override val pagination: OffsetPaginationDTO?
	/**
	 * Retrieved sessions
	 */
	override val items: List
}

/**
 * @d2 query
 * @parent [CouchdbSsmSessionStateListQueryFunction]
 * @title List Sessions: Parameters
 */
@Serializable
@JsExport
@JsName("CouchdbSsmSessionStateListQuery")
class CouchdbSsmSessionStateListQuery(
	override val pagination: OffsetPaginationDTO? = null,
	override val chaincodeUri: ChaincodeUri,
	override val ssm: SsmName? = null
) : CouchdbSsmSessionStateListQueryDTO

/**
 * @d2 event
 * @parent [CouchdbSsmSessionStateListQueryFunction]
 * @title List Sessions: Result
 */
@Serializable
@JsExport
@JsName("CouchdbSsmSessionStateListQueryResult")
class CouchdbSsmSessionStateListQueryResult(
	override val pagination: OffsetPaginationDTO?,
	override val total: Int,
	override val items: List,
) : CouchdbSsmSessionStateListQueryResultDTO