Package com.polarion.alm.shared.api.model.eo

Class EnumerationReference

java.lang.Object

com.polarion.alm.shared.api.model.ModelEntityReferenceBase<Enumeration,EnumerationReference>

com.polarion.alm.shared.api.model.eo.EnumerationReference

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, HasId, HasProjectId, ModelEntityReference, Serializable

public final class EnumerationReference
extends ModelEntityReferenceBase<Enumeration,EnumerationReference>
implements HasId, HasProjectId

Since:

3.9.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EnumerationReference(String id, String type, Scope scope)
EnumerationReference(String id, String type, String projectId)

Method Summary

Modifier and Type	Method	Description
EnumerationReference	createReferenceForObjectBasedEnum(String additionalValue)	Returns the same instance when this is not reference to object based enumeration.
EnumerationReference	createReferenceForScope(Scope scope)
EnumerationReference	createReferenceForType(String type)
boolean	equals(Object obj)
Enumeration	get(ReadOnlyTransaction transaction)	Returns the entity referenced by this reference.
static String	getObjectBasedEnumIdPrefix(String id)	Returns the input String when it is not id of object based enumeration.
static String	getObjectBaseEnumValue(String id)
int	hashCode()
String	id()
boolean	isObjectBased()
boolean	isSameObjectBasedEnum(EnumerationReference other)	For non-object based enumeration it just compares IDs
String	projectId()
Scope	scope()
String	toPath()	Returns type specific unique identification path of the object, for example for Work Items in project it is 'projectId/workItemId'. It ignores requested revision.
String	type()

Methods inherited from class com.polarion.alm.shared.api.model.ModelEntityReferenceBase

toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EnumerationReference

public EnumerationReference(@NotNull
 String id,
 @Nullable
 String type,
 @NotNull
 Scope scope)

Parameters:

type - - empty string or string containing only white space characters is treated as null

Throws:

IllegalArgumentException - when id is empty string

EnumerationReference

public EnumerationReference(@NotNull
 String id,
 @Nullable
 String type,
 @Nullable
 String projectId)

Parameters:

type - - empty string or string containing only white space characters is treated as null

projectId - - null means global scope

Throws:

IllegalArgumentException - when id is empty string

Since:

3.19.2

Method Details

id

@NotNull
public String id()

Specified by:

id in interface HasId

type

@Nullable
public String type()

scope

@NotNull
public Scope scope()

projectId

@Nullable
public String projectId()

Specified by:

projectId in interface HasProjectId

get

@NotNull
public Enumeration get(@NotNull
 ReadOnlyTransaction transaction)

Description copied from class: ModelEntityReferenceBase

Returns the entity referenced by this reference.

Specified by:

get in interface ModelEntityReference

Specified by:

get in class ModelEntityReferenceBase<Enumeration,EnumerationReference>

See Also:

• ModelObjectReference.get(ReadOnlyTransaction)

toPath

@NotNull
public String toPath()

Description copied from interface: ModelEntityReference

Returns type specific unique identification path of the object, for example for Work Items in project it is 'projectId/workItemId'.
It ignores requested revision.

Specified by:

toPath in interface ModelEntityReference

See Also:

• ModelObjectSelector.path(String)

createReferenceForType

@NotNull
public EnumerationReference createReferenceForType(@Nullable
 String type)

createReferenceForScope

@NotNull
public EnumerationReference createReferenceForScope(@NotNull
 Scope scope)

createReferenceForObjectBasedEnum

@NotNull
public EnumerationReference createReferenceForObjectBasedEnum(@Nullable
 String additionalValue)

Returns the same instance when this is not reference to object based enumeration.

getObjectBasedEnumIdPrefix

@NotNull
public static String getObjectBasedEnumIdPrefix(@NotNull
 String id)

Returns the input String when it is not id of object based enumeration.

getObjectBaseEnumValue

@Nullable
public static String getObjectBaseEnumValue(@NotNull
 String id)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isSameObjectBasedEnum

public boolean isSameObjectBasedEnum(@NotNull
 EnumerationReference other)

For non-object based enumeration it just compares IDs

isObjectBased

public boolean isObjectBased()

Returns:

true if this is reference to object based enumeration.

Since:

3.9.2