Package com.xebialabs.xlrelease.api.v1

Interface TaskReportingApi

All Superinterfaces:

ApiService

public interface TaskReportingApi
extends ApiService

Operations on reporting records used by the audit report.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TASK_REPORTING_API

Fields inherited from interface com.xebialabs.xlrelease.api.ApiService

DEFAULT_RESULTS_PER_PAGE, DEFAULT_RESULTS_PER_PAGE_STRING, DEPTH, ORDER_BY, PAGE, PAGE_IS_OFFSET, RESULTS_PER_PAGE, ROLE_IDS_DATA

Method Summary

Modifier and Type	Method	Description
com.xebialabs.xlrelease.domain.facet.TaskReportingRecord	addRecord(com.xebialabs.xlrelease.domain.facet.TaskReportingRecord record)	Adds a new reporting record.
java.util.List<com.xebialabs.xlrelease.domain.facet.TaskReportingRecord>	addRecord(com.xebialabs.xlrelease.domain.facet.TaskReportingRecord record, boolean applyTaskAttributes)
com.xebialabs.xlrelease.domain.udm.reporting.BuildRecord	newBuildRecord()	Factory method to create a new instance of a build record.
com.xebialabs.xlrelease.domain.udm.reporting.CodeComplianceRecord	newCodeComplianceRecord()	Factory method to create a new instance of a code compliance record.
com.xebialabs.xlrelease.domain.udm.reporting.DeploymentRecord	newDeploymentRecord()	Factory method to create a new instance of a deployment record.
com.xebialabs.xlrelease.domain.udm.reporting.ItsmRecord	newItsmRecord()	Factory method to create a new instance of an ITSM record.
com.xebialabs.xlrelease.domain.udm.reporting.PlanRecord	newPlanRecord()	Factory method to create a new instance of a plan record.
default java.lang.String	serviceName()

Field Detail

TASK_REPORTING_API

static final java.lang.String TASK_REPORTING_API

See Also:

Constant Field Values

Method Detail

serviceName

default java.lang.String serviceName()

Specified by:

serviceName in interface ApiService

addRecord

java.util.List<com.xebialabs.xlrelease.domain.facet.TaskReportingRecord> addRecord(com.xebialabs.xlrelease.domain.facet.TaskReportingRecord record,
                                                                                   @QueryParam("applyTaskAttributes")
                                                                                   boolean applyTaskAttributes)

addRecord

com.xebialabs.xlrelease.domain.facet.TaskReportingRecord addRecord(com.xebialabs.xlrelease.domain.facet.TaskReportingRecord record)

Adds a new reporting record. Available since Release 22.2.0, use taskReportingApi.addRecord(record, False) with older Release versions.

Parameters:

record - an TaskReportingRecord object describing the collected data.

Returns:

the newly created record.

newItsmRecord

com.xebialabs.xlrelease.domain.udm.reporting.ItsmRecord newItsmRecord()

Factory method to create a new instance of an ITSM record.

Returns:

instance of the ItsmRecord type.

newPlanRecord

com.xebialabs.xlrelease.domain.udm.reporting.PlanRecord newPlanRecord()

Factory method to create a new instance of a plan record.

Returns:

instance of the PlanRecord type.

newBuildRecord

com.xebialabs.xlrelease.domain.udm.reporting.BuildRecord newBuildRecord()

Factory method to create a new instance of a build record.

Returns:

instance of the BuildRecord type.

newDeploymentRecord

com.xebialabs.xlrelease.domain.udm.reporting.DeploymentRecord newDeploymentRecord()

Factory method to create a new instance of a deployment record.

Returns:

instance of the DeploymentRecord type.

newCodeComplianceRecord

com.xebialabs.xlrelease.domain.udm.reporting.CodeComplianceRecord newCodeComplianceRecord()

Factory method to create a new instance of a code compliance record.

Returns:

instance of the CodeComplianceRecord type.