Skip to content

Commit dc4e309

Browse files
committed
Doc: undocumented exception on getDeviceDeploymentFor
1 parent bc6ef2f commit dc4e309

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

carp.deployments.core/src/commonMain/kotlin/dk/cachet/carp/deployments/application/DeploymentService.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@ interface DeploymentService : ApplicationService<DeploymentService, DeploymentSe
126126
* @throws IllegalArgumentException when:
127127
* - a deployment with [studyDeploymentId] does not exist
128128
* - [primaryDeviceRoleName] is not present in the deployment
129+
* - the device with [primaryDeviceRoleName] has not yet been registered
129130
* @throws IllegalStateException when the deployment for the requested primary device is not yet available.
130131
*/
131132
suspend fun getDeviceDeploymentFor( studyDeploymentId: UUID, primaryDeviceRoleName: String ): PrimaryDeviceDeployment

carp.deployments.core/src/commonMain/kotlin/dk/cachet/carp/deployments/application/DeploymentServiceHost.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ class DeploymentServiceHost(
179179
* @throws IllegalArgumentException when:
180180
* - a deployment with [studyDeploymentId] does not exist
181181
* - [primaryDeviceRoleName] is not present in the deployment
182+
* - the device with [primaryDeviceRoleName] has not yet been registered
182183
* @throws IllegalStateException when the deployment for the requested primary device is not yet available.
183184
*/
184185
override suspend fun getDeviceDeploymentFor( studyDeploymentId: UUID, primaryDeviceRoleName: String ): PrimaryDeviceDeployment

0 commit comments

Comments
 (0)