com.atlassian.servicedesk.api.requesttype

Interface RequestTypeService

@ExperimentalApi
public interface RequestTypeService

Used to perform operations on RequestType.

Method Summary

Modifier and Type	Method and Description
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType>	createRequestType(com.atlassian.jira.user.ApplicationUser user, RequestTypeCreateParameters requestTypeCreateParameters) Create a new RequestType with using the provided RequestTypeCreateParameters.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType>	createRequestType(long projectId, int issueTypeId, String name, String description, long iconId, List<Integer> groupIds)
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType>	deleteRequestTypeByIdAndProjectId(Integer requestTypeId, Long projectId) Delete a request type by ID.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<RequestType>>	getAllRequestTypes(com.atlassian.jira.user.ApplicationUser user) Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead Retrieves a list of RequestType that a user has permission to see
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType>	getRequestTypeByIdAndProjectId(Integer requestTypeId, Long projectId) Get a request type by ID.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType>	getRequestTypeForIssue(com.atlassian.jira.user.ApplicationUser user, com.atlassian.jira.issue.Issue issue) Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead Retrieves a RequestType for a Issue
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType>	getRequestTypeForIssueOverrideSecurity(com.atlassian.jira.issue.Issue issue) Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead Retrieves a RequestType for a Issue ignoring all security constraint You should not use this method normally, use getRequestTypeForIssue(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.Issue) instead, this should only be used when performing administrative tasks where you need access to a request type regardless of permissions or without a user.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType>	getRequestTypeForRequest(com.atlassian.jira.user.ApplicationUser user, CustomerRequest customerRequest) Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead Retrieves a RequestType for a CustomerRequest
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType>	getRequestTypeForRequestOverrideSecurity(CustomerRequest customerRequest) Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead Retrieves a RequestType for a CustomerRequest ignoring all security constraint You should not use this method normally, use getRequestTypeForIssue(com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.issue.Issue) instead, this should only be used when performing administrative tasks where you need access to a request type regardless of permissions or without a user.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<RequestType>>	getRequestTypes(com.atlassian.jira.user.ApplicationUser user, RequestTypeQuery requestTypeQuery) Retrieve a list of RequestType that satifies the query parameters
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<RequestType>>	getRequestTypes(com.atlassian.jira.user.ApplicationUser user, RequestTypeQueryParameters requestTypeQueryParameters) Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead Retrieve a list of RequestType in the given Portal, or a specific RequestType if its requestTypeId is given
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<RequestType>>	getRequestTypesByGroup(Integer groupId, Integer serviceDeskId)
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<RequestType>>	getRequestTypesForGroup(Integer groupId, Long projectId)
RequestTypeCreateParameters.Builder	newCreateBuilder()
RequestTypeQuery.Builder	newQueryBuilder() Create a builder to build RequestTypeQuery
RequestTypeQueryParameters.Builder	queryBuilder() Deprecated. use newQueryBuilder() instead Create a RequestTypeQueryParameters.Builder
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType>	updateRequestTypeByIdAndProjectId(Integer requestTypeId, Long projectId, RequestType requestType)

Method Detail

newQueryBuilder

RequestTypeQuery.Builder newQueryBuilder()

Create a builder to build RequestTypeQuery

Returns:

getRequestTypes

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,PagedResponse<RequestType>> getRequestTypes(@Nullable
                                                                                                                                    com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                    @Nonnull
                                                                                                                                    RequestTypeQuery requestTypeQuery)

Retrieve a list of RequestType that satifies the query parameters

Parameters:

user - the user executing the requests

requestTypeQuery - the query parameters

Returns:

a paged of RequestType on successful retrieval, or AnError if failure

getRequestTypes

@Deprecated
 @Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<RequestType>> getRequestTypes(@Nonnull
                                                                                                                                        com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                        @Nonnull
                                                                                                                                        RequestTypeQueryParameters requestTypeQueryParameters)

Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead

Retrieve a list of RequestType in the given Portal, or a specific RequestType if its requestTypeId is given

Parameters:

user - the user in the running context

requestTypeQueryParameters - the query, in which portal is required, and requestTypeId can be optional

Returns:

list of RequestType in the Portal, or the specific request type with the given requestTypeId

queryBuilder

@Deprecated
RequestTypeQueryParameters.Builder queryBuilder()

Deprecated. use newQueryBuilder() instead

Create a RequestTypeQueryParameters.Builder

