Package com.polarion.alm.tracker.model

Interface ILinkRoleOpt

All Superinterfaces:

IEnumOption

public interface ILinkRoleOpt
extends IEnumOption

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ILinkRoleOpt.IRule	The rule that defines what Work Item types can be used TO and FROM the role.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_KEY_LIMITED	true if the number of Work Items linked by this role, displayed in the UI, is limited.
static final String	PROPERTY_KEY_OPPOSITE_NAME
static final String	PROPERTY_PARENT	true if links of this role create a parent-child relationship.

Fields inherited from interface com.polarion.platform.persistence.IEnumOption

PROPERTY_KEY_COLOR, PROPERTY_KEY_DEFAULT, PROPERTY_KEY_DESCRIPTION, PROPERTY_KEY_HIDDEN, PROPERTY_KEY_ICON_URL, PROPERTY_KEY_UI_LINK, PROPERTY_KEY_URI

Method Summary

Modifier and Type	Method	Description
String	getOppositeName()
List<ILinkRoleOpt.IRule>	getRules()
boolean	isAllowed(ITypeOpt from, ITypeOpt to)	Checks if this role is allowed to be used from a FROM type Work Item to a TO type Work Item.
boolean	isAllowed(String from, String to)	Checks if this role is allowed to be used from a FROM type Work Item to a TO type Work Item.
boolean	isAllowedFromAll()	Checks if this role is allowed to be used FROM all Work Item types.
boolean	isAllowedFromAllToTheSame()	Checks if this role is allowed to be used FROM all Work Item types TO the same Work Item types.
boolean	isAllowedToAll()	Checks if this role is allowed to be used TO all Work Item types.
Set<String>	isAllowedToTypes(String from)	Returns a set of type IDs that allow this role from the given type.
boolean	isLimited()

Methods inherited from interface com.polarion.platform.persistence.IEnumOption

getEnumId, getId, getName, getProperties, getProperty, getSequenceNumber, isDefault, isHidden, isPhantom

Field Details

PROPERTY_KEY_OPPOSITE_NAME

static final String PROPERTY_KEY_OPPOSITE_NAME

See Also:

• Constant Field Values

PROPERTY_PARENT

static final String PROPERTY_PARENT

true if links of this role create a parent-child relationship.

Since:

3.3.0

See Also:

• Constant Field Values

PROPERTY_KEY_LIMITED

static final String PROPERTY_KEY_LIMITED

true if the number of Work Items linked by this role, displayed in the UI, is limited.

Since:

3.24.10

See Also:

• Constant Field Values

Method Details

getOppositeName

String getOppositeName()

Returns:

the value of the PROPERTY_KEY_OPPOSITE_NAME property.

Since:

3.5.3

getRules

List<ILinkRoleOpt.IRule> getRules()

Returns:

rules defined for this role. It can return null.

Since:

3.4

isAllowed

boolean isAllowed(String from,
 String to)

Checks if this role is allowed to be used from a FROM type Work Item to a TO type Work Item.

Parameters:

from - String type ID. Cannot be null.

to - String type ID. Cannot be null.

Since:

3.4

isAllowed

boolean isAllowed(ITypeOpt from,
 ITypeOpt to)

Checks if this role is allowed to be used from a FROM type Work Item to a TO type Work Item.

Parameters:

from - - type, cannot be null.

to - - type, cannot be null.

Since:

3.4

isAllowedToTypes

Set<String> isAllowedToTypes(String from)

Returns a set of type IDs that allow this role from the given type.

Parameters:

from - String type ID. Cannot be null.

Returns:

a set of String type IDs. Null means "allowed to any type." An empty set means "not allowed to any type".

Since:

3.4

isAllowedFromAll

boolean isAllowedFromAll()

Checks if this role is allowed to be used FROM all Work Item types.

Returns:

boolean

Since:

3.6.2

isAllowedToAll

boolean isAllowedToAll()

Checks if this role is allowed to be used TO all Work Item types.

Returns:

boolean

Since:

3.6.2

isAllowedFromAllToTheSame

boolean isAllowedFromAllToTheSame()

Checks if this role is allowed to be used FROM all Work Item types TO the same Work Item types.

Since:

3.20.2

isLimited

boolean isLimited()

Returns:

the value of the PROPERTY_KEY_LIMITED property.

Since:

3.24.10