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
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest>	createCustomerRequest(com.atlassian.jira.user.ApplicationUser user, CustomerRequestCreateParameters customerRequestCreateParameters) Create a customer request using the given parameter
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<CustomerRequest>>	getCustomerRequests(com.atlassian.jira.user.ApplicationUser user, CustomerRequestQuery customerRequestQuery) Retrieve a page of CustomerRequest that satisfies the query parameters
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,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
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
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,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

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,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:

a customer request if succeeded, or an error if failure

newQueryBuilder

@Nonnull
CustomerRequestQuery.Builder newQueryBuilder()

Get the builder to build CustomerRequestQuery

getCustomerRequests

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,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 page of CustomerRequest if successful retrieval, or AnError if failure

newUpdateBuilder

@Nonnull
CustomerRequestUpdateParameters.Builder newUpdateBuilder()

Create a builder to build CustomerRequestUpdateParameters

updateCustomerRequest

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,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 if succeeded, or AnError if update failure

newStatusQueryBuilder

CustomerRequestStatusQuery.Builder newStatusQueryBuilder()

Create a builder to build CustomerRequestStatusQuery

getCustomerRequestStatus

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,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:

an AnError if failure, or a paged collection of CustomerRequest.CustomerRequestStatus