Package com.avoka.tm.query
Class SvcDefQuery
java.lang.Object
com.avoka.tm.query.SvcDefQuery
Provides a service definition value object query class.
Examples
Please find the service definition query examples.
Service Definition List Example
This Groovy example shows how to list service definitions matching.
import com.avoka.tm.query.* import com.avoka.tm.vo.* List<SvcDef> svcDefs = new SvcDefQuery() .setType("Dynamic Data") .withCurrentVersion() .listValues() // In JSON format String svcDefListJson = new SvcDefQuery() .setName("myServiceDefName") .listJson()
- Since:
- 5.1.0
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddOrderByAsc
(String orderProperty) Add the sort order by ascending to the query.addOrderByDesc
(String orderProperty) Add the sort order by descending to the query.int
count()
Execute a select count query and return the total number of records selected by the query.Execute the query and return the first service definition JSON value.Execute the query and return the first service definition value object for the query.listJson()
Execute the query and return service definition JSON array list.Execute the service definition query and return a list of SvcDef value objects.setClientCode
(String clientCode) Set the service definition client code parameter.setCreatedBy
(String createdBy) Set the service definition created by parameter.setFetchLimit
(int fetchLimit) Set the query fetch limit to limit the maximum number of records returned.Set the service definition id (PK) query parameter.setLastModifiedBy
(String lastModifiedBy) Set the service definition last modified by parameter.Set the service definition name parameter.Set the service definition type parameter.setVersion
(String version) Set the service definition version parameter.setVersionNumber
(int versionNumber) Deprecated.Set the query to return the service definition of current version.
-
Constructor Details
-
SvcDefQuery
-
-
Method Details
-
setId
Set the service definition id (PK) query parameter.- Parameters:
id
- the service definition id (PK) query parameter- Returns:
- the service definition query
-
setVersionNumber
Deprecated.Set the service definition version number parameter.- Parameters:
versionNumber
- the service definition version number parameter- Returns:
- the service definition query
-
setVersion
Set the service definition version parameter.- Parameters:
version
- the service definition version number parameter- Returns:
- the service definition query
- Since:
- 17.10.0
-
setName
Set the service definition name parameter.- Parameters:
name
- the service definition name parameter- Returns:
- the service definition query
-
setClientCode
Set the service definition client code parameter.- Parameters:
clientCode
- the service definition client code parameter- Returns:
- the service definition query
-
setType
Set the service definition type parameter.- Parameters:
type
- the service definition type parameter- Returns:
- the service definition query
-
setCreatedBy
Set the service definition created by parameter.- Parameters:
createdBy
- the service definition created by parameter- Returns:
- the service definition query
-
setLastModifiedBy
Set the service definition last modified by parameter.- Parameters:
lastModifiedBy
- the service definition created by parameter- Returns:
- the service definition query
-
withCurrentVersion
Set the query to return the service definition of current version.- Returns:
- the service definition query
-
addOrderByAsc
Add the sort order by ascending to the query.- Parameters:
orderProperty
- the property to sort by (required)- Returns:
- the service definition query
-
addOrderByDesc
Add the sort order by descending to the query.- Parameters:
orderProperty
- the property to sort by (required)- Returns:
- the service definition query
-
setFetchLimit
Set the query fetch limit to limit the maximum number of records returned. The default query fetch limit is 100 records.- Parameters:
fetchLimit
- the query fetch limit- Returns:
- the service definition query
-
count
public int count()Execute a select count query and return the total number of records selected by the query.- Returns:
- the total number of records selected by the query
-
listValues
Execute the service definition query and return a list of SvcDef value objects.- Returns:
- execute the service definition query and return a list of SvcDef value objects
-
listJson
Execute the query and return service definition JSON array list.- Returns:
- execute the query and return service definition JSON array list
-
firstValue
Execute the query and return the first service definition value object for the query.- Returns:
- execute the query and return the first service definition value object for the query
-
firstJson
Execute the query and return the first service definition JSON value.- Returns:
- execute the query and return the first service definition JSON value
-