Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ACTIVE - Enum constant in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeAllowedEntityStatus
- add(T) - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl.Builder
- addAll(Iterable<T>) - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl.Builder
- addCustomersToServiceDesk(ApplicationUser, ServiceDesk, Set<String>) - Method in interface com.atlassian.servicedesk.api.customer.CustomerService
-
Adds existing Jira Service Management customers to a service project.
- addEntry(DateTime, MatchEvent) - Method in class com.atlassian.servicedesk.api.sla.condition.MatchConditionHistoryBuilder
-
Add an entry to the history.
- addGroupId(Integer) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters.Builder
- addHit(DateTime) - Method in class com.atlassian.servicedesk.api.sla.condition.HitConditionHistoryBuilder
-
Add a hit to the history
- addOrganizationToServiceDesk(ApplicationUser, OrganizationServiceDeskUpdateParameters) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
-
Adds an organization to a service project if the user is an agent of that service project.
- addQueue(ApplicationUser, QueueCreateParameters) - Method in interface com.atlassian.servicedesk.api.queue.QueueService
-
Given the required QueueParameters create a new
Queue
in the service project - addRequestParticipants(ApplicationUser, RequestParticipantUpdateParameters) - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantService
-
Add a list of
ApplicationUser
as participant to a givenCustomerRequest
. - addUsersToOrganization(ApplicationUser, UsersOrganizationUpdateParameters) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
-
Adds users to a specified organization.
- ALL_ORGANIZATIONS - Enum constant in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_OWNERSHIP
- ALL_ORGANIZATIONS_AND_GROUPS - Enum constant in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_OWNERSHIP
- ALL_REQUESTS - Enum constant in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_OWNERSHIP
- ALL_REQUESTS - Enum constant in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_STATUS
- ANONYMOUS_PORTAL - Static variable in class com.atlassian.servicedesk.api.request.CustomerRequestChannelSource
-
Source channel from which
CustomerRequest
s are created on JIRA Service Management's Customer Portal by anonymous user - AnonymousUser - Interface in com.atlassian.servicedesk.api.user
-
Anonymous SDUser implementation.
- answerApproval(ApplicationUser, Approval, ApprovalDecisionType) - Method in interface com.atlassian.servicedesk.api.approval.ApprovalService
-
Answer to an approval of a given
approvalId
The answer could be approve or decline Required permissions: - User is an approver of the approval - User can view the request that the approval belongs to - answerApproval(ApplicationUser, Approval, ApprovalDecisionType, ApprovalComment) - Method in interface com.atlassian.servicedesk.api.approval.ApprovalService
-
Answer to an approval of a given
approvalId
The answer could be approve or decline Required permissions: - User is an approver of the approval - User can view the request that the approval belongs to - API - Static variable in class com.atlassian.servicedesk.api.request.CustomerRequestChannelSource
-
Source channel from which
CustomerRequest
s are created by Jira Service Management's REST API or Java API - Approval - Interface in com.atlassian.servicedesk.api.approval
-
Representation of an approval
- ApprovalComment - Interface in com.atlassian.servicedesk.api.approval
- ApprovalCommentConfig - Interface in com.atlassian.servicedesk.api.approval
- ApprovalCondition - Interface in com.atlassian.servicedesk.api.approval
-
Represent a condition of an
Approval
which need to be accomplished - ApprovalDecision - Interface in com.atlassian.servicedesk.api.approval
-
Represent a final decision of an
Approval
- ApprovalDecisionType - Enum Class in com.atlassian.servicedesk.api.approval
-
Represents either an approved or rejected decision.
- ApprovalQuery - Interface in com.atlassian.servicedesk.api.approval
-
Parameters to query
Approval
- ApprovalQuery.Builder - Interface in com.atlassian.servicedesk.api.approval
- ApprovalService - Interface in com.atlassian.servicedesk.api.approval
- APPROVED - Enum constant in enum class com.atlassian.servicedesk.api.approval.ApprovalDecisionType
- Approver - Interface in com.atlassian.servicedesk.api.approval
-
Representation of an approval
- asCheckedUser() - Method in interface com.atlassian.servicedesk.api.user.UncheckedUser
-
Deprecated.Convert this
UncheckedUser
into an optionalCheckedUser
. - asDataInput() - Method in interface com.atlassian.servicedesk.spi.email.attachment.ServiceDeskEmailAttachmentMatcher.AttachmentContent
-
Return the content as a
DataInput
for consumption. - asInputStream() - Method in interface com.atlassian.servicedesk.spi.email.attachment.ServiceDeskEmailAttachmentMatcher.AttachmentContent
-
Return the content as a
ByteArrayInputStream
for consumption. - asString(Expansion[]) - Static method in class com.atlassian.servicedesk.api.util.expansion.ExpansionsParser
-
Converts a collection of
Expansion
s into a single string. - asString(Expansions) - Static method in class com.atlassian.servicedesk.api.util.expansion.ExpansionsParser
-
Converts a
Expansions
collection into a single string. - asUncheckedUser() - Method in interface com.atlassian.servicedesk.api.user.CheckedUser
-
Convert this
CheckedUser
into aUncheckedUser
that will never be anonymous - author() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters
- author(ApplicationUser) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters.Builder
- AuthorizationException - Exception in com.atlassian.servicedesk.api
-
An exception thrown by Jira Service Management indicating that the current user is not authorized to perform the requested action.
- AuthorizationException(ExceptionMessage) - Constructor for exception com.atlassian.servicedesk.api.AuthorizationException
- AuthorizationException(ExceptionMessage, Throwable) - Constructor for exception com.atlassian.servicedesk.api.AuthorizationException
B
- BadRequestException - Exception in com.atlassian.servicedesk.api
-
An exception thrown by Jira Service Management when the request to the server is malformed in some way
- BadRequestException(ExceptionMessage) - Constructor for exception com.atlassian.servicedesk.api.BadRequestException
- BadRequestException(ExceptionMessage, Throwable) - Constructor for exception com.atlassian.servicedesk.api.BadRequestException
- body() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters
-
Optional text body of the Comment.
- body(String) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.customer.CustomerCreateParameters.Builder
- build() - Method in class com.atlassian.servicedesk.api.field.impl.RequestTypeFieldValueImpl.BuilderImpl
- build() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldValue.Builder
- build() - Method in interface com.atlassian.servicedesk.api.organization.CreateOrganizationParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationServiceDeskUpdateParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationsQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.organization.UsersInOrganizationQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.organization.UsersOrganizationUpdateParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.project.creation.MigrateProjectParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.queue.QueueCreateParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.queue.QueueQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.queue.QueueRequestQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
Build the parameters
- build() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestIssueQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestStatusQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestUpdateParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantUpdateParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionExecutionParameters.Builder
-
Build the parameters object
- build() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionQuery.Builder
- build() - Method in interface com.atlassian.servicedesk.api.request.type.CustomerRequestTypeQuery.Builder
-
Build the query
- build() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeDeleteParameters.Builder
- build() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery.Builder
-
Build the query
- build() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeUpdateParameters.Builder
- build() - Method in class com.atlassian.servicedesk.api.sla.condition.HitConditionHistoryBuilder
-
Build a history object
- build() - Method in class com.atlassian.servicedesk.api.sla.condition.MatchConditionHistoryBuilder
-
Build a MatchConditionHistory object
- build() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery.Builder
- build() - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl.Builder
- builder() - Static method in class com.atlassian.servicedesk.api.field.impl.RequestTypeFieldValueImpl
- Builder() - Constructor for class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl.Builder
C
- call() - Method in interface com.atlassian.servicedesk.api.customer.NoExceptionsCallable
-
Computes a result
- canAddRequestParticipants() - Method in interface com.atlassian.servicedesk.api.field.CustomerRequestCreateMeta
-
True if the logging in user can create a request with other users as participants.
- canAnswerApproval(ApplicationUser, Approval) - Method in interface com.atlassian.servicedesk.api.approval.ApprovalService
-
Return true if
user
can answer this approval or false if: - user is not approver of the passed in approval - the approval is not pending anymore - the issue that the approval belong to does not have the same current status as the approval configured - user already made decision - canExpand(String) - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
- canRaiseOnBehalfOf() - Method in interface com.atlassian.servicedesk.api.field.CustomerRequestCreateMeta
-
True if the logging in user can create a request on behalf of other user.
- CheckedUser - Interface in com.atlassian.servicedesk.api.user
-
Checked SDUser implementation.
- checkRecursiveExpansion(String) - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
-
Checks to see if the passed in expansion string is expanded again somewhere in the expansions map.
- children() - Method in class com.atlassian.servicedesk.api.field.impl.RequestTypeFieldValueImpl
- children() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldValue
-
Nested valid values as children of this field value if applicable, or empty otherwise
- children(List<RequestTypeFieldValue>) - Method in class com.atlassian.servicedesk.api.field.impl.RequestTypeFieldValueImpl.BuilderImpl
- children(List<RequestTypeFieldValue>) - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldValue.Builder
- CLOSED_REQUESTS - Enum constant in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_STATUS
- com.atlassian.servicedesk.api - package com.atlassian.servicedesk.api
-
com.atlassian.servicedesk:jira-servicedesk-api
- com.atlassian.servicedesk.api.approval - package com.atlassian.servicedesk.api.approval
- com.atlassian.servicedesk.api.comment - package com.atlassian.servicedesk.api.comment
- com.atlassian.servicedesk.api.customer - package com.atlassian.servicedesk.api.customer
- com.atlassian.servicedesk.api.event - package com.atlassian.servicedesk.api.event
- com.atlassian.servicedesk.api.feedback - package com.atlassian.servicedesk.api.feedback
- com.atlassian.servicedesk.api.field - package com.atlassian.servicedesk.api.field
- com.atlassian.servicedesk.api.field.impl - package com.atlassian.servicedesk.api.field.impl
- com.atlassian.servicedesk.api.info - package com.atlassian.servicedesk.api.info
- com.atlassian.servicedesk.api.license - package com.atlassian.servicedesk.api.license
- com.atlassian.servicedesk.api.notification - package com.atlassian.servicedesk.api.notification
- com.atlassian.servicedesk.api.organization - package com.atlassian.servicedesk.api.organization
- com.atlassian.servicedesk.api.permission - package com.atlassian.servicedesk.api.permission
- com.atlassian.servicedesk.api.portal - package com.atlassian.servicedesk.api.portal
- com.atlassian.servicedesk.api.portal.login - package com.atlassian.servicedesk.api.portal.login
- com.atlassian.servicedesk.api.project.creation - package com.atlassian.servicedesk.api.project.creation
- com.atlassian.servicedesk.api.queue - package com.atlassian.servicedesk.api.queue
- com.atlassian.servicedesk.api.request - package com.atlassian.servicedesk.api.request
- com.atlassian.servicedesk.api.request.participant - package com.atlassian.servicedesk.api.request.participant
- com.atlassian.servicedesk.api.request.transition - package com.atlassian.servicedesk.api.request.transition
- com.atlassian.servicedesk.api.request.type - package com.atlassian.servicedesk.api.request.type
- com.atlassian.servicedesk.api.requesttype - package com.atlassian.servicedesk.api.requesttype
- com.atlassian.servicedesk.api.sla.condition - package com.atlassian.servicedesk.api.sla.condition
- com.atlassian.servicedesk.api.sla.event - package com.atlassian.servicedesk.api.sla.event
- com.atlassian.servicedesk.api.sla.info - package com.atlassian.servicedesk.api.sla.info
- com.atlassian.servicedesk.api.sla.metrics - package com.atlassian.servicedesk.api.sla.metrics
- com.atlassian.servicedesk.api.user - package com.atlassian.servicedesk.api.user
- com.atlassian.servicedesk.api.util.expansion - package com.atlassian.servicedesk.api.util.expansion
- com.atlassian.servicedesk.api.util.paging - package com.atlassian.servicedesk.api.util.paging
- com.atlassian.servicedesk.spi - package com.atlassian.servicedesk.spi
-
com.atlassian.servicedesk:jira-servicedesk-api
- com.atlassian.servicedesk.spi.email.attachment - package com.atlassian.servicedesk.spi.email.attachment
- com.atlassian.servicedesk.spi.email.replystripping - package com.atlassian.servicedesk.spi.email.replystripping
- com.atlassian.servicedesk.spi.sla.condition - package com.atlassian.servicedesk.spi.sla.condition
- combine(Object...) - Static method in class com.atlassian.servicedesk.api.util.expansion.Expansion
-
Creates an Expansion made up of the given parts.
- comment() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionExecutionParameters
-
Get the comment
- comment(String) - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionExecutionParameters.Builder
-
Comment to add during the transition
- contentEquals(byte[]) - Method in interface com.atlassian.servicedesk.spi.email.attachment.ServiceDeskEmailAttachmentMatcher.AttachmentContent
-
Checks that the contents of this attachment are equal to the contents of the given byte source.
- create(int) - Static method in class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
- create(int, int, int) - Static method in class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
- create(PagedRequest, int) - Static method in class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
- createCustomer(ApplicationUser, CustomerCreateParameters) - Method in interface com.atlassian.servicedesk.api.customer.CustomerService
-
Creates a Jira Service Management customer.
- createCustomerRequest(ApplicationUser, CustomerRequestCreateParameters) - Method in interface com.atlassian.servicedesk.api.request.ServiceDeskCustomerRequestService
-
Create a customer request using the given parameter
- createOrganization(ApplicationUser, CreateOrganizationParameters) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
-
Creates a new customer organization.
- CreateOrganizationParameters - Interface in com.atlassian.servicedesk.api.organization
-
Information supplied to
OrganizationService.createOrganization(com.atlassian.jira.user.ApplicationUser, com.atlassian.servicedesk.api.organization.CreateOrganizationParameters)
to create a new organization - CreateOrganizationParameters.Builder - Interface in com.atlassian.servicedesk.api.organization
- createRequestType(ApplicationUser, RequestTypeCreateParameters) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeService
-
Create a new
RequestType
using the providedRequestTypeCreateParameters
. - createServiceDeskComment(ApplicationUser, ServiceDeskCommentCreateParameters) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentService
-
Create a new service project comment with the provided
ApplicationUser
as the author - currentStatus() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequest
-
Current status of the customer request
- CustomerContextService - Interface in com.atlassian.servicedesk.api.customer
-
A service project customer context allows any "named user" access to Jira Service Management and Jira Platform services.
- CustomerCreateParameters - Interface in com.atlassian.servicedesk.api.customer
-
Information supplied to
CustomerService.createCustomer(com.atlassian.jira.user.ApplicationUser, com.atlassian.servicedesk.api.customer.CustomerCreateParameters)
to create a new customer - CustomerCreateParameters.Builder - Interface in com.atlassian.servicedesk.api.customer
- CustomerNotificationSubscriptionService - Interface in com.atlassian.servicedesk.api.notification
-
Service that can be used for Customer Notification subscription operations.
- customerOrganization(CustomerOrganization) - Method in interface com.atlassian.servicedesk.api.organization.UsersInOrganizationQuery.Builder
- CustomerOrganization - Interface in com.atlassian.servicedesk.api.organization
-
Representation of an organization
- customerRequest() - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantQuery
-
The ID of the
Issue
backing theCustomerRequest
whose participants will be returned - customerRequest() - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantUpdateParameters
- customerRequest(CustomerRequest) - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantUpdateParameters.Builder
-
Set the
CustomerRequest
to modify participants - customerRequest(Long) - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantQuery.Builder
- CustomerRequest - Interface in com.atlassian.servicedesk.api.request
-
A customer request in a service project
- CustomerRequest.CustomerRequestStatus - Interface in com.atlassian.servicedesk.api.request
-
Status of a customer request
- customerRequestChannelSource() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters
-
The source channel from which the request is created
- customerRequestChannelSource(CustomerRequestChannelSource) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
The request channel source from which the request is created
- CustomerRequestChannelSource - Class in com.atlassian.servicedesk.api.request
-
The source channel from which the
CustomerRequest
created. - CustomerRequestChannelSourceI18nService - Interface in com.atlassian.servicedesk.api.request
- CustomerRequestChannelSourceI18nService.CustomerRequestChannelRenderedName - Interface in com.atlassian.servicedesk.api.request
-
Render of a
CustomerRequestChannelSource
- CustomerRequestCreateMeta - Interface in com.atlassian.servicedesk.api.field
-
Present a list of fields used to create a customer request.
- CustomerRequestCreateParameters - Interface in com.atlassian.servicedesk.api.request
-
Parameters to create an
CustomerRequest
- CustomerRequestCreateParameters.Builder - Interface in com.atlassian.servicedesk.api.request
- CustomerRequestIssueQuery - Interface in com.atlassian.servicedesk.api.request
-
Parameters to query
CustomerRequest
- CustomerRequestIssueQuery.Builder - Interface in com.atlassian.servicedesk.api.request
-
Builder to construct
CustomerRequestIssueQuery
- CustomerRequestQuery - Interface in com.atlassian.servicedesk.api.request
-
Parameters to query
CustomerRequest
which a user has access to. - CustomerRequestQuery.Builder - Interface in com.atlassian.servicedesk.api.request
-
Builder to construct the
CustomerRequestQuery
. - CustomerRequestQuery.REQUEST_OWNERSHIP - Enum Class in com.atlassian.servicedesk.api.request
- CustomerRequestQuery.REQUEST_STATUS - Enum Class in com.atlassian.servicedesk.api.request
- CustomerRequestStatusQuery - Interface in com.atlassian.servicedesk.api.request
-
Parameters to query
CustomerRequest.CustomerRequestStatus
of aCustomerRequest
- CustomerRequestStatusQuery.Builder - Interface in com.atlassian.servicedesk.api.request
-
Builder to construct the
CustomerRequestStatusQuery
. - CustomerRequestType - Interface in com.atlassian.servicedesk.api.request.type
-
A value that can be used within Jira's Custom Field and Issue APIs, when want to set a value for the Customer Request Type custom field, that is created by Jira Service Management
- CustomerRequestTypeQuery - Interface in com.atlassian.servicedesk.api.request.type
-
Query to search for
CustomerRequestType
- CustomerRequestTypeQuery.Builder - Interface in com.atlassian.servicedesk.api.request.type
-
Builder to construct the
CustomerRequestTypeQuery
. - CustomerRequestTypeService - Interface in com.atlassian.servicedesk.api.request.type
-
Provides access to
CustomerRequestType
- CustomerRequestUpdateParameters - Interface in com.atlassian.servicedesk.api.request
-
Parameters to update an
CustomerRequest
- CustomerRequestUpdateParameters.Builder - Interface in com.atlassian.servicedesk.api.request
-
Builder to construct the
CustomerRequestUpdateParameters
- CustomerService - Interface in com.atlassian.servicedesk.api.customer
- CustomerTransition - Interface in com.atlassian.servicedesk.api.request.transition
-
Customer transition configuration.
- CustomerTransitionExecutionParameters - Interface in com.atlassian.servicedesk.api.request.transition
-
Defines the infomation required to execute a customer transition
- CustomerTransitionExecutionParameters.Builder - Interface in com.atlassian.servicedesk.api.request.transition
-
Builder for customer transition execution parameters.
- CustomerTransitionQuery - Interface in com.atlassian.servicedesk.api.request.transition
-
Parameters to query available
CustomerTransition
of aCustomerRequest
- CustomerTransitionQuery.Builder - Interface in com.atlassian.servicedesk.api.request.transition
-
Builder to construct the
CustomerTransitionQuery
. - CustomerTransitionService - Interface in com.atlassian.servicedesk.api.request.transition
-
Used to allow a customer to transition a
CustomerRequest
- customField() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery
- customField(CustomField) - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery.Builder
D
- DEFAULT_THINGS_RETURNED - Static variable in class com.atlassian.servicedesk.api.util.paging.DefaultPagingLimits
-
If no limit is specified, then we use this value
- DefaultPagingLimits - Class in com.atlassian.servicedesk.api.util.paging
-
Paging has limits and here they are.
- DefaultPagingLimits() - Constructor for class com.atlassian.servicedesk.api.util.paging.DefaultPagingLimits
- delete(ApplicationUser, Integer) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
-
Deletes a customer organization if the user is a Jira admin and an agent.
- DELETED - Enum constant in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeAllowedEntityStatus
- deleteQueue(ApplicationUser, int, int) - Method in interface com.atlassian.servicedesk.api.queue.QueueService
-
Delete
Queue
for the given id - deleteRequestType(ApplicationUser, RequestTypeDeleteParameters) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeService
-
Delete a
RequestType
with using the providedRequestTypeDeleteParameters
. - description() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeField
-
Description of the field
- description() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters
-
Optional description of this
RequestType
. - description() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeUpdateParameters
-
Optional description of this
RequestType
. - description(String) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters.Builder
- description(String) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeUpdateParameters.Builder
E
- email(String) - Method in interface com.atlassian.servicedesk.api.customer.CustomerCreateParameters.Builder
- EMAIL - Static variable in class com.atlassian.servicedesk.api.request.CustomerRequestChannelSource
-
Source channel from which
CustomerRequest
s are created by Jira Service Management's email to create function - empty(boolean) - Static method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
-
Returns an empty PagedResponse with the specified hasNextPage flag
- empty(boolean, LimitedPagedRequest) - Static method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
-
Returns an empty PagedResponse
- empty(boolean, PagedRequest) - Static method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
-
Returns an empty PagedResponse
- EMPTY - Static variable in class com.atlassian.servicedesk.api.util.expansion.Expansions
- equals(Object) - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackDetails
- equals(Object) - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackToken
- equals(Object) - Method in class com.atlassian.servicedesk.api.field.FieldId
- equals(Object) - Method in class com.atlassian.servicedesk.api.field.FieldInputValue
- equals(Object) - Method in class com.atlassian.servicedesk.api.request.CustomerRequestChannelSource
- equals(Object) - Method in class com.atlassian.servicedesk.api.util.expansion.Expansion
- equals(Object) - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
- equals(Object) - Method in class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
- evaluate(Issue, SLAChangeEvent) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricHitCondition
-
Evaluate the condition for a given issue and event
- evaluate(Issue, SLAChangeEvent) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricMatchCondition
-
Evaluate the condition for a given issue and event
- evaluateFromIssueHistory(Issue, DateTime, DateTime) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricHitCondition
-
Digs through issue history after a given moment in time when the condition matched the issue.
- evaluateFromIssueHistory(Issue, DateTime, DateTime) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricMatchCondition
-
Digs through issue history after a given moment in time when the condition matched the issue.
- ExceptionMessage - Class in com.atlassian.servicedesk.api
-
Message returned inside of a
ServiceDeskServiceException
Contains an error key and a translated error message based on the language settings of the Jira Application. - ExceptionMessage(String, String) - Constructor for class com.atlassian.servicedesk.api.ExceptionMessage
- executeCustomerTransition(ApplicationUser, CustomerTransitionExecutionParameters) - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionService
-
Executes a
CustomerTransition
for aCustomerRequest
- Expansion - Class in com.atlassian.servicedesk.api.util.expansion
-
Represents a property on a model object and the sub-properties of that property that should be filled in by the service when returning the model object.
- Expansion(String) - Constructor for class com.atlassian.servicedesk.api.util.expansion.Expansion
- Expansion(String, Expansions) - Constructor for class com.atlassian.servicedesk.api.util.expansion.Expansion
- Expansions - Class in com.atlassian.servicedesk.api.util.expansion
-
Represents a collection of
Expansion
' properties on a model object should be filled in by the service when returning the model object. - Expansions(Expansion...) - Constructor for class com.atlassian.servicedesk.api.util.expansion.Expansions
- Expansions(Iterable<Expansion>) - Constructor for class com.atlassian.servicedesk.api.util.expansion.Expansions
- ExpansionsParser - Class in com.atlassian.servicedesk.api.util.expansion
-
Converts
Expansion
s to and from a String for use with REST calls say. - ExpansionsParser() - Constructor for class com.atlassian.servicedesk.api.util.expansion.ExpansionsParser
F
- fieldId() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeField
-
The ID of the field
- FieldId - Class in com.atlassian.servicedesk.api.field
-
Represents a JIRA
Field.getId()
instance - FieldInputValue - Class in com.atlassian.servicedesk.api.field
-
Represents a value passed in via the API when creating a Request.
- fields(List<String>) - Method in interface com.atlassian.servicedesk.api.queue.QueueCreateParameters.Builder
- fields(List<String>) - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters.Builder
- fieldValue(FieldId, FieldInputValue) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
Add a pair field and its value
- fieldValues() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters
-
A map of
FieldId
and theirFieldInputValue
s used when creating the request. - fieldValues(Map<FieldId, FieldInputValue>) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
Set fields and values
- filteredPageResponse(LimitedPagedRequest, List<T>, Predicate<? super T>) - Static method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
-
Reduces a list of items for a limited request by the predicate provided.
- filterHidden(Boolean) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery.Builder
-
Limit results to request types that are not hidden (eg, have no groups)
- findFirst() - Method in interface com.atlassian.servicedesk.api.util.paging.PagedResponse
- findFirst() - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
- ForbiddenException - Exception in com.atlassian.servicedesk.api
-
An Exception thrown by Jira Service Management indicating that a particular action can not be performed by the current user.
- ForbiddenException(ExceptionMessage) - Constructor for exception com.atlassian.servicedesk.api.ForbiddenException
- ForbiddenException(ExceptionMessage, Throwable) - Constructor for exception com.atlassian.servicedesk.api.ForbiddenException
- forJIRA() - Method in interface com.atlassian.servicedesk.api.user.CheckedUser
-
The user value can be NOT BE NULL from a CheckUser instance (as opposed to a SDUser instance)
- forJIRA() - Method in interface com.atlassian.servicedesk.api.user.SDUser
-
Casts a Jira Service Management user instance to Jira user instance.
- forKey(String) - Static method in enum class com.atlassian.servicedesk.api.approval.ApprovalDecisionType
- format(ApplicationUser, long) - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationService.DurationFormatter
-
Formats the duration into a friendly format
- formatShort(ApplicationUser, long) - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationService.DurationFormatter
-
Formats the duration into a short friendly format
- from(Iterable<T>, boolean) - Static method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
-
A builder of PagedResponse's that starts with the specified list
- fromSingle(boolean, T) - Static method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
-
A builder of PagedResponse's that starts with the single element
- fullName(String) - Method in interface com.atlassian.servicedesk.api.customer.CustomerCreateParameters.Builder
G
- getAllHitConditions(Project) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricConditionFactory
-
Get all conditions applicable for a given project
- getAllMatchConditions(Project) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricConditionFactory
-
Get all conditions applicable for a given project
- getAllowlist() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypePermission
-
Get the allowlist of permissions for this request type.
- getApprovalById(ApplicationUser, int) - Method in interface com.atlassian.servicedesk.api.approval.ApprovalService
-
Return an
Approval
for a givenapprovalId
orAnError
if: -user
does not have permission to viewissue
in customer portal context - Approval was not found for the givenapprovalId
- getApprovalCommentConfig(ApplicationUser, int) - Method in interface com.atlassian.servicedesk.api.approval.ApprovalService
-
Return an
ApprovalCommentConfig
for a givenapprovalId
orAnError
if: -user
does not have permission to viewissue
in customer portal context - Approval was not found for the givenapprovalId
- getApprovalCondition() - Method in interface com.atlassian.servicedesk.api.approval.Approval
-
Gets condition object which encapsulate type of condition and level of accomplishment
- getApprovals(ApplicationUser, ApprovalQuery) - Method in interface com.atlassian.servicedesk.api.approval.ApprovalService
-
Retrieve a page of
Approval
of a particularApprovalQuery
- getApproverDecision() - Method in interface com.atlassian.servicedesk.api.approval.Approver
-
Get decision of
Approver
- getApprovers(ApplicationUser, Approval) - Method in interface com.atlassian.servicedesk.api.approval.ApprovalService
-
Return a list of
Approver
for a givenapproval
- getApproverUser() - Method in interface com.atlassian.servicedesk.api.approval.Approver
-
Get
ApplicationUser
ofApprover
- getAttachmentContent() - Method in interface com.atlassian.servicedesk.spi.email.attachment.ServiceDeskEmailAttachmentMatcher.Attachment
-
A basic representation of the actual attachment content.
- getAttachments() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskComment
- getAvatarUrl() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeAllowedEntityDTO
- getBannerBackgroundColor() - Method in class com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext
-
Returns the banner background colour hexadecimal code.
- getBannerImageUrl() - Method in class com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext
-
Returns the banner background image relative URL.
- getBreached() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationCompletedCycle
- getBreached() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationOngoingCycle
- getBreachTime() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationOngoingCycle
- getBugFixVersion() - Method in interface com.atlassian.servicedesk.api.info.Version
- getBuildChangeSet() - Method in interface com.atlassian.servicedesk.api.info.PublicSoftwareInfo
- getBuildDate() - Method in interface com.atlassian.servicedesk.api.info.PublicSoftwareInfo
- getButtonBackgroundColor() - Method in class com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext
-
Returns the button background colour hexadecimal code.
- getButtonTextColor() - Method in class com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext
-
Returns the button text colour hexadecimal code.
- getById(ApplicationUser, Integer) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
-
Gets customer organization by ID if user is an agent or a member of the organization.
- getChangeItemForField(String) - Method in interface com.atlassian.servicedesk.api.sla.event.SLAChangeEvent
-
One of the changes (multi valued field) of the given field in the event, if the given
fieldName
equals the name of one of theChangeItemBean
in the event the old and the new value do not equal (don't have the same value and are not both null) - getChangeItems() - Method in interface com.atlassian.servicedesk.api.sla.event.SLAChangeEvent
-
The changes that were made to the issue with the action that caused the event.
- getCheckedUser() - Method in interface com.atlassian.servicedesk.api.user.UserFactory
-
Helper method to wrap getCurrentUserByType[CheckedUser].
- getComment() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalComment
- getComment() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskComment
- getComment() - Method in interface com.atlassian.servicedesk.api.event.ServiceDeskCommentEvent
- getComment() - Method in interface com.atlassian.servicedesk.api.sla.event.SLAChangeEvent
-
The comment of the originating event or empty.
- getCommentsOfRequest(ApplicationUser, ServiceDeskCommentQuery) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentService
-
Retrieve a page of
ServiceDeskComment
of a particularCustomerRequest
- getCompletedCycles() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformation
- getCompletedDate() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalDecision
- getConditionType() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalCondition
- getConditionValue() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalCondition
- getContentId() - Method in interface com.atlassian.servicedesk.spi.email.attachment.ServiceDeskEmailAttachmentMatcher.Attachment
-
The content id of the attachment.
- getContentType() - Method in interface com.atlassian.servicedesk.spi.email.attachment.ServiceDeskEmailAttachmentMatcher.Attachment
-
The content type of the attachment.
- getCreatedDate() - Method in interface com.atlassian.servicedesk.api.approval.Approval
-
Creation date of
Approval
- getCustomerPortalLink() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackToken
-
Provide the URI that a customer can follow to view Request Feedback form for this issue in customer portal.
- getCustomerRequest(ApplicationUser, CustomerRequestIssueQuery) - Method in interface com.atlassian.servicedesk.api.request.ServiceDeskCustomerRequestService
-
Retrieve a
CustomerRequest
that matches the issueID - getCustomerRequestCreateMeta(ApplicationUser, RequestTypeFieldQuery) - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldService
-
Retrieve the
CustomerRequestCreateMeta
which can be used to create aCustomerRequest
. - getCustomerRequests(ApplicationUser, CustomerRequestQuery) - Method in interface com.atlassian.servicedesk.api.request.ServiceDeskCustomerRequestService
-
Retrieve a page of
CustomerRequest
that satisfies the query parameters - getCustomerRequestStatus(ApplicationUser, CustomerRequestStatusQuery) - Method in interface com.atlassian.servicedesk.api.request.ServiceDeskCustomerRequestService
-
Retrieve a page of
CustomerRequest.CustomerRequestStatus
of aCustomerRequest
by chronological order in which the status transition taken place - getCustomerRequestType(UncheckedUser, CustomerRequestTypeQuery) - Method in interface com.atlassian.servicedesk.api.request.type.CustomerRequestTypeService
-
Given a
CustomerRequestTypeQuery
andUncheckedUser
then return the custom field value representation, if the user has access to the Request Type. - getCustomerTransitions(ApplicationUser, CustomerTransitionQuery) - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionService
-
Retrieves a list of available
CustomerTransition
- getCustomFieldId() - Method in interface com.atlassian.servicedesk.api.sla.metrics.TimeMetric
-
Returns the id of the custom field corresponding to the time metric
- getDateTime() - Method in interface com.atlassian.servicedesk.api.sla.condition.MatchConditionHistory.Entry
-
Get the date of this entry
- getDbValue() - Method in enum class com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntityType
- getDbValue() - Method in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeRestrictionStatus
- getDecision() - Method in interface com.atlassian.servicedesk.api.approval.Approval
-
Gets the final decision (including the core outcome and associated details).
- getDecision() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalDecision
- getDescription() - Method in interface com.atlassian.servicedesk.api.portal.Portal
-
Description of the portal
- getDescription() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestType
-
Gets the description of the request type
- getDisplayChannelSource(ApplicationUser, CustomerRequestChannelSource) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestChannelSourceI18nService
- getDisplayName() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeAllowedEntityDTO
- getDisplayName() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntity
-
Get the display name of the entity that this permission applies to.
- getDisplayName() - Method in interface com.atlassian.servicedesk.api.user.CheckedUser
- getDurationFormatter() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationService
- getElapsedTime() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationCompletedCycle
- getElapsedTime() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationOngoingCycle
- getEmail() - Method in interface com.atlassian.servicedesk.api.customer.CustomerCreateParameters
- getEmailAddress() - Method in interface com.atlassian.servicedesk.api.user.CheckedUser
- getEntityId() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeAllowedEntityDTO
- getEntityType() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeAllowedEntityDTO
- getEntries() - Method in interface com.atlassian.servicedesk.api.sla.condition.MatchConditionHistory
-
Get all match history entries, sorted by date
- getExceptionMessages() - Method in exception com.atlassian.servicedesk.api.queue.QueueParametersValidationException
- getFeedbackQuestion() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackDetails
-
The question to ask when requesting feedback.
- getFeedbackScale() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackDetails
-
The scale to be used for providing feedback.
- getFields() - Method in interface com.atlassian.servicedesk.api.queue.Queue
- getFields() - Method in interface com.atlassian.servicedesk.api.queue.QueueCreateParameters
- getFields() - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters
- getFilename() - Method in interface com.atlassian.servicedesk.spi.email.attachment.ServiceDeskEmailAttachmentMatcher.Attachment
-
The filename of the attachment.
- getFilterHidden() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery
-
Limit results to request types that are not hidden (eg, have no groups)
- getFullName() - Method in interface com.atlassian.servicedesk.api.customer.CustomerCreateParameters
- getGoalDuration() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationCompletedCycle
- getGoalDuration() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationOngoingCycle
- getGroups() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestType
-
The
RequestTypeGroup
that thisRequestType
belongs to. - getHelpText() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestType
-
Get the help text which provides instruction on how to use the request type.
- getHistory(Issue, DateTime) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricHitCondition
-
Digs through issue history to reconstruct when the condition matched the issue.
- getHistory(Issue, DateTime) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricMatchCondition
-
Digs through issue history to reconstruct when the condition matched the issue.
- getHitCondition(String) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricConditionFactory
-
Get a condition by id.
- getHits() - Method in interface com.atlassian.servicedesk.api.sla.condition.HitConditionHistory
-
Get the list of hits, sorted by date.
- getIconId() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestType
-
The id of the icon associated with this request type.
- getId() - Method in interface com.atlassian.servicedesk.api.approval.Approval
-
Id of
Approval
- getId() - Method in interface com.atlassian.servicedesk.api.organization.CustomerOrganization
-
Get Id of
CustomerOrganization
- getId() - Method in interface com.atlassian.servicedesk.api.portal.Portal
-
Id of the Portal
- getId() - Method in interface com.atlassian.servicedesk.api.queue.Queue
- getId() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestType
-
Gets the id of the request type
- getId() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeGroup
- getId() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntity
-
Get the id of this permission entity.
- getId() - Method in interface com.atlassian.servicedesk.api.ServiceDesk
- getId() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformation
- getId() - Method in interface com.atlassian.servicedesk.api.sla.metrics.TimeMetric
-
Returns the id of the time metric
- getId() - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricHitCondition
-
Get the unique id for this condition
- getId() - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricMatchCondition
-
Get the unique id for this condition
- getInfo(ApplicationUser, SlaInformationQuery) - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationService
-
This will return information about an issue's SLAs based on the query parameters
- getIssue() - Method in interface com.atlassian.servicedesk.api.event.ServiceDeskCommentEvent
- getIssue() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackDetails
-
The issue that this token was requested for
- getIssue() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequest
-
The backing
Issue
of this request - getIssue() - Method in interface com.atlassian.servicedesk.api.sla.event.SLAChangeEvent
-
The issue that is involved in the originating event.
- getIssueCount() - Method in interface com.atlassian.servicedesk.api.queue.Queue
- getIssueId() - Method in interface com.atlassian.servicedesk.api.approval.Approval
-
Issue Id the
Approval
associated with - getIssueTypeId() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestType
-
Gets the id of the
IssueType
that is associated with this request type - getJql() - Method in interface com.atlassian.servicedesk.api.queue.Queue
- getJql() - Method in interface com.atlassian.servicedesk.api.queue.QueueCreateParameters
- getJql() - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters
- getKey() - Method in class com.atlassian.servicedesk.api.ExceptionMessage
- getKey() - Method in interface com.atlassian.servicedesk.api.user.CheckedUser
- getLicense() - Method in interface com.atlassian.servicedesk.api.license.ServiceDeskLicenseService
-
Gets the
ServiceDeskLicense
for instance - getLimit() - Method in interface com.atlassian.servicedesk.api.util.paging.LimitedPagedRequest
- getLimit() - Method in class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
- getLimit() - Method in interface com.atlassian.servicedesk.api.util.paging.PagedRequest
- getLimit() - Method in class com.atlassian.servicedesk.api.util.paging.SimplePagedRequest
- getLocale() - Method in interface com.atlassian.servicedesk.api.user.SDUser
- getLogoUrl() - Method in class com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext
-
Returns the global logo image relative URL.
- getMajorVersion() - Method in interface com.atlassian.servicedesk.api.info.Version
- getMatchCondition(String) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricConditionFactory
-
Get a condition by id.
- getMatchEvent() - Method in interface com.atlassian.servicedesk.api.sla.condition.MatchConditionHistory.Entry
-
Get the match event of this entry
- getMaxLimit() - Method in interface com.atlassian.servicedesk.api.util.paging.LimitedPagedRequest
- getMaxLimit() - Method in class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
- getMessage() - Method in class com.atlassian.servicedesk.api.ExceptionMessage
- getMessage() - Method in exception com.atlassian.servicedesk.api.ServiceDeskServiceException
- getMessageKey() - Method in exception com.atlassian.servicedesk.api.ServiceDeskServiceException
- getMinorVersion() - Method in interface com.atlassian.servicedesk.api.info.Version
- getName() - Method in interface com.atlassian.servicedesk.api.approval.Approval
-
Name of
Approval
- getName() - Method in interface com.atlassian.servicedesk.api.organization.CustomerOrganization
-
Get name of
CustomerOrganization
- getName() - Method in interface com.atlassian.servicedesk.api.portal.Portal
-
Name of the portal
- getName() - Method in interface com.atlassian.servicedesk.api.queue.Queue
- getName() - Method in interface com.atlassian.servicedesk.api.queue.QueueCreateParameters
- getName() - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters
- getName() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestType
-
Gets name of the request type
- getName() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeGroup
- getName() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformation
- getName() - Method in interface com.atlassian.servicedesk.api.sla.metrics.TimeMetric
-
Returns the name of the time metric
- getName() - Method in interface com.atlassian.servicedesk.api.user.CheckedUser
- getName(I18nHelper) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricCondition
-
Get the name of this condition
- getNameHtml(I18nHelper) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricHitCondition
-
Get the name of this condition
- getNameHtml(I18nHelper) - Method in interface com.atlassian.servicedesk.spi.sla.condition.TimeMetricMatchCondition
-
Get the name of this condition
- getOngoingCycle() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformation
- getOrder() - Method in interface com.atlassian.servicedesk.api.queue.QueueCreateParameters
- getOrder() - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters
- getOrder() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeGroup
- getOrganizations(ApplicationUser, OrganizationsQuery) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
-
Returns a list of organizations in the Jira instance based on query parameters.
- getOriginalTransitionName() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransition
-
Title of the underlying transition
- getOverrideTransitionName() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransition
-
Configured title override.
- getOverrideTransitionSubmitName() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransition
-
Configured submit name override.
- getPagedRequest() - Method in interface com.atlassian.servicedesk.api.util.paging.PagedResponse
- getPagedRequest() - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
- getPasswordResetPageUrl() - Method in class com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext
-
Returns the relative URL to the forgot password page when supported.
- getPaused() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationOngoingCycle
- getPermissionEntityId() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntity
-
Get the id of the entity that this permission applies to.
- getPermissionEntityType() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntity
-
Get the type of entity that this permission applies to.
- getPlatformVersion() - Method in interface com.atlassian.servicedesk.api.info.PublicSoftwareInfo
- getPortalForId(int) - Method in interface com.atlassian.servicedesk.api.portal.PortalManager
-
Returns the
Portal
associated with the given portal id. - getPortalForId(ApplicationUser, int) - Method in interface com.atlassian.servicedesk.api.portal.PortalService
-
Returns the
Portal
associated with the given portal id. - getPortalForProject(Project) - Method in interface com.atlassian.servicedesk.api.portal.PortalManager
-
Returns
Portal
associated with the givenProject
. - getPortalForProject(ApplicationUser, Project) - Method in interface com.atlassian.servicedesk.api.portal.PortalService
-
Returns the
Portal
associated with the givenProject
. - getPortalForServiceDesk(ApplicationUser, ServiceDesk) - Method in interface com.atlassian.servicedesk.api.portal.PortalService
-
Returns the
Portal
associated with the givenServiceDesk
. - getPortalForServiceDesk(ServiceDesk) - Method in interface com.atlassian.servicedesk.api.portal.PortalManager
-
Returns the
Portal
associated with the givenServiceDesk
. - getPortalId() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestType
-
Gets the id of the portal that this request type belongs to
- getPortalLoginAnnouncementMessage() - Method in class com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext
-
Returns the portal login announcement message enriched with HTML.
- getPortalLoginAnnouncementSubject() - Method in class com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext
-
Returns the portal login announcement subject enriched with HTML.
- getPortalLoginPageDataContext(HttpServletRequest) - Method in interface com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContextProvider
-
Returns a populated CustomerPortalLoginPageDataContext object depending on the HttpServletRequest provided.
- getPortals(ApplicationUser, PagedRequest) - Method in interface com.atlassian.servicedesk.api.portal.PortalService
-
Return a
PagedResponse
of all of the portals - getPortals(PagedRequest) - Method in interface com.atlassian.servicedesk.api.portal.PortalManager
-
Return a
PagedResponse
of all of the portals - getProject() - Method in interface com.atlassian.servicedesk.api.sla.event.SLAChangeEvent
-
The project the originating event published in.
- getProjectId() - Method in interface com.atlassian.servicedesk.api.ServiceDesk
- getProjectName() - Method in interface com.atlassian.servicedesk.api.ServiceDesk
- getPropertyName() - Method in class com.atlassian.servicedesk.api.util.expansion.Expansion
- getQualifier() - Method in interface com.atlassian.servicedesk.api.info.Version
- getQueueId() - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters
- getQueueLimitForProject() - Method in interface com.atlassian.servicedesk.api.queue.QueueService
-
Gets the maximum number of queues allowed for a project
- getQueues(ApplicationUser, QueueQuery) - Method in interface com.atlassian.servicedesk.api.queue.QueueService
-
Get a page of
Queue
that satisfies the providedQueueQuery
. - getRecipient() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackDetails
-
The recipient that this token was requested for, who must also be the reporter of the issue
- getRemainingTime() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationCompletedCycle
- getRemainingTime() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationOngoingCycle
- getRenderedName() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestChannelSourceI18nService.CustomerRequestChannelRenderedName
-
Display name of the channel source
- getRequestFeedbackDetails(ApplicationUser, Issue) - Method in interface com.atlassian.servicedesk.api.feedback.RequestFeedbackDetailsService
-
For a given user and issue, will return the details required for Request Feedback, if: Provided user is the reporter of the provided issue The issue is a valid request in a service project Request Feedback is enabled for the Issue
- getRequestFeedbackToken() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackDetails
-
The token details required to be able to add feedback on this request
- getRequestParticipants(ApplicationUser, RequestParticipantQuery) - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantService
-
Get a page of
ApplicationUser
who satisfy the query parameters - getRequestsByQueue(ApplicationUser, QueueRequestQuery) - Method in interface com.atlassian.servicedesk.api.queue.QueueService
-
Get a page of
Issue
belonging to the specifiedQueue
- getRequestTypeId() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequest
-
ID of the
RequestType
of this request - getRequestTypeId() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypePermission
-
Get the id of the request type that these permissions apply to.
- getRequestTypePermission(int) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypePermissionService
-
Get the permissions for a request type.
- getRequestTypes(ApplicationUser, RequestTypeQuery) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeService
-
Retrieve a list of
RequestType
that satisfy the query parameters. - getResolutionId() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransition
-
Id of the underlying transition
- getRestrictedInfo() - Method in interface com.atlassian.servicedesk.api.info.PublicSoftwareInfo
- getRestrictionStatus() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestType
-
Gets the restriction status(
RequestTypeRestrictionStatus
) of the request type which is default toRequestTypeRestrictionStatus.OPEN
for backward compatibility. - getRestrictionStatusFilter() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery
-
Limit results to request types that match the restriction status filter.
- getResults() - Method in interface com.atlassian.servicedesk.api.util.paging.PagedResponse
- getResults() - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
- getServiceDeskById(int) - Method in interface com.atlassian.servicedesk.api.ServiceDeskManager
-
Retrieve a
ServiceDesk
by its ID - getServiceDeskById(ApplicationUser, int) - Method in interface com.atlassian.servicedesk.api.ServiceDeskService
-
Retrieve a
ServiceDesk
by its ID - getServiceDeskCommentById(ApplicationUser, Long) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentService
-
Gets a
ServiceDeskComment
from a comment id. - getServiceDeskCommentByJiraComment(ApplicationUser, Comment) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentService
-
Gets a
ServiceDeskComment
from an associatedComment
. - getServiceDeskForPortal(ApplicationUser, Portal) - Method in interface com.atlassian.servicedesk.api.ServiceDeskService
-
Returns the
ServiceDesk
associated with the givenPortal
- getServiceDeskForPortal(Portal) - Method in interface com.atlassian.servicedesk.api.ServiceDeskManager
-
Returns the
ServiceDesk
associated with the givenPortal
- getServiceDeskForProject(Project) - Method in interface com.atlassian.servicedesk.api.ServiceDeskManager
-
Returns the
ServiceDesk
associated with the givenProject
- getServiceDeskForProject(ApplicationUser, Project) - Method in interface com.atlassian.servicedesk.api.ServiceDeskService
-
Returns the
ServiceDesk
associated with the givenProject
- getServiceDeskId() - Method in interface com.atlassian.servicedesk.api.event.ServiceDeskDeletedEvent
- getServiceDeskId() - Method in interface com.atlassian.servicedesk.api.queue.Queue
- getServiceDeskId() - Method in interface com.atlassian.servicedesk.api.queue.QueueCreateParameters
- getServiceDeskId() - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters
- getServiceDeskId() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequest
-
ID of the parent
ServiceDesk
of this request - getServiceDesks(ApplicationUser, boolean, PagedRequest) - Method in interface com.atlassian.servicedesk.api.ServiceDeskService
-
Returns a list of service projects a user can view, with an option to include archived service projects.
- getServiceDesks(ApplicationUser, PagedRequest) - Method in interface com.atlassian.servicedesk.api.ServiceDeskService
-
Returns a list of service projects a user can view.
- getSignUpPageUrl() - Method in class com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext
-
Returns the relative URL to the sign up page when sign up is enabled.
- getSoftwareInfo(ApplicationUser) - Method in interface com.atlassian.servicedesk.api.info.ServiceDeskSoftwareInfoService
-
Returns Jira Service Management software information
- getStart() - Method in interface com.atlassian.servicedesk.api.util.paging.LimitedPagedRequest
-
Index of the first item to include in the result set.
- getStart() - Method in class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
- getStart() - Method in interface com.atlassian.servicedesk.api.util.paging.PagedRequest
- getStart() - Method in class com.atlassian.servicedesk.api.util.paging.SimplePagedRequest
- getStartTime() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationCompletedCycle
- getStartTime() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationOngoingCycle
- getStatus() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeAllowedEntityDTO
- getStatusId() - Method in interface com.atlassian.servicedesk.api.approval.Approval
-
The workflow status Id associated with
Approval
- getStopTime() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationCompletedCycle
- getSubExpansions() - Method in class com.atlassian.servicedesk.api.util.expansion.Expansion
- getSubExpansions(String) - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
- getTemporaryAttachmentIds() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalComment
- getTime() - Method in interface com.atlassian.servicedesk.api.event.ServiceDeskCommentEvent
-
Time the event was created.
- getTime() - Method in interface com.atlassian.servicedesk.api.sla.event.SLAChangeEvent
-
The created time of the originating event.
- getTimeMetric(ApplicationUser, ServiceDesk, int) - Method in interface com.atlassian.servicedesk.api.sla.metrics.TimeMetricService
-
Returns a time metric within a service project given its id
- getTimeMetrics(ApplicationUser, ServiceDesk) - Method in interface com.atlassian.servicedesk.api.sla.metrics.TimeMetricService
-
Returns all the time metrics defined for a service project
- getToken() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackToken
-
The existing or newly generated token for this request feedback
- getToolTip() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestChannelSourceI18nService.CustomerRequestChannelRenderedName
-
Tooltip of the channel source
- getTransitionId() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransition
-
Id of the underlying transition
- getTransitionName() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransition
-
Transition title to be displayed to the customer.
- getTransitionSubmitName() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransition
-
Submit name to be displayed to the customer.
- getUncheckedUser() - Method in interface com.atlassian.servicedesk.api.user.UserFactory
-
Helper method to wrap getCurrentUserByType[UncheckedUser].
- getUnsubscribeCustomerNotificationUri(CheckedUser, Issue) - Method in interface com.atlassian.servicedesk.api.notification.CustomerNotificationSubscriptionService
-
Provides a URL that can be included in any customer email notifications.
- getUser() - Method in interface com.atlassian.servicedesk.api.event.ServiceDeskCommentEvent
- getUsersInOrganization(ApplicationUser, UsersInOrganizationQuery) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
-
Gets all the applicationUsers in a given organization.
- getValue() - Method in interface com.atlassian.servicedesk.api.request.type.CustomerRequestType
-
The String representation for Customer Request Type custom field value
- getVersion() - Method in interface com.atlassian.servicedesk.api.info.PublicSoftwareInfo
- getWithinCalendarHours() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationOngoingCycle
- group() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery
-
Limit results to request types that belong to the specified
RequestTypeGroup
id - group(Integer) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery.Builder
-
Limit results to request types that belong to the specified
RequestTypeGroup
id - GROUP - Enum constant in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_OWNERSHIP
- GROUP - Enum constant in enum class com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntityType
- groupIds() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters
-
Optional list of group ids for this
RequestType
- groupVisibility() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters
- groupVisibility(String) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters.Builder
H
- hasAgentLicense(ApplicationUser) - Method in interface com.atlassian.servicedesk.api.license.ServiceDeskLicenseService
-
Checks whether the user has an agent license for instance.
- hashCode() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackDetails
- hashCode() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackToken
- hashCode() - Method in class com.atlassian.servicedesk.api.field.FieldId
- hashCode() - Method in class com.atlassian.servicedesk.api.field.FieldInputValue
- hashCode() - Method in class com.atlassian.servicedesk.api.request.CustomerRequestChannelSource
- hashCode() - Method in class com.atlassian.servicedesk.api.util.expansion.Expansion
- hashCode() - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
- hashCode() - Method in class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
- hasMore(boolean) - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl.Builder
- hasNextPage() - Method in interface com.atlassian.servicedesk.api.util.paging.PagedResponse
-
Indicates whether the source has more results after this page.
- hasNextPage() - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
- helpText() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters
-
Optional help text of this
RequestType
. - helpText() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeUpdateParameters
-
Optional help text of this
RequestType
. - helpText(String) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters.Builder
- helpText(String) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeUpdateParameters.Builder
- HIT - Enum constant in enum class com.atlassian.servicedesk.api.sla.condition.HitEvent
-
The issue/event got a Hit on this evaluation.
- HitConditionHistory - Interface in com.atlassian.servicedesk.api.sla.condition
-
Hit history returned by a hit condition
- HitConditionHistoryBuilder - Class in com.atlassian.servicedesk.api.sla.condition
-
Builder for HitConditionHistory objects.
- HitEvent - Enum Class in com.atlassian.servicedesk.api.sla.condition
-
Event returned by a HitCondition
I
- i18NHelper() - Method in interface com.atlassian.servicedesk.api.user.SDUser
- iconId() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters
-
Optional iconId for this
RequestType
- iconId(Long) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters.Builder
- id() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery
- id(Integer) - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery.Builder
- includeIssueCount() - Method in interface com.atlassian.servicedesk.api.queue.QueueQuery
-
Whether to include the number of issue belonging to
Queue
. - includeIssueCount(boolean) - Method in interface com.atlassian.servicedesk.api.queue.QueueQuery.Builder
-
Set whether to include issue count for the returned queues or not.
- initCustomerContext(boolean) - Method in interface com.atlassian.servicedesk.api.customer.CustomerContextService
-
To be executed in order to begin a customer context from a request.
- internalComment() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentQuery
- internalComment(Boolean) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentQuery.Builder
- INVERSE_MATCH - Enum constant in enum class com.atlassian.servicedesk.api.sla.condition.MatchEvent
-
The issue currently does not match the given condition
- isAdminAgent(ApplicationUser, ServiceDesk) - Method in interface com.atlassian.servicedesk.api.permission.ServiceDeskPermissionService
-
Checks whether the user is an agent with project admin permission.
- isAgent(ApplicationUser, ServiceDesk) - Method in interface com.atlassian.servicedesk.api.permission.ServiceDeskPermissionService
-
Checks whether the user is an agent for the given service project.
- isAnonymous() - Method in interface com.atlassian.servicedesk.api.user.SDUser
- isCommentPublic() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalComment
-
Gets whether the comment is public or private.
- isCommentsRequiredWhenApprove() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalCommentConfig
- isCommentsRequiredWhenDecline() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalCommentConfig
- isCreatedEvent() - Method in interface com.atlassian.servicedesk.api.event.ServiceDeskCommentEvent
-
true, if the comment event is thrown during a comment creation.
- isCustomer(ApplicationUser, Issue) - Method in interface com.atlassian.servicedesk.api.permission.ServiceDeskPermissionService
-
Checks whether the
ApplicationUser
is a customer for the givencom.atlassian.servicedesk.api.request
. - isCustomer(ApplicationUser, CustomerRequest) - Method in interface com.atlassian.servicedesk.api.permission.ServiceDeskPermissionService
-
Checks whether the
ApplicationUser
is a customer for the givencom.atlassian.servicedesk.api.request
. - isCustomerVisible() - Method in interface com.atlassian.servicedesk.api.sla.metrics.TimeMetric
- isEmpty() - Method in interface com.atlassian.servicedesk.api.sla.condition.HitConditionHistory
-
Is the history empty
- isEmpty() - Method in class com.atlassian.servicedesk.api.sla.condition.HitConditionHistoryBuilder
-
Is the history currently empty
- isEmpty() - Method in interface com.atlassian.servicedesk.api.sla.condition.MatchConditionHistory
-
Is the history empty?
- isEmpty() - Method in class com.atlassian.servicedesk.api.sla.condition.MatchConditionHistoryBuilder
-
Is the history currently empty
- isEmpty() - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
- isGreaterThan(Version) - Method in interface com.atlassian.servicedesk.api.info.Version
-
Returns true if this version is greater than the specified version
- isGreaterThanOrEqualTo(Version) - Method in interface com.atlassian.servicedesk.api.info.Version
-
Returns true if this version is greater than if equal to the specified version
- isInCustomerContext() - Method in interface com.atlassian.servicedesk.api.customer.CustomerContextService
- isInverseMatch() - Method in enum class com.atlassian.servicedesk.api.sla.condition.MatchEvent
- isIssueCreatedEvent() - Method in interface com.atlassian.servicedesk.api.sla.event.SLAChangeEvent
-
Returns if the originating event is a issue created event.
- isLessThan(Version) - Method in interface com.atlassian.servicedesk.api.info.Version
-
Returns true if this version is less than the specified version
- isLessThanOrEqualTo(Version) - Method in interface com.atlassian.servicedesk.api.info.Version
-
Returns true if this version is less than or equal to the specified version
- isLicensedForUse() - Method in interface com.atlassian.servicedesk.api.info.PublicSoftwareInfo
- isLicenseValid() - Method in interface com.atlassian.servicedesk.api.license.ServiceDeskLicense
-
Is the license valid
- isMatch() - Method in enum class com.atlassian.servicedesk.api.sla.condition.MatchEvent
- isPartOfIssueChange() - Method in interface com.atlassian.servicedesk.api.event.ServiceDeskCommentEvent
-
true, if the comment event is part of an issue edit/bulk edit operation (at least one of the issue fields changed).
- isPublic() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskComment
-
Gets whether the comment is public or private.
- isSendMail() - Method in interface com.atlassian.servicedesk.api.event.ServiceDeskCommentEvent
-
true, if an email should be send because of this event.
- isSubscribedCustomerNotifications(CheckedUser, Issue) - Method in interface com.atlassian.servicedesk.api.notification.CustomerNotificationSubscriptionService
-
Given a user and issue, return whether user should be sent new customer notifcations.
- issue() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalQuery
-
This is currently the only supported query param for
ApprovalQuery
- issue() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters
- issue() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentQuery
- issue() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestIssueQuery
-
Retrieval of the
CustomerRequest
backed by thisIssue
. - issue() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestStatusQuery
-
ID of the backing
Issue
of theCustomerRequest
- issue() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestUpdateParameters
-
The
CustomerRequest
being updated, backed by thisIssue
- issue() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionQuery
-
The backing
Issue
id of theCustomerRequest
- issue() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery
-
Retrieve a specific
RequestType
associated to the customer request backed by thisIssue
, if any. - issue() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery
-
The issue id is always required to query SLA information
- issue(long) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestIssueQuery.Builder
- issue(long) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestStatusQuery.Builder
- issue(Issue) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters.Builder
- issue(Issue) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentQuery.Builder
- issue(Issue) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestUpdateParameters.Builder
- issue(Long) - Method in interface com.atlassian.servicedesk.api.approval.ApprovalQuery.Builder
- issue(Long) - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionQuery.Builder
- issue(Long) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery.Builder
-
Retrieve a specific
RequestType
associated to the customer request backed by thisIssue
, if any. - issue(Long) - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery.Builder
-
Deprecated.
- issueObject() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery
-
The issue object is recommended to query SLA information
- issueObject(Issue) - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery.Builder
-
IssueObject is used to query SLA information.
- issueType() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters
-
The underlying
IssueType
of thisRequestType
. - issueType(IssueType) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters.Builder
- isSystemDecided() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalDecision
- isValid() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery
-
Limit results to only request types that are valid.
- isValid(Boolean) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery.Builder
-
Limit results to only request types that are valid.
- iterator() - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
J
- JIRA - Static variable in class com.atlassian.servicedesk.api.request.CustomerRequestChannelSource
-
Source channel from which
Issue
's are created via JIRA - jql(String) - Method in interface com.atlassian.servicedesk.api.queue.QueueCreateParameters.Builder
- jql(String) - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters.Builder
L
- label() - Method in class com.atlassian.servicedesk.api.field.impl.RequestTypeFieldValueImpl
- label() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldValue
-
The display of this field value
- label(String) - Method in class com.atlassian.servicedesk.api.field.impl.RequestTypeFieldValueImpl.BuilderImpl
- label(String) - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldValue.Builder
- LimitedPagedRequest - Interface in com.atlassian.servicedesk.api.util.paging
-
A
PagedRequest
guaranteed to have a limit capped to a developer provided value rather than a user provided value. - LimitedPagedRequestImpl - Class in com.atlassian.servicedesk.api.util.paging
- LimitedPagedRequestImpl(int, int, int) - Constructor for class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
- LimitedPagedRequestImpl(PagedRequest, int) - Constructor for class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
M
- map(Function<T, M>) - Method in interface com.atlassian.servicedesk.api.util.paging.PagedResponse
-
Allows you to map a paged response of T into M
- map(Function<T, M>) - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
- MATCH - Enum constant in enum class com.atlassian.servicedesk.api.sla.condition.MatchEvent
-
The issue currently matches the given condition
- MatchConditionHistory - Interface in com.atlassian.servicedesk.api.sla.condition
-
Match history returned by a match condition.
- MatchConditionHistory.Entry - Interface in com.atlassian.servicedesk.api.sla.condition
-
History entry.
- MatchConditionHistoryBuilder - Class in com.atlassian.servicedesk.api.sla.condition
-
Reconstructed history data for the given condition
- MatchEvent - Enum Class in com.atlassian.servicedesk.api.sla.condition
-
Event returned by match conditions
- MAX_COMMENT_RETURNED - Static variable in class com.atlassian.servicedesk.api.util.paging.DefaultPagingLimits
-
The maximum number of comments that will ever be returned
- MAX_CUSTOMER_REQUEST_RETURNED - Static variable in class com.atlassian.servicedesk.api.util.paging.DefaultPagingLimits
-
The maximum number of customer request entries that will ever be returned
- MAX_CUSTOMER_REQUEST_STATUS_RETURNED - Static variable in class com.atlassian.servicedesk.api.util.paging.DefaultPagingLimits
-
The maximum number of customer request status entries that will ever be returned
- MAX_CUSTOMER_REQUEST_TRANSITIONS_RETURNED - Static variable in class com.atlassian.servicedesk.api.util.paging.DefaultPagingLimits
-
The maximum number of customer request transitions entries that will ever be returned
- MAX_GENERAL_THINGS_RETURNED - Static variable in class com.atlassian.servicedesk.api.util.paging.DefaultPagingLimits
-
The maximum number of general entries that will ever by returned
- MAX_PARTICIPANTS_RETURNED - Static variable in class com.atlassian.servicedesk.api.util.paging.DefaultPagingLimits
-
The maximum number of request participant entries that will ever be returned
- MAX_REQUEST_TYPES_RETURNED - Static variable in class com.atlassian.servicedesk.api.util.paging.DefaultPagingLimits
-
The maximum number of requesttypes entries that will ever be returned
- MAX_SERVICE_DESKS_RETURNED - Static variable in class com.atlassian.servicedesk.api.util.paging.DefaultPagingLimits
-
The maximum number of service project entries that will ever be returned
- merge(Expansion[]) - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
- merge(Expansions) - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
- migrateExistingProject(ApplicationUser, MigrateProjectParameters) - Method in interface com.atlassian.servicedesk.api.project.creation.ServiceDeskCreationService
-
Migrates an existing project to be a service project.
- MigrateProjectParameters - Interface in com.atlassian.servicedesk.api.project.creation
- MigrateProjectParameters.Builder - Interface in com.atlassian.servicedesk.api.project.creation
-
Builder to construct the
MigrateProjectParameters
- migrateProjectParametersBuilder() - Method in interface com.atlassian.servicedesk.api.project.creation.ServiceDeskCreationService
-
Create a
MigrateProjectParameters.Builder
N
- name() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeField
-
Display name of the field as per
RequestType
basic - name() - Method in interface com.atlassian.servicedesk.api.organization.CreateOrganizationParameters
- name() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters
-
Name of this
RequestType
. - name() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeUpdateParameters
-
Name of this
RequestType
. - name(String) - Method in interface com.atlassian.servicedesk.api.organization.CreateOrganizationParameters.Builder
- name(String) - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters.Builder
- name(String) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters.Builder
- name(String) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeUpdateParameters.Builder
- newBuilder() - Static method in class com.atlassian.servicedesk.api.sla.condition.HitConditionHistoryBuilder
-
Create a new HitConditionHistoryBuilder.
- newBuilder() - Static method in class com.atlassian.servicedesk.api.sla.condition.MatchConditionHistoryBuilder
-
Create a new builder for a match history
- newCreateBuilder() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentService
-
Return a new
ServiceDeskCommentCreateParameters.Builder
to build parameter to create comments - newCreateBuilder() - Method in interface com.atlassian.servicedesk.api.customer.CustomerService
-
Returns a new
CustomerCreateParameters.Builder
to buildCustomerCreateParameters
- newCreateBuilder() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
-
Returns a new
CreateOrganizationParameters.Builder
to buildCreateOrganizationParameters
- newCreateBuilder() - Method in interface com.atlassian.servicedesk.api.request.ServiceDeskCustomerRequestService
-
Create a builder to build
CustomerRequestCreateParameters
- newCreateBuilder() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeService
- newDeleteBuilder() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeService
- newExecuteParameterBuilder() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionService
- newInfoQueryBuilder() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationService
-
Create a builder to build
SlaInformationQuery
s - newIssueQueryBuilder() - Method in interface com.atlassian.servicedesk.api.request.ServiceDeskCustomerRequestService
-
Get the builder to build
CustomerRequestIssueQuery
- newOrganizationServiceDeskUpdateParametersBuilder() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
- newOrganizationsQueryBuilder() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
- newQueryBuilder() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalService
- newQueryBuilder() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentService
- newQueryBuilder() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldService
-
Create a builder to build
RequestTypeFieldQuery
- newQueryBuilder() - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantService
- newQueryBuilder() - Method in interface com.atlassian.servicedesk.api.request.ServiceDeskCustomerRequestService
-
Get the builder to build
CustomerRequestQuery
- newQueryBuilder() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionService
- newQueryBuilder() - Method in interface com.atlassian.servicedesk.api.request.type.CustomerRequestTypeService
-
Create a builder to build
CustomerRequestTypeQuery
- newQueryBuilder() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeService
- newQueueCreateParameterBuilder(int, String) - Method in interface com.atlassian.servicedesk.api.queue.QueueService
-
Get a new QueueCreateParameters builder.
- newQueueQueryBuilder() - Method in interface com.atlassian.servicedesk.api.queue.QueueService
- newQueueRequestQueryBuilder() - Method in interface com.atlassian.servicedesk.api.queue.QueueService
- newQueueUpdateParameterBuilder(int, int) - Method in interface com.atlassian.servicedesk.api.queue.QueueService
-
Get a new QueueUpdateParameters builder.
- newStatusQueryBuilder() - Method in interface com.atlassian.servicedesk.api.request.ServiceDeskCustomerRequestService
-
Create a builder to build
CustomerRequestStatusQuery
- newUpdateBuilder() - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantService
- newUpdateBuilder() - Method in interface com.atlassian.servicedesk.api.request.ServiceDeskCustomerRequestService
-
Create a builder to build
CustomerRequestUpdateParameters
- newUpdateBuilder() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeService
- newUsersInOrganizationQuery() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
- newUsersOrganizationUpdateParametersBuilder() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
- NO_HIT - Enum constant in enum class com.atlassian.servicedesk.api.sla.condition.HitEvent
-
The issue/event got a Hit on this evaluation.
- NoExceptionsCallable<V> - Interface in com.atlassian.servicedesk.api.customer
-
Callable replacement that doesn't throw checked Exceptions
- NoSuchEntityException - Exception in com.atlassian.servicedesk.api
-
A generic exception thrown by Jira Service Management when an Entity required for an operation can't be found
- NoSuchEntityException(ExceptionMessage) - Constructor for exception com.atlassian.servicedesk.api.NoSuchEntityException
- NoSuchEntityException(ExceptionMessage, Throwable) - Constructor for exception com.atlassian.servicedesk.api.NoSuchEntityException
O
- ONE - Static variable in class com.atlassian.servicedesk.api.util.paging.SimplePagedRequest
-
A page request of 1 thing
- OPEN - Enum constant in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeRestrictionStatus
-
The request type is open to all customers.
- OPEN_REQUESTS - Enum constant in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_STATUS
- order(int) - Method in interface com.atlassian.servicedesk.api.queue.QueueCreateParameters.Builder
- order(int) - Method in interface com.atlassian.servicedesk.api.queue.QueueUpdateParameters.Builder
- organization() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationServiceDeskUpdateParameters
- organization() - Method in interface com.atlassian.servicedesk.api.organization.UsersInOrganizationQuery
-
To query for a specified
CustomerOrganization
- organization() - Method in interface com.atlassian.servicedesk.api.organization.UsersOrganizationUpdateParameters
- organization(CustomerOrganization) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationServiceDeskUpdateParameters.Builder
- organization(CustomerOrganization) - Method in interface com.atlassian.servicedesk.api.organization.UsersOrganizationUpdateParameters.Builder
- ORGANIZATION - Enum constant in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_OWNERSHIP
- ORGANIZATION - Enum constant in enum class com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntityType
- OrganizationService - Interface in com.atlassian.servicedesk.api.organization
- OrganizationServiceDeskUpdateParameters - Interface in com.atlassian.servicedesk.api.organization
- OrganizationServiceDeskUpdateParameters.Builder - Interface in com.atlassian.servicedesk.api.organization
-
Builder to construct the
OrganizationServiceDeskUpdateParameters
. - OrganizationsQuery - Interface in com.atlassian.servicedesk.api.organization
-
Information supplied to
OrganizationService.getOrganizations(com.atlassian.jira.user.ApplicationUser, com.atlassian.servicedesk.api.organization.OrganizationsQuery)
to query for organizations - OrganizationsQuery.Builder - Interface in com.atlassian.servicedesk.api.organization
- overrideSecurity() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestIssueQuery
-
Use this to retrieve a
CustomerRequest
without checking the permission of the user executing this request - overrideSecurity() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery.Builder
- overrideSecurity() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery
-
Use this to retrieve SLA data ignoring the permissions of the requesting user
- overrideSecurity(boolean) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestIssueQuery.Builder
- OWNED_REQUESTS - Enum constant in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_OWNERSHIP
P
- paged(int, int) - Static method in class com.atlassian.servicedesk.api.util.paging.SimplePagedRequest
-
A page request of the specified start and limit
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.approval.ApprovalQuery
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentQuery
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationsQuery
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.organization.UsersInOrganizationQuery
-
To query a page
LimitedPagedRequest
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.queue.QueueQuery
-
Pagination control.
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.queue.QueueRequestQuery
-
Pagination parameter
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery
-
To request a page of
CustomerRequest
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestStatusQuery
-
To request a page of
CustomerRequest.CustomerRequestStatus
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantQuery
-
Pagination query
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionQuery
-
To request a page of
CustomerTransition
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery
-
To query a page
LimitedPagedRequest
ofRequestType
- pagedRequest() - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.approval.ApprovalQuery.Builder
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentQuery.Builder
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationsQuery.Builder
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.organization.UsersInOrganizationQuery.Builder
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.queue.QueueQuery.Builder
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.queue.QueueRequestQuery.Builder
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery.Builder
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestStatusQuery.Builder
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantQuery.Builder
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionQuery.Builder
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery.Builder
-
To query a page
PagedRequest
ofRequestType
- pagedRequest(PagedRequest) - Method in interface com.atlassian.servicedesk.api.sla.info.SlaInformationQuery.Builder
- PagedRequest - Interface in com.atlassian.servicedesk.api.util.paging
-
Specifies the pagination requirements of a request.
- PagedResponse<T> - Interface in com.atlassian.servicedesk.api.util.paging
-
A response to a paged request, used in pagination.
- PagedResponseImpl<T> - Class in com.atlassian.servicedesk.api.util.paging
-
A wrapper around a list of content.
- PagedResponseImpl(PagedResponseImpl.Builder<T>) - Constructor for class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
- PagedResponseImpl.Builder<T> - Class in com.atlassian.servicedesk.api.util.paging
-
Builds PagedResponse's of T
- pageRequest(LimitedPagedRequest) - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl.Builder
- pageRequest(PagedRequest) - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl.Builder
- parse(String) - Static method in class com.atlassian.servicedesk.api.util.expansion.ExpansionsParser
-
Converts a string representation of a collection of Expansions back into an
Expansion
array. - parse(String...) - Static method in class com.atlassian.servicedesk.api.util.expansion.ExpansionsParser
- parseAsExpansions(String) - Static method in class com.atlassian.servicedesk.api.util.expansion.ExpansionsParser
-
Converts a string representation of a collection of
Expansions
into an Expansions instance. - parseAsExpansions(List<String>) - Static method in class com.atlassian.servicedesk.api.util.expansion.ExpansionsParser
-
Converts list of string representations of
Expansion
s into an Expansions instance. - parseSingle(String) - Static method in class com.atlassian.servicedesk.api.util.expansion.ExpansionsParser
-
Converts a string representation of a single Expansion back into an Expansion.
- parseWithPrefix(String, String) - Static method in class com.atlassian.servicedesk.api.util.expansion.ExpansionsParser
- PARTICIPATED_REQUESTS - Enum constant in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_OWNERSHIP
- Portal - Interface in com.atlassian.servicedesk.api.portal
- PORTAL - Static variable in class com.atlassian.servicedesk.api.request.CustomerRequestChannelSource
-
Source channel from which
CustomerRequest
s are created on a service project's customer portal - PortalLoginPageDataContext - Class in com.atlassian.servicedesk.api.portal.login
-
An object that represents the data context useful to display the login page in the customer portal.
- PortalLoginPageDataContext(String, String, String, String, String, String, String, String, String) - Constructor for class com.atlassian.servicedesk.api.portal.login.PortalLoginPageDataContext
- PortalLoginPageDataContextProvider - Interface in com.atlassian.servicedesk.api.portal.login
-
Provides a populated
PortalLoginPageDataContext
object useful to display the login page in the customer portal. - PortalManager - Interface in com.atlassian.servicedesk.api.portal
-
Provides access to
Portal
objects without permission checks. - PortalService - Interface in com.atlassian.servicedesk.api.portal
-
Provides access to
Portal
objects. - prepend(String) - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
-
Create a new Expansions that prepends the propertyName to the path of all expansions represented in this Expansions object.
- project() - Method in interface com.atlassian.servicedesk.api.project.creation.MigrateProjectParameters
-
The project
Project
to create a service project on - project(Project) - Method in interface com.atlassian.servicedesk.api.project.creation.MigrateProjectParameters.Builder
- projectRoleVisibility() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters
- projectRoleVisibility(Long) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters.Builder
- publicComment() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters
-
Required parameter to indicate the Comment's visibility.
- publicComment() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentQuery
- publicComment(boolean) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters.Builder
- publicComment(Boolean) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentQuery.Builder
- PublicSoftwareInfo - Interface in com.atlassian.servicedesk.api.info
-
Information about Jira Service Management that is available to anyone
Q
- Queue - Interface in com.atlassian.servicedesk.api.queue
-
Represents a logical queue of
Issue
in Jira Service Management - QueueCreateParameters - Interface in com.atlassian.servicedesk.api.queue
-
Parameters to create
Queue
. - QueueCreateParameters.Builder - Interface in com.atlassian.servicedesk.api.queue
-
Builder to construct the
QueueCreateParameters
. - queueId() - Method in interface com.atlassian.servicedesk.api.queue.QueueQuery
-
Optionally filter search result to a specific
Queue
by its ID. - queueId() - Method in interface com.atlassian.servicedesk.api.queue.QueueRequestQuery
-
ID of an existing
Queue
whose issues will be returned - queueId(int) - Method in interface com.atlassian.servicedesk.api.queue.QueueQuery.Builder
- queueId(int) - Method in interface com.atlassian.servicedesk.api.queue.QueueRequestQuery.Builder
- QueueParametersValidationException - Exception in com.atlassian.servicedesk.api.queue
-
An exception class containing all queue create or update validation errors.
- QueueParametersValidationException(List<ExceptionMessage>) - Constructor for exception com.atlassian.servicedesk.api.queue.QueueParametersValidationException
- QueueParametersValidationException(List<ExceptionMessage>, Throwable) - Constructor for exception com.atlassian.servicedesk.api.queue.QueueParametersValidationException
- QueueQuery - Interface in com.atlassian.servicedesk.api.queue
-
Parameters to query
Queue
that a user can see. - QueueQuery.Builder - Interface in com.atlassian.servicedesk.api.queue
-
Builder to construct the
QueueQuery
. - QueueRequestQuery - Interface in com.atlassian.servicedesk.api.queue
-
Parameters to query
Issue
inside an existingQueue
. - QueueRequestQuery.Builder - Interface in com.atlassian.servicedesk.api.queue
-
Builder to construct the
QueueRequestQuery
. - QueueService - Interface in com.atlassian.servicedesk.api.queue
-
Provide access to
Queue
objects and their issues - QueueUpdateParameters - Interface in com.atlassian.servicedesk.api.queue
-
Parameters to update
Queue
. - QueueUpdateParameters.Builder - Interface in com.atlassian.servicedesk.api.queue
-
Builder to construct the
QueueUpdateParameters
.
R
- raiseOnBehalfOf() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters
-
Optional
ApplicationUser
's username to create the customer request on behalf of. - raiseOnBehalfOf(String) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
Set the user to create this customer request on behalf of himself / herself
- raiseOnBehalfOf(Optional<String>) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
Set the user to create this customer request on behalf of himself / herself
- REJECTED - Enum constant in enum class com.atlassian.servicedesk.api.approval.ApprovalDecisionType
- REMOVED - Enum constant in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeAllowedEntityStatus
- removeOrganizationFromServiceDesk(ApplicationUser, OrganizationServiceDeskUpdateParameters) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
-
Removes an organization from a service project if the user is an agent of that service project.
- removeRequestParticipants(ApplicationUser, RequestParticipantUpdateParameters) - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantService
-
Remove a list
ApplicationUser
as participant from a givenCustomerRequest
. - removeUsersFromOrganization(ApplicationUser, UsersOrganizationUpdateParameters) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationService
-
Removes users from a specified organization.
- reorderQueues(ApplicationUser, int, List<Integer>) - Method in interface com.atlassian.servicedesk.api.queue.QueueService
-
Reorder the list of
Queue
for a given service project - request() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionExecutionParameters
-
Get the request
- request(CustomerRequest) - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionExecutionParameters.Builder
-
Set the request to execute the transition on
- RequestFeedbackDetails - Class in com.atlassian.servicedesk.api.feedback
-
The return type that wraps all required data for a Jira Service Management Request Feedback token and link
- RequestFeedbackDetails(ApplicationUser, Issue, String, RequestFeedbackToken, int) - Constructor for class com.atlassian.servicedesk.api.feedback.RequestFeedbackDetails
- RequestFeedbackDetailsService - Interface in com.atlassian.servicedesk.api.feedback
-
Provide a way to get access to the Request Feedback details that can be used with email notifications.
- RequestFeedbackToken - Class in com.atlassian.servicedesk.api.feedback
-
The return type that wraps all required data for a Request Feedback token and link
- RequestFeedbackToken(String, URI) - Constructor for class com.atlassian.servicedesk.api.feedback.RequestFeedbackToken
- requestOverrideSecurity() - Method in interface com.atlassian.servicedesk.api.request.type.CustomerRequestTypeQuery
-
Use this
requestOverrideSecurity
flag to execute query without checking permission of the user executing this request - requestOverrideSecurity() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery
-
Use this
requestOverrideSecurity
flag to execute query without checking permission of the user executing this request. - requestOverrideSecurity(Boolean) - Method in interface com.atlassian.servicedesk.api.request.type.CustomerRequestTypeQuery.Builder
-
Use this
requestOverrideSecurity
flag to execute query without checking permission of the user executing this request - requestOverrideSecurity(Boolean) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery.Builder
-
Use this
requestOverrideSecurity
flag to execute query without checking permission of the user executing this request - requestOwnership() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery
-
Limited result customer requests to those which are raised by executing user, or requests he participated in, or both
- requestOwnership(CustomerRequestQuery.REQUEST_OWNERSHIP) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery.Builder
- requestParticipant(ApplicationUser) - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantUpdateParameters.Builder
-
Add a single
ApplicationUser
as participant. - requestParticipant(String) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
Add a participant into this customer request
- RequestParticipantQuery - Interface in com.atlassian.servicedesk.api.request.participant
-
Parameters to query
ApplicationUser
participating in aCustomerRequest
- RequestParticipantQuery.Builder - Interface in com.atlassian.servicedesk.api.request.participant
-
Builder to construct the
RequestParticipantQuery
. - requestParticipants() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters
-
Optional list of
ApplicationUser
's username of participants on this customer request Note: the function is dependent on executing user's permission, refer toRequestTypeFieldService.getCustomerRequestCreateMeta(ApplicationUser, RequestTypeFieldQuery)
to test the capability - requestParticipants() - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantUpdateParameters
- requestParticipants(Optional<Set<String>>) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
Set a list participants into this customer request
- requestParticipants(Set<ApplicationUser>) - Method in interface com.atlassian.servicedesk.api.request.participant.RequestParticipantUpdateParameters.Builder
-
Add multiple
ApplicationUser
as participants - requestParticipants(Set<String>) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
Set a list participants into this customer request
- RequestParticipantService - Interface in com.atlassian.servicedesk.api.request.participant
-
Used to perform actions on
ApplicationUser
who participates in aCustomerRequest
- RequestParticipantUpdateParameters - Interface in com.atlassian.servicedesk.api.request.participant
-
Contains parameters to add/remove participants to an existing request
- RequestParticipantUpdateParameters.Builder - Interface in com.atlassian.servicedesk.api.request.participant
-
Use this
RequestParticipantUpdateParameters.Builder
to construct an instance ofRequestParticipantUpdateParameters
- requestStatus() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery
-
Limit result customer requests to those are open, closed, or both
- requestStatus(CustomerRequestQuery.REQUEST_STATUS) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery.Builder
- requestType() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeField
-
The parent
RequestType
of this field - requestType() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldQuery
-
ID of parent
RequestType
of which theRequestTypeField
's belong to - requestType() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters
-
RequestType
of the request - requestType() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery
-
Use this
CustomerRequestQuery.requestType()
in combination withCustomerRequestQuery.serviceDesk()
to narrow the query to theCustomerRequest
's that belong to aRequestType
- requestType() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestUpdateParameters
-
The new
RequestType
to be updated into theCustomerRequest
- requestType() - Method in interface com.atlassian.servicedesk.api.request.type.CustomerRequestTypeQuery
-
Use this
RequestType
to retrieve a specificCustomerRequestType
. - requestType() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeDeleteParameters
-
The id of this
RequestType
. - requestType() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery
- requestType() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeUpdateParameters
-
The id of this
RequestType
. - requestType(int) - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldQuery.Builder
- requestType(RequestType) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
Set the request type
- requestType(RequestType) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestUpdateParameters.Builder
- requestType(RequestType) - Method in interface com.atlassian.servicedesk.api.request.type.CustomerRequestTypeQuery.Builder
-
Use this
RequestType
's to retrieve a specificCustomerRequestType
- requestType(Integer) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery.Builder
- requestType(Integer) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeDeleteParameters.Builder
- requestType(Integer) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery.Builder
- requestType(Integer) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeUpdateParameters.Builder
- RequestType - Interface in com.atlassian.servicedesk.api.requesttype
- RequestTypeAllowedEntityDTO - Interface in com.atlassian.servicedesk.api.requesttype
- RequestTypeAllowedEntityStatus - Enum Class in com.atlassian.servicedesk.api.requesttype
-
The status of an entity that is allowed to be used in a request type.
- RequestTypeCreateParameters - Interface in com.atlassian.servicedesk.api.requesttype
-
Parameters to create a new
RequestType
for a specificServiceDesk
. - RequestTypeCreateParameters.Builder - Interface in com.atlassian.servicedesk.api.requesttype
-
Builder to instantiate
RequestTypeCreateParameters
. - RequestTypeDeleteParameters - Interface in com.atlassian.servicedesk.api.requesttype
-
Parameters to delete a
RequestType
. - RequestTypeDeleteParameters.Builder - Interface in com.atlassian.servicedesk.api.requesttype
-
Builder to instantiate
RequestTypeDeleteParameters
. - RequestTypeField - Interface in com.atlassian.servicedesk.api.field
-
A service project's field which is configured by
RequestType
basis - RequestTypeFieldQuery - Interface in com.atlassian.servicedesk.api.field
-
Parameter to query
CustomerRequestCreateMeta
- RequestTypeFieldQuery.Builder - Interface in com.atlassian.servicedesk.api.field
-
Builder to construct the
RequestTypeFieldQuery
. - requestTypeFields() - Method in interface com.atlassian.servicedesk.api.field.CustomerRequestCreateMeta
-
List of
RequestTypeField
configured under aRequestType
is used to create a customer request. - RequestTypeFieldService - Interface in com.atlassian.servicedesk.api.field
-
Provide access to the
RequestTypeField
associated with aRequestType
- RequestTypeFieldValue - Interface in com.atlassian.servicedesk.api.field
-
Used as valid field value(s) to
RequestTypeField
where applicable, for example field value as valid options of a select field. - RequestTypeFieldValue.Builder - Interface in com.atlassian.servicedesk.api.field
- RequestTypeFieldValueImpl - Class in com.atlassian.servicedesk.api.field.impl
- RequestTypeFieldValueImpl.BuilderImpl - Class in com.atlassian.servicedesk.api.field.impl
- RequestTypeGroup - Interface in com.atlassian.servicedesk.api.requesttype
-
Represent a logical grouping of
RequestType
in aServiceDesk
. - RequestTypePermission - Interface in com.atlassian.servicedesk.api.requesttype
-
Represents the permissions for a request type.
- RequestTypePermissionEntity - Interface in com.atlassian.servicedesk.api.requesttype
-
Represents an entity that a request type permission applies to.
- RequestTypePermissionEntityType - Enum Class in com.atlassian.servicedesk.api.requesttype
-
The type of entity that a request type permission applies to.
- RequestTypePermissionService - Interface in com.atlassian.servicedesk.api.requesttype
-
Used to perform operations on
RequestTypePermission
. - RequestTypeQuery - Interface in com.atlassian.servicedesk.api.requesttype
-
A query for searching for Request Types
- RequestTypeQuery.Builder - Interface in com.atlassian.servicedesk.api.requesttype
-
Builder to construct the
RequestTypeQuery
. - RequestTypeRestrictionStatus - Enum Class in com.atlassian.servicedesk.api.requesttype
-
Represents the status of a request type restriction.
- RequestTypeService - Interface in com.atlassian.servicedesk.api.requesttype
-
Used to perform operations on
RequestType
. - RequestTypeUpdateParameters - Interface in com.atlassian.servicedesk.api.requesttype
-
Parameters to update a
RequestType
. - RequestTypeUpdateParameters.Builder - Interface in com.atlassian.servicedesk.api.requesttype
-
Builder to instantiate
RequestTypeUpdateParameters
. - required() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeField
-
If the field is mandatory to create a request
- RESTRICTED - Enum constant in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeRestrictionStatus
-
The request type is restricted to certain customers.
- RestrictedSoftwareInfo - Interface in com.atlassian.servicedesk.api.info
-
Information about Jira Service Management that is only available to administrators
- restrictionStatusFilter(Collection<RequestTypeRestrictionStatus>) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery.Builder
-
Limit results to request types that match the restriction status filter.
- runInCustomerContext(NoExceptionsCallable<T>) - Method in interface com.atlassian.servicedesk.api.customer.CustomerContextService
-
Executes the code in a "customer context".
- runInCustomerContext(Runnable) - Method in interface com.atlassian.servicedesk.api.customer.CustomerContextService
-
Executes the code in a "customer context".
- runOutOfCustomerContext(NoExceptionsCallable<T>) - Method in interface com.atlassian.servicedesk.api.customer.CustomerContextService
-
Executes the code out of a "customer context".
- runOutOfCustomerContext(Runnable) - Method in interface com.atlassian.servicedesk.api.customer.CustomerContextService
-
Executes the code out of a "customer context".
S
- SDUser - Interface in com.atlassian.servicedesk.api.user
-
Jira Service Management Application User wrapper.
- searchTerm() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery
-
Filter a customer request on its
Issue
's Summary - searchTerm(String) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery.Builder
- ServerException - Exception in com.atlassian.servicedesk.api
-
Basic Exception thrown by Jira Service Management when something has gone wrong and the server does not know how to handle it.
- ServerException(ExceptionMessage) - Constructor for exception com.atlassian.servicedesk.api.ServerException
- ServerException(ExceptionMessage, Throwable) - Constructor for exception com.atlassian.servicedesk.api.ServerException
- serviceDesk() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeField
-
The
ServiceDesk
that the Request Type belongs to - serviceDesk() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldQuery
-
ID of the parent
ServiceDesk
- serviceDesk() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters
-
The
ServiceDesk
of the request to be created - serviceDesk() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery
-
Narrows the query to the
CustomerRequest
's that belong to aServiceDesk
- serviceDesk() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestUpdateParameters
-
The
ServiceDesk
whichCustomerRequest
belongs to - serviceDesk() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters
-
The
ServiceDesk
thisRequestType
belongs to. - serviceDesk() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeDeleteParameters
-
The id of the
ServiceDesk
thisRequestType
must belong to. - serviceDesk() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery
-
Narrows the query to the
RequestType
's that belong to aServiceDesk
- serviceDesk(int) - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldQuery.Builder
- serviceDesk(ServiceDesk) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestCreateParameters.Builder
-
Set the service project
- serviceDesk(ServiceDesk) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestUpdateParameters.Builder
- serviceDesk(ServiceDesk) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters.Builder
- serviceDesk(Integer) - Method in interface com.atlassian.servicedesk.api.request.CustomerRequestQuery.Builder
- serviceDesk(Integer) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeDeleteParameters.Builder
- serviceDesk(Integer) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery.Builder
-
Narrows the query to the
RequestType
's that belong to aServiceDesk
- ServiceDesk - Interface in com.atlassian.servicedesk.api
-
Represents a service project
- ServiceDeskComment - Interface in com.atlassian.servicedesk.api.comment
-
Represents a comment made on a service project.
- ServiceDeskCommentCreateParameters - Interface in com.atlassian.servicedesk.api.comment
-
Parameter to create a comment on a Jira Service Management's request.
- ServiceDeskCommentCreateParameters.Builder - Interface in com.atlassian.servicedesk.api.comment
- ServiceDeskCommentEvent - Interface in com.atlassian.servicedesk.api.event
-
Represents a comment made on a customer request.
- ServiceDeskCommentQuery - Interface in com.atlassian.servicedesk.api.comment
-
Parameters to query
ServiceDeskComment
- ServiceDeskCommentQuery.Builder - Interface in com.atlassian.servicedesk.api.comment
-
Builder to construct the
ServiceDeskCommentQuery
. - ServiceDeskCommentService - Interface in com.atlassian.servicedesk.api.comment
-
This components provides the ability to create public and private comments for service projects.
- ServiceDeskCreationService - Interface in com.atlassian.servicedesk.api.project.creation
-
Creates service projects
- ServiceDeskCustomerRequestService - Interface in com.atlassian.servicedesk.api.request
-
Used to perform actions on
CustomerRequest
- ServiceDeskDeletedEvent - Interface in com.atlassian.servicedesk.api.event
-
Event that is triggered when a service project is deleted.
- ServiceDeskEmailAttachmentMatcher - Interface in com.atlassian.servicedesk.spi.email.attachment
-
The matcher to implement, in order to participate in the Incoming Email attachment stripping process.
- ServiceDeskEmailAttachmentMatcher.Attachment - Interface in com.atlassian.servicedesk.spi.email.attachment
-
A simple representation of a mail attachment after it has been extracted from a message.
- ServiceDeskEmailAttachmentMatcher.AttachmentContent - Interface in com.atlassian.servicedesk.spi.email.attachment
-
A simple representation of a mail attachment's actual content, after it has been extracted from a message.
- ServiceDeskEmailReplyMatcher - Interface in com.atlassian.servicedesk.spi.email.replystripping
-
The matcher to implement, in order to participate in the Incoming Email reply stripping process.
- serviceDeskId() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationServiceDeskUpdateParameters
- serviceDeskId() - Method in interface com.atlassian.servicedesk.api.organization.OrganizationsQuery
- serviceDeskId() - Method in interface com.atlassian.servicedesk.api.queue.QueueQuery
-
ID of the
ServiceDesk
whoseQueue
will be returned. - serviceDeskId() - Method in interface com.atlassian.servicedesk.api.queue.QueueRequestQuery
-
ID of the
ServiceDesk
owning theQueue
- serviceDeskId(int) - Method in interface com.atlassian.servicedesk.api.queue.QueueQuery.Builder
- serviceDeskId(int) - Method in interface com.atlassian.servicedesk.api.queue.QueueRequestQuery.Builder
- serviceDeskId(Integer) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationServiceDeskUpdateParameters.Builder
- serviceDeskId(Integer) - Method in interface com.atlassian.servicedesk.api.organization.OrganizationsQuery.Builder
-
Only returns organizations within this service project if set.
- ServiceDeskLicense - Interface in com.atlassian.servicedesk.api.license
- ServiceDeskLicenseService - Interface in com.atlassian.servicedesk.api.license
- ServiceDeskManager - Interface in com.atlassian.servicedesk.api
-
Provides access to
ServiceDesk
objects without permission checks. - ServiceDeskPermissionService - Interface in com.atlassian.servicedesk.api.permission
-
An experimental interface for validating users against service project permissions
- ServiceDeskService - Interface in com.atlassian.servicedesk.api
-
Provides access to
ServiceDesk
objects - ServiceDeskServiceException - Exception in com.atlassian.servicedesk.api
-
Base Exception thrown by Jira Service Management.
- ServiceDeskServiceException(ExceptionMessage) - Constructor for exception com.atlassian.servicedesk.api.ServiceDeskServiceException
- ServiceDeskServiceException(ExceptionMessage, Throwable) - Constructor for exception com.atlassian.servicedesk.api.ServiceDeskServiceException
- ServiceDeskSoftwareInfoService - Interface in com.atlassian.servicedesk.api.info
-
Returns information about the Jira Service Management software
- setGroupIds(List<Integer>) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeCreateParameters.Builder
- shouldStripAttachment(ServiceDeskEmailAttachmentMatcher.Attachment) - Method in interface com.atlassian.servicedesk.spi.email.attachment.ServiceDeskEmailAttachmentMatcher
-
Given an
ServiceDeskEmailAttachmentMatcher.Attachment
return whether it should be stripped (ie. - shouldStripText(List<String>) - Method in interface com.atlassian.servicedesk.spi.email.replystripping.ServiceDeskEmailReplyMatcher
-
Evalute the current text block and return whether the message should be stripped from this point onwards.
- shouldStripTextOnIssueCreation(List<String>) - Method in interface com.atlassian.servicedesk.spi.email.replystripping.ServiceDeskEmailReplyMatcher
-
Same as
ServiceDeskEmailReplyMatcher.shouldStripText(List)
but when this matcher is executed on issue creation. - SimplePagedRequest - Class in com.atlassian.servicedesk.api.util.paging
-
A simple immutable implementation of PageRequest
- SimplePagedRequest(int, int) - Constructor for class com.atlassian.servicedesk.api.util.paging.SimplePagedRequest
- SimplePagedRequest(LimitedPagedRequest) - Constructor for class com.atlassian.servicedesk.api.util.paging.SimplePagedRequest
- size() - Method in interface com.atlassian.servicedesk.api.util.paging.PagedResponse
- size() - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
- SLAChangeEvent - Interface in com.atlassian.servicedesk.api.sla.event
-
An event that causes SLA to recalculate
- SlaInformation - Interface in com.atlassian.servicedesk.api.sla.info
-
Information about a named Service Level Agreement
- SlaInformationCompletedCycle - Interface in com.atlassian.servicedesk.api.sla.info
-
Information about the completed cycles of a Service Level Agreement
- SlaInformationOngoingCycle - Interface in com.atlassian.servicedesk.api.sla.info
-
Information about the ongoing cycle of a Service Level Agreement
- SlaInformationQuery - Interface in com.atlassian.servicedesk.api.sla.info
-
A query parameter object for the
SlaInformationService
calls - SlaInformationQuery.Builder - Interface in com.atlassian.servicedesk.api.sla.info
-
Builder to instantiate
SlaInformationQuery
- SlaInformationService - Interface in com.atlassian.servicedesk.api.sla.info
-
Provides methods to query Service Level Agreement information about an issue
- SlaInformationService.DurationFormatter - Interface in com.atlassian.servicedesk.api.sla.info
-
This allows you to format SLA durations into friendly String versions
- sortAndToPagedResponse(LimitedPagedRequest, List<T>, Comparator<T>) - Static method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
-
Use the provided
Comparator
to sort and reduces a list of items to the system enforced limited page size. - status() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequest.CustomerRequestStatus
-
Display status of a customer request
- statusInstant() - Method in interface com.atlassian.servicedesk.api.request.CustomerRequest.CustomerRequestStatus
-
Time on which the status transition
T
- temporaryAttachmentIds() - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters
-
Optional list temporary attachment ID's to associate with the Comment.
- temporaryAttachmentIds(List<TemporaryAttachmentId>) - Method in interface com.atlassian.servicedesk.api.comment.ServiceDeskCommentCreateParameters.Builder
- TimeMetric - Interface in com.atlassian.servicedesk.api.sla.metrics
-
Represents a Time Metric for a service project.
- TimeMetricCondition - Interface in com.atlassian.servicedesk.spi.sla.condition
-
Base interface for hit and match time metric conditions
- TimeMetricConditionFactory - Interface in com.atlassian.servicedesk.spi.sla.condition
-
Generates conditions
- TimeMetricHitCondition - Interface in com.atlassian.servicedesk.spi.sla.condition
-
An SLA condition can evaluate issue state
- TimeMetricMatchCondition - Interface in com.atlassian.servicedesk.spi.sla.condition
-
An SLA condition can evaluate issue state
- TimeMetricService - Interface in com.atlassian.servicedesk.api.sla.metrics
-
Provides methods to query about
TimeMetric
objects. - toArray() - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
- toBuilder() - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeQuery
-
Convert this query to a
RequestTypeQuery.Builder
- toPagedResponse(LimitedPagedRequest, List<T>) - Static method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
-
Reduces a list of items to the system enforced limited page size.
- toString() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackDetails
- toString() - Method in class com.atlassian.servicedesk.api.feedback.RequestFeedbackToken
- toString() - Method in class com.atlassian.servicedesk.api.field.FieldId
- toString() - Method in class com.atlassian.servicedesk.api.field.FieldInputValue
- toString() - Method in class com.atlassian.servicedesk.api.request.CustomerRequestChannelSource
- toString() - Method in class com.atlassian.servicedesk.api.util.expansion.Expansion
- toString() - Method in class com.atlassian.servicedesk.api.util.expansion.Expansions
- toString() - Method in class com.atlassian.servicedesk.api.util.paging.LimitedPagedRequestImpl
- toString() - Method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
- toString() - Method in class com.atlassian.servicedesk.api.util.paging.SimplePagedRequest
- transform(PagedResponse<F>, Function<F, T>) - Static method in class com.atlassian.servicedesk.api.util.paging.PagedResponseImpl
-
Converts a given PageResponse contains items of type F into an equivalent PageResponse with items of type T, transformed by the given mapper.
- transitionId() - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionExecutionParameters
-
Get the transition id
- transitionId(Integer) - Method in interface com.atlassian.servicedesk.api.request.transition.CustomerTransitionExecutionParameters.Builder
-
Transition Id of the transition to execute.
U
- UncheckedUser - Interface in com.atlassian.servicedesk.api.user
-
Deprecated.since 5.1.0.
- unwrap(Collection<CheckedUser>) - Method in interface com.atlassian.servicedesk.api.user.UserFactory
-
Map a list of
CheckedUser
to a list ofApplicationUser
. - updateCustomerRequest(ApplicationUser, CustomerRequestUpdateParameters) - Method in interface com.atlassian.servicedesk.api.request.ServiceDeskCustomerRequestService
-
Update the
CustomerRequest
using the given parameters - updateQueue(ApplicationUser, QueueUpdateParameters) - Method in interface com.atlassian.servicedesk.api.queue.QueueService
-
Given the required QueueParameters update the
Queue
in the service project. - updateRequestType(ApplicationUser, RequestTypeUpdateParameters) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypeService
-
Update a
RequestType
with using the providedRequestTypeUpdateParameters
. - upsertRequestTypePermission(RequestTypePermission) - Method in interface com.atlassian.servicedesk.api.requesttype.RequestTypePermissionService
-
Upsert the permissions for a request type.
- USER - Enum constant in enum class com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntityType
- UserFactory - Interface in com.atlassian.servicedesk.api.user
-
Factory to handle conversions between
SDUser
and JIRAApplicationUser
classes. - users() - Method in interface com.atlassian.servicedesk.api.organization.UsersOrganizationUpdateParameters
- users(Set<ApplicationUser>) - Method in interface com.atlassian.servicedesk.api.organization.UsersOrganizationUpdateParameters.Builder
- UsersInOrganizationQuery - Interface in com.atlassian.servicedesk.api.organization
-
Parameters to query
ApplicationUser
inside an existingCustomerOrganization
. - UsersInOrganizationQuery.Builder - Interface in com.atlassian.servicedesk.api.organization
- UsersOrganizationUpdateParameters - Interface in com.atlassian.servicedesk.api.organization
-
Information supplied to {@link OrganizationService#addUsersToOrganization)} to add users to an organization
- UsersOrganizationUpdateParameters.Builder - Interface in com.atlassian.servicedesk.api.organization
V
- validValues() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeField
-
List of valid options as field's value if applicable, or empty otherwise
- value() - Method in class com.atlassian.servicedesk.api.field.FieldId
-
Raw value of the field ID
- value() - Method in class com.atlassian.servicedesk.api.field.FieldInputValue
- value() - Method in class com.atlassian.servicedesk.api.field.impl.RequestTypeFieldValueImpl
- value() - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldValue
-
The value of this field value
- value() - Method in class com.atlassian.servicedesk.api.request.CustomerRequestChannelSource
-
The unique value of the source channel
- value(String) - Method in class com.atlassian.servicedesk.api.field.impl.RequestTypeFieldValueImpl.BuilderImpl
- value(String) - Method in interface com.atlassian.servicedesk.api.field.RequestTypeFieldValue.Builder
- valueOf(int) - Static method in enum class com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntityType
-
Returns the RequestTypeRestrictionStatus for the given dbValue.
- valueOf(int) - Static method in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeRestrictionStatus
-
Returns the RequestTypeRestrictionStatus for the given dbValue.
- valueOf(String) - Static method in enum class com.atlassian.servicedesk.api.approval.ApprovalDecisionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_OWNERSHIP
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_STATUS
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeAllowedEntityStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntityType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeRestrictionStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.servicedesk.api.sla.condition.HitEvent
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.atlassian.servicedesk.api.sla.condition.MatchEvent
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.atlassian.servicedesk.api.approval.ApprovalDecisionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_OWNERSHIP
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.servicedesk.api.request.CustomerRequestQuery.REQUEST_STATUS
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeAllowedEntityStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.servicedesk.api.requesttype.RequestTypePermissionEntityType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.servicedesk.api.requesttype.RequestTypeRestrictionStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.servicedesk.api.sla.condition.HitEvent
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.atlassian.servicedesk.api.sla.condition.MatchEvent
-
Returns an array containing the constants of this enum class, in the order they are declared.
- Version - Interface in com.atlassian.servicedesk.api.info
-
Represents a software version
W
- withId(String) - Static method in class com.atlassian.servicedesk.api.field.FieldId
-
Create a new instance using the raw JIRA
Field
ID - withValue(Object) - Static method in class com.atlassian.servicedesk.api.field.FieldInputValue
-
Create a new instance using the supplied value, which is shaped specific to the field being set.
- withValue(String) - Static method in class com.atlassian.servicedesk.api.request.CustomerRequestChannelSource
-
Construct a custom source channel using your unique value.
- wrap(ApplicationUser) - Method in interface com.atlassian.servicedesk.api.user.UserFactory
-
Returns a
CheckedUser
from the application user or an error if an internal error occurred, or the ApplicationUser wasnull
. - wrap(Collection<ApplicationUser>) - Method in interface com.atlassian.servicedesk.api.user.UserFactory
-
Map a list of
ApplicationUser
to a list ofCheckedUser
. - wrapUnchecked(ApplicationUser) - Method in interface com.atlassian.servicedesk.api.user.UserFactory
-
Returns a
UncheckedUser
from the application user. - wrapUserKey(String) - Method in interface com.atlassian.servicedesk.api.user.UserFactory
-
This turns a user key into a JIRA Application User and then wraps it up.
- wrapUsername(String) - Method in interface com.atlassian.servicedesk.api.user.UserFactory
-
This turns a username into a JIRA Application User and then wraps it up.
- wrapUsernames(Collection<String>) - Method in interface com.atlassian.servicedesk.api.user.UserFactory
-
This turns
usernames
into a JIRA Application User and then wraps them toCheckedUser
.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
SlaInformationQuery.Builder.issueObject(Issue)
instead.