getRequestTypeForRequest

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType> getRequestTypeForRequest(@Nonnull
                                                                                                                                           com.atlassian.jira.user.ApplicationUser user,
                                                                                                                                           @Nonnull
                                                                                                                                           CustomerRequest customerRequest)

Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead

Retrieves a RequestType for a CustomerRequest

Parameters:

user - the user retrieving the request type

customerRequest - the CustomerRequest that you want to retrieve the request type for.

Returns:

the RequestType that is associated with the given CustomerRequest

getRequestTypeForIssue

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

Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead

Retrieves a RequestType for a Issue

Parameters:

user - the user retrieving the request type

issue - the Issue that you want to retrieve the request type for.

Returns:

the RequestType that is associated with the given Issue

getAllRequestTypes

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<RequestType>> getAllRequestTypes(com.atlassian.jira.user.ApplicationUser user)

Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead

Retrieves a list of RequestType that a user has permission to see

Parameters:

user - the user retrieving the request type

Returns:

a list of RequestType

getRequestTypeForRequestOverrideSecurity

@Nonnull
 @Deprecated
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType> getRequestTypeForRequestOverrideSecurity(@Nonnull
                                                                                                                                                           CustomerRequest customerRequest)

Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead

Retrieves a RequestType for a CustomerRequest ignoring all security constraint

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

Parameters:

customerRequest - the CustomerRequest that you want to retrieve the request type for.

Returns:

the RequestType that is associated with the given CustomerRequest

getRequestTypeForIssueOverrideSecurity

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

Deprecated. use getRequestTypes(ApplicationUser, RequestTypeQuery) instead

Retrieves a RequestType for a Issue ignoring all security constraint

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

Parameters:

issue - the Issue that you want to retrieve the request type for.

Returns:

the RequestType that is associated with the given Issue

newCreateBuilder

RequestTypeCreateParameters.Builder newCreateBuilder()

Returns:

a new RequestTypeCreateParameters.Builder to build RequestTypeCreateParameters.

createRequestType

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType> createRequestType(com.atlassian.jira.user.ApplicationUser user,
                                                                                                              RequestTypeCreateParameters requestTypeCreateParameters)

Create a new RequestType with using the provided RequestTypeCreateParameters.
Default values:

• Icon will default to ... some icon
• Grouping will default to the "default" group
• Status mapping is not supported yet.
• Field mapping is not supported yet and will default to showing only required fields.
• Ordering will default to the last item

Parameters:

user - the user executing the request.

requestTypeCreateParameters - params used to create a new RequestType.

Returns:

a newly created RequestType if success, or an AnError if failure.

createRequestType

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType> createRequestType(long projectId,
                                                                                                              int issueTypeId,
                                                                                                              String name,
                                                                                                              String description,
                                                                                                              long iconId,
                                                                                                              List<Integer> groupIds)

getRequestTypesForGroup

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<RequestType>> getRequestTypesForGroup(Integer groupId,
                                                                                                                          Long projectId)

Parameters:

groupId - The ID of the group to filter request types by

projectId - The ID of the project which contains the group

Returns:

a list of RequestType that are in the specified group

Retrieves a list of RequestType that a user has permission to see that belong to the group specified.

getRequestTypesByGroup

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<RequestType>> getRequestTypesByGroup(Integer groupId,
                                                                                                                         Integer serviceDeskId)

Parameters:

groupId - The ID of the group to filter request types by

serviceDeskId - The ID of the serviceDesk which contains the group

Returns:

a list of RequestType that are in the specified group

Retrieves a list of RequestType that a user has permission to see that belong to the group specified.

getRequestTypeByIdAndProjectId

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType> getRequestTypeByIdAndProjectId(Integer requestTypeId,
                                                                                                                           Long projectId)

Get a request type by ID.

Parameters:

requestTypeId - The ID of the request type.

projectId - The ID of the project owning the request type.

Returns:

The request type.

deleteRequestTypeByIdAndProjectId

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType> deleteRequestTypeByIdAndProjectId(Integer requestTypeId,
                                                                                                                              Long projectId)

Delete a request type by ID.

Parameters:

requestTypeId - The ID of the request type.

projectId - The ID of the project containing the request type.

Returns:

Returns the deleted request type, or an error explaining why it cannot be deleted.

updateRequestTypeByIdAndProjectId

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType> updateRequestTypeByIdAndProjectId(Integer requestTypeId,
                                                                                                                              Long projectId,
                                                                                                                              RequestType requestType)