com.atlassian.servicedesk.api.requesttype

Interface RequestTypeService

@PublicApi
 @ReturnValuesAreNonnullByDefault
 @ParametersAreNonnullByDefault
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>	deleteRequestType(com.atlassian.jira.user.ApplicationUser user, RequestTypeDeleteParameters requestTypeDeleteParameters) Delete a RequestType with using the provided RequestTypeDeleteParameters.
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
RequestTypeCreateParameters.Builder	newCreateBuilder()
RequestTypeDeleteParameters.Builder	newDeleteBuilder()
RequestTypeQuery.Builder	newQueryBuilder() Create a builder to build RequestTypeQuery
RequestTypeUpdateParameters.Builder	newUpdateBuilder()
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType>	updateRequestType(com.atlassian.jira.user.ApplicationUser user, RequestTypeUpdateParameters requestTypeUpdateParameters) Update a RequestType with using the provided RequestTypeUpdateParameters.

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

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:

• 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.

newDeleteBuilder

RequestTypeDeleteParameters.Builder newDeleteBuilder()

Returns:

a new RequestTypeUpdateParameters.Builder to build RequestTypeUpdateParameters.

Since:

v3.7.0

deleteRequestType

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType> deleteRequestType(com.atlassian.jira.user.ApplicationUser user,
                                                                                                              RequestTypeDeleteParameters requestTypeDeleteParameters)

Delete a RequestType with using the provided RequestTypeDeleteParameters.

Executing user must have permission to perform the request

Parameters:

user - the user executing the request.

requestTypeDeleteParameters - params used to delete the RequestType.

Returns:

the updated RequestType if success, or an AnError if failure.

Since:

v3.7.0

newUpdateBuilder

RequestTypeUpdateParameters.Builder newUpdateBuilder()

Returns:

a new RequestTypeUpdateParameters.Builder to build RequestTypeUpdateParameters.

Since:

v3.7.0

updateRequestType

com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,RequestType> updateRequestType(com.atlassian.jira.user.ApplicationUser user,
                                                                                                              RequestTypeUpdateParameters requestTypeUpdateParameters)

Update a RequestType with using the provided RequestTypeUpdateParameters.

Executing user must have permission to perform the request

Parameters:

user - the user executing the request.

requestTypeUpdateParameters - params used to update the RequestType.

Returns:

the updated RequestType if success, or an AnError if failure.

Since:

v3.7.0