Summary: Fields | Methods | [Expand All]
@PublicApi public interface

IssueTypeScreenScheme

com.atlassian.jira.issue.fields.screen.issuetype.IssueTypeScreenScheme
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Copyright (c) 2002-2004 All rights reserved.

Summary

Fields
public static final Long DEFAULT_SCHEME_ID
Public Methods
void addEntity(IssueTypeScreenSchemeEntity issueTypeScreenSchemeEntity)
boolean containsEntity(String issueTypeId)
String getDescription()
@Nonnull FieldScreenScheme getEffectiveFieldScreenScheme(IssueType type)
Return FieldScreenScheme that JIRA will actually use for the passed IssueType.
Collection<IssueTypeScreenSchemeEntity> getEntities()
IssueTypeScreenSchemeEntity getEntity(String issueTypeId)
GenericValue getGenericValue()
Long getId()
String getName()
Collection<GenericValue> getProjects()
boolean isDefault()
void remove()
void removeEntity(String issueTypeId)
void setDescription(String description)
void setGenericValue(GenericValue genericValue)
void setId(Long id)
void setName(String name)
void store()

Fields

public static final Long DEFAULT_SCHEME_ID

Public Methods

public void addEntity (IssueTypeScreenSchemeEntity issueTypeScreenSchemeEntity)

public boolean containsEntity (String issueTypeId)

public String getDescription ()

@Nonnull public FieldScreenScheme getEffectiveFieldScreenScheme (IssueType type)

Return FieldScreenScheme that JIRA will actually use for the passed IssueType. This method will never return null as each IssueType must have an associated FieldScreenScheme that either comes from an explicit mapping or the default mapping in the scheme.

Parameters
type the IssueType to query.
Returns
  • the FieldScreenScheme for the passed IssueType. Cannot be null.

public Collection<IssueTypeScreenSchemeEntity> getEntities ()

public IssueTypeScreenSchemeEntity getEntity (String issueTypeId)

public GenericValue getGenericValue ()

public Long getId ()

public String getName ()

public Collection<GenericValue> getProjects ()

public boolean isDefault ()

public void remove ()

public void removeEntity (String issueTypeId)

public void setDescription (String description)

public void setGenericValue (GenericValue genericValue)

public void setId (Long id)

public void setName (String name)

public void store ()