/** * Holds hint data. Currently only the text of a hint, might be extended * in the future. * * @since v4.2 (Interface extracted from class in v5.0) */ @PublicApi public interface Hint { String getText(); String getTooltip(); }
/** * This interface should be implemented by events that are related to the Issue. * * @since v5.2.6 */ @PublicApi public interface IssueRelatedEvent extends JiraEvent { Issue getIssue(); }
@PublicApi public interface OperationContext { public Map<String, Object> getFieldValuesHolder(); public IssueOperation getIssueOperation(); }
/** * Event triggered when indexing gets shutdown entirely. This generally only * happens during JIRA's startup/initialization. * @since v5.0 */ @PublicApi public class IndexingShutdownEvent implements IndexEvent {}
@PublicApi interface VersionAction { boolean isSwap(); Long getSwapVersionId(); }
@PublicApi public interface IssueOperation { /** * An i18n key used to display a short description of this operation in the UI. e.g " Watch Issues " * * @return An i18n key used to display a short description of this operation in the UI */ String getNameKey(); String getDescriptionKey(); }
/** * This contains String > Collection of Transport Objects */ @PublicApi public interface FieldTransportParams extends CollectionParams { Object getFirstValueForNullKey(); Object getFirstValueForKey(String key); }
/** * Published when a user logs out. */ @PublicApi public final class LogoutEvent extends UserEvent { public LogoutEvent(ApplicationUser user) { super(user, UserEventType.USER_LOGOUT); } }
/** * A marker interface for fields in JIRA which can be "hidden" as part of a {@link com.atlassian.jira.issue.fields.layout.field.FieldLayout}. */ @PublicApi public interface HideableField { }
@PublicApi public static class DeleteProjectResult extends ServiceResultImpl { @Internal public DeleteProjectResult(final ErrorCollection errorCollection) { super(errorCollection); } } }
/** * Represents the Project System Field. * * @since v4.3 */ @PublicApi public interface ProjectField extends OrderableField<Project>, NavigableField, HideableField, RequirableField { }
@PublicApi public interface SubTaskBean { public static final String SUB_TASK_VIEW_ALL = "all"; public static final String SUB_TASK_VIEW_UNRESOLVED = "unresolved"; public static final String SUB_TASK_VIEW_DEFAULT = SUB_TASK_VIEW_ALL; public Collection<SubTask> getSubTasks(String view); public Long getNextSequence(Long sequence, String view); public Long getPreviousSequence(Long sequence, String view); public PercentageGraphModel getSubTaskProgress(); }
/** * A marker interface to describe the default editable field layout. * <b>Note</b>: These are called Field Configurations in the UI. */ @PublicApi public interface EditableDefaultFieldLayout extends EditableFieldLayout { public static final String NAME = "Default Field Configuration"; public static final String DESCRIPTION = "The default field configuration"; }
@PublicApi public interface EditableSearchRequestColumnLayout extends EditableUserColumnLayout { public SearchRequest getSearchRequest(); public void setSearchRequest(SearchRequest searchRequest); }
/** * A marker interface for fields in JIRA which can be made "required" as part of a {@link com.atlassian.jira.issue.fields.layout.field.FieldLayout}. */ @PublicApi public interface RequirableField extends Field { }
/** * This exception indicates that an operation has failed because avatars are disabled. * * @since v4.3 */ @PublicApi public class AvatarsDisabledException extends RuntimeException { }
@PublicApi public interface OptionSetManager { // -------------------------------------------------------------------------------------------------- Public Methods OptionSet getOptionsForConfig(@Nonnull FieldConfig config); OptionSet createOptionSet(@Nonnull FieldConfig config, Collection optionIds); OptionSet updateOptionSet(@Nonnull FieldConfig config, Collection optionIds); void removeOptionSet(@Nonnull FieldConfig config); }
/** * @since v6.5 */ @PublicApi @Immutable public final class UserPropertySetEvent extends AbstractPropertyEvent implements EntityPropertySetEvent { public UserPropertySetEvent(final EntityProperty entityProperty, final ApplicationUser user) { super(entityProperty, user); } }
/** * @since v6.5 */ @PublicApi @Immutable public final class UserPropertyDeletedEvent extends AbstractPropertyEvent implements EntityPropertyDeletedEvent { public UserPropertyDeletedEvent(final EntityProperty entityProperty, final ApplicationUser user) { super(entityProperty, user); } }
@PublicApi @EventName ("property.set.dashboarditem") public final class DashboardItemPropertySetEvent extends AbstractPropertyEvent implements EntityPropertySetEvent { public DashboardItemPropertySetEvent(final EntityProperty entityProperty, final ApplicationUser user) { super(entityProperty, user); } }