Package com.atlassian.servicedesk.api.requesttype

Interface RequestTypeQuery.Builder

Enclosing interface:

RequestTypeQuery

@PublicApi
public static interface RequestTypeQuery.Builder

Builder to construct the RequestTypeQuery.

A LimitedPagedRequest is always constructed in the query parameter, and used the default value if none is provided

Method Summary

Modifier and Type	Method	Description
RequestTypeQuery	build()	Build the query
RequestTypeQuery.Builder	filterHidden(Boolean filter)	Limit results to request types that are not hidden (eg, have no groups)
RequestTypeQuery.Builder	group(Integer group)	Limit results to request types that belong to the specified RequestTypeGroup id
RequestTypeQuery.Builder	issue(Long issue)	Retrieve a specific RequestType associated to the customer request backed by this Issue, if any.
RequestTypeQuery.Builder	isValid(Boolean isValid)	Limit results to only request types that are valid.
RequestTypeQuery.Builder	pagedRequest(PagedRequest pagedRequest)	To query a page PagedRequest of RequestType
RequestTypeQuery.Builder	requestOverrideSecurity(Boolean requestOverrideSecurity)	Use this requestOverrideSecurity flag to execute query without checking permission of the user executing this request
RequestTypeQuery.Builder	requestType(Integer requestType)	Use this RequestType's requestType and ServiceDesk to retrieve a specific RequestType
RequestTypeQuery.Builder	restrictionStatusFilter(Collection<RequestTypeRestrictionStatus> restrictionStatus)	Limit results to request types that match the restriction status filter.
RequestTypeQuery.Builder	serviceDesk(Integer serviceDesk)	Narrows the query to the RequestType's that belong to a ServiceDesk

Method Details

serviceDesk

RequestTypeQuery.Builder serviceDesk(Integer serviceDesk)

Narrows the query to the RequestType's that belong to a ServiceDesk

requestType

RequestTypeQuery.Builder requestType(Integer requestType)

Use this RequestType's requestType and ServiceDesk to retrieve a specific RequestType

group

RequestTypeQuery.Builder group(Integer group)

Limit results to request types that belong to the specified RequestTypeGroup id

issue

RequestTypeQuery.Builder issue(Long issue)

Retrieve a specific RequestType associated to the customer request backed by this Issue, if any.

This does not work with RequestTypeQuery.requestType() or RequestTypeQuery.serviceDesk()

requestOverrideSecurity

RequestTypeQuery.Builder requestOverrideSecurity(Boolean requestOverrideSecurity)

Use this requestOverrideSecurity flag to execute query without checking permission of the user executing this request

This should only be used when performing administrative tasks where you need access regardless of permissions or without a user.

Since:

v3.7.0

pagedRequest

RequestTypeQuery.Builder pagedRequest(PagedRequest pagedRequest)

To query a page PagedRequest of RequestType

isValid

RequestTypeQuery.Builder isValid(Boolean isValid)

Limit results to only request types that are valid. Only valid request types appear on the Customer Portal.

filterHidden

RequestTypeQuery.Builder filterHidden(Boolean filter)

Limit results to request types that are not hidden (eg, have no groups)

build

RequestTypeQuery build()

Build the query

restrictionStatusFilter

RequestTypeQuery.Builder restrictionStatusFilter(Collection<RequestTypeRestrictionStatus> restrictionStatus)

Limit results to request types that match the restriction status filter. When restrictionStatusFilter is empty, this filter will not be considered. When restrictionStatusFilter has OPEN, this filter allow request types that without restrictions. When restrictionStatusFilter has RESTRICTED, this filter allow request types that have restrictions which the user can use to create requests. When restrictionStatusFilter has both OPEN and RESTRICTED, this filter will return both no-restriction and restricted request types that user can use to create requests.

Parameters:

restrictionStatus - the restriction status to filter by

Since:

v10.0.0