com.atlassian.servicedesk.api.request

Interface ServiceDeskCustomerRequestService

@ParametersAreNonnullByDefault
 @ExperimentalApi
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
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest>	getRequestForIssue(com.atlassian.jira.user.ApplicationUser user, com.atlassian.jira.issue.Issue issue) Deprecated. use getCustomerRequests(ApplicationUser, CustomerRequestQuery) instead Retrieves a CustomerRequest that is associated with the given issue
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest>	getRequestForIssueOverrideSecurity(com.atlassian.jira.issue.Issue issue) Deprecated. use getCustomerRequests(ApplicationUser, CustomerRequestQuery) instead Retrieves a CustomerRequest that is associated with the given issue ignoring all security constraints. You should not use this method normally, use getRequestForIssue(ApplicationUser, Issue) instead, this should only be used when performing administrative tasks where you need access to a request regardless of permissions or without a user.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest>	getRequestForKey(com.atlassian.jira.user.ApplicationUser user, String issueKey) Deprecated. use getCustomerRequests(ApplicationUser, CustomerRequestQuery) instead Retrieves a CustomerRequest that is associated with the given issue key
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest>	getRequestForKeyOverrideSecurity(String issueKey) Deprecated. user getCustomerRequests(ApplicationUser, CustomerRequestQuery) instead Retrieves a CustomerRequest that is associated with the given issue key ignoring all security constraints. You should not use this method normally, use getRequestForKey(ApplicationUser, java.lang.String) instead, this should only be used when performing administrative tasks where you need access to a request regardless of permissions or without a user.
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
RequestTypeUpdateParameters.Builder	requestTypeUpdateParametersBuilder() Deprecated. use newUpdateBuilder() instead Get the builder to build RequestTypeUpdateParameters
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
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest>	updateRequestType(com.atlassian.jira.user.ApplicationUser user, RequestTypeUpdateParameters requestTypeUpdateParameters) Deprecated. use updateCustomerRequest(ApplicationUser, CustomerRequestUpdateParameters) instead Update the RequestType of the CustomerRequest

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

getRequestForKey

@Deprecated
 @Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest> getRequestForKey(@Nullable
                                                                                                                                       com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                       @Nonnull
                                                                                                                                       String issueKey)

Deprecated. use getCustomerRequests(ApplicationUser, CustomerRequestQuery) instead

Retrieves a CustomerRequest that is associated with the given issue key

Parameters:

issueKey - the key that identifies the service desk CustomerRequest

Returns:

the CustomerRequest that is associated with the given issue key

getRequestForIssue

@Deprecated
 @Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest> getRequestForIssue(@Nullable
                                                                                                                                         com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                         @Nonnull
                                                                                                                                         com.atlassian.jira.issue.Issue issue)

Deprecated. use getCustomerRequests(ApplicationUser, CustomerRequestQuery) instead

Retrieves a CustomerRequest that is associated with the given issue

Parameters:

issue - the issue linked to the service desk CustomerRequest

Returns:

the CustomerRequest that is associated with the given issue

requestTypeUpdateParametersBuilder

@Deprecated
RequestTypeUpdateParameters.Builder requestTypeUpdateParametersBuilder()

Deprecated. use newUpdateBuilder() instead

Get the builder to build RequestTypeUpdateParameters

updateRequestType

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest> updateRequestType(@Nullable
                                                                                                                                        com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                        RequestTypeUpdateParameters requestTypeUpdateParameters)

Deprecated. use updateCustomerRequest(ApplicationUser, CustomerRequestUpdateParameters) instead

Update the RequestType of the CustomerRequest

Parameters:

user - the user in the associated context that perform the action

requestTypeUpdateParameters - the parameters to update RequestType of the CustomerRequest

Returns:

the updated CustomerRequest

getRequestForIssueOverrideSecurity

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest> getRequestForIssueOverrideSecurity(com.atlassian.jira.issue.Issue issue)

Deprecated. use getCustomerRequests(ApplicationUser, CustomerRequestQuery) instead

Retrieves a CustomerRequest that is associated with the given issue ignoring all security constraints.

You should not use this method normally, use getRequestForIssue(ApplicationUser, Issue) instead, this should only be used when performing administrative tasks where you need access to a request regardless of permissions or without a user.

Parameters:

issue - the issue linked to the CustomerRequest

Returns:

the CustomerRequest that is associated with the given issue

getRequestForKeyOverrideSecurity

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CustomerRequest> getRequestForKeyOverrideSecurity(String issueKey)

Deprecated. user getCustomerRequests(ApplicationUser, CustomerRequestQuery) instead

Retrieves a CustomerRequest that is associated with the given issue key ignoring all security constraints.

You should not use this method normally, use getRequestForKey(ApplicationUser, java.lang.String) instead, this should only be used when performing administrative tasks where you need access to a request regardless of permissions or without a user.

Parameters:

issueKey - the issue key of the issue linked to the CustomerRequest

Returns:

the CustomerRequest that is associated with the given issue key

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