com.atlassian.servicedesk.api.request

Interface ServiceDeskCustomerRequestService

@ParametersAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
 @PublicApi
public interface ServiceDeskCustomerRequestService

Used to perform actions on CustomerRequest

Method Summary

Modifier and Type	Method and Description
CustomerRequest	createCustomerRequest(com.atlassian.jira.user.ApplicationUser user, CustomerRequestCreateParameters customerRequestCreateParameters) Create a customer request using the given parameter
CustomerRequest	getCustomerRequest(com.atlassian.jira.user.ApplicationUser user, CustomerRequestIssueQuery customerRequestIssueQuery) Retrieve a CustomerRequest that matches the issueID
PagedResponse<CustomerRequest>	getCustomerRequests(com.atlassian.jira.user.ApplicationUser user, CustomerRequestQuery customerRequestQuery) Retrieve a page of CustomerRequest that satisfies the query parameters
PagedResponse<CustomerRequest.CustomerRequestStatus>	getCustomerRequestStatus(com.atlassian.jira.user.ApplicationUser user, CustomerRequestStatusQuery query) Retrieve a page of CustomerRequest.CustomerRequestStatus of a CustomerRequest by chronological order in which the status transition taken place
CustomerRequestCreateParameters.Builder	newCreateBuilder() Create a builder to build CustomerRequestCreateParameters
CustomerRequestIssueQuery.Builder	newIssueQueryBuilder() Get the builder to build CustomerRequestIssueQuery
CustomerRequestQuery.Builder	newQueryBuilder() Get the builder to build CustomerRequestQuery
CustomerRequestStatusQuery.Builder	newStatusQueryBuilder() Create a builder to build CustomerRequestStatusQuery
CustomerRequestUpdateParameters.Builder	newUpdateBuilder() Create a builder to build CustomerRequestUpdateParameters
CustomerRequest	updateCustomerRequest(com.atlassian.jira.user.ApplicationUser user, CustomerRequestUpdateParameters customerRequestUpdateParameters) Update the CustomerRequest using the given parameters

Method Detail

newCreateBuilder

CustomerRequestCreateParameters.Builder newCreateBuilder()

Create a builder to build CustomerRequestCreateParameters

createCustomerRequest

CustomerRequest createCustomerRequest(@Nullable
                                      com.atlassian.jira.user.ApplicationUser user,
                                      CustomerRequestCreateParameters customerRequestCreateParameters)

Create a customer request using the given parameter

Parameters:

user - the user exciting the request

customerRequestCreateParameters - the request create parameter. Refer to RequestTypeFieldService.getCustomerRequestCreateMeta(ApplicationUser, RequestTypeFieldQuery) on how to construct it

Returns:

the CustomerRequest created

Throws:

ServiceDeskServiceException - on error

newQueryBuilder

@Nonnull
CustomerRequestQuery.Builder newQueryBuilder()

Get the builder to build CustomerRequestQuery

newIssueQueryBuilder

@Nonnull
CustomerRequestIssueQuery.Builder newIssueQueryBuilder()

Get the builder to build CustomerRequestIssueQuery

getCustomerRequests

@Nonnull
PagedResponse<CustomerRequest> getCustomerRequests(@Nullable
                                                            com.atlassian.jira.user.ApplicationUser user,
                                                            CustomerRequestQuery customerRequestQuery)

Retrieve a page of CustomerRequest that satisfies the query parameters

Parameters:

user - the user executing the requests

customerRequestQuery - the query parameter

Returns:

a paged collection of CustomerRequest

Throws:

ServiceDeskServiceException - on error

getCustomerRequest

CustomerRequest getCustomerRequest(@Nullable
                                   com.atlassian.jira.user.ApplicationUser user,
                                   CustomerRequestIssueQuery customerRequestIssueQuery)

Retrieve a CustomerRequest that matches the issueID

Parameters:

user - the user executing the requests

customerRequestIssueQuery - the query parameter

Returns:

the CustomerRequest

Throws:

ServiceDeskServiceException - on error

newUpdateBuilder

@Nonnull
CustomerRequestUpdateParameters.Builder newUpdateBuilder()

Create a builder to build CustomerRequestUpdateParameters

updateCustomerRequest

@Nonnull
CustomerRequest updateCustomerRequest(@Nullable
                                               com.atlassian.jira.user.ApplicationUser user,
                                               @Nonnull
                                               CustomerRequestUpdateParameters customerRequestUpdateParameters)

Update the CustomerRequest using the given parameters

Parameters:

user - the user executing the request

customerRequestUpdateParameters - parameters to update the customer request

Returns:

the updated CustomerRequest

Throws:

ServiceDeskServiceException - on error

newStatusQueryBuilder

CustomerRequestStatusQuery.Builder newStatusQueryBuilder()

Create a builder to build CustomerRequestStatusQuery

getCustomerRequestStatus

@Nonnull
PagedResponse<CustomerRequest.CustomerRequestStatus> getCustomerRequestStatus(@Nullable
                                                                                       com.atlassian.jira.user.ApplicationUser user,
                                                                                       CustomerRequestStatusQuery query)

Retrieve a page of CustomerRequest.CustomerRequestStatus of a CustomerRequest by chronological order in which the status transition taken place

Parameters:

user - the user executing the query

query - the request status query

Returns:

a paged collection of CustomerRequest.CustomerRequestStatus

Throws:

ServiceDeskServiceException - on error