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

Class CategoryReference

java.lang.Object

com.polarion.alm.shared.api.model.ModelEntityReferenceBase<T,R>

com.polarion.alm.shared.api.model.ModelObjectReferenceBase<T,R>

com.polarion.alm.shared.api.model.ModelObjectReferenceWithUpdatable<Category,UpdatableCategory,CategoryReference>

com.polarion.alm.shared.api.model.category.CategoryReference

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, HasId, HasProjectId, HasRelativePath, ModelEntityReference, ModelObjectReference, ReferenceWithUpdatable<UpdatableCategory>, Serializable

public final class CategoryReference
extends ModelObjectReferenceWithUpdatable<Category,UpdatableCategory,CategoryReference>
implements HasId, HasProjectId, HasRelativePath

Since:

3.9.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CategoryReference(String projectId, String id)
CategoryReference(String projectId, String id, String requestedRevision, String actualRevision)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static CategoryReference	fromPath(String path)	The path is trimmed before parsing, so it can contain spaces at the start or end. See toPath()
static CategoryReference	fromRelativePath(String baseProjectId, String path)	The path is trimmed before parsing, so it can contain spaces at the start or end. The path can be obtained using toRelativePath(String).
CategoryReference	getCurrent()	Returns the reference to current revision of the object, in other words reference without requested revision and actual revision.
Category	getFromRevision(ReadOnlyTransaction transaction, String revision)
CategoryReference	getWithRevision(String requestedRevision)	Returns the reference to the same object, but with different ModelObjectReference.requestedRevision(), the ModelObjectReference.actualRevision() of the returned reference is null.
int	hashCode()
String	id()
String	projectId()	It is shortcut for ModelObjectReference.scope().Scope.projectId()
PrototypeEnum	prototype()
Scope	scope()
String	toPath()	Returns type specific unique identification path of the object, for example for Work Items in project it is 'projectId/workItemId', the ModelObjectReference.requestedRevision() and ModelObjectReference.actualRevision() are ignored.
String	toRelativePath(String baseProjectId)	Returns the id() if the baseProjectId is same as projectId() otherwise returns the same value as toPath(). The fromRelativePath(String, String) can be used to get the reference from the returned path.

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

getUpdatable

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

actualRevision, get, getCurrent, getOriginal, requestedRevision, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CategoryReference

public CategoryReference(@NotNull
 String projectId,
 @NotNull
 String id,
 @Nullable
 String requestedRevision,
 @Nullable
 String actualRevision)

Throws:

IllegalArgumentException - when projectId or id is empty string

CategoryReference

public CategoryReference(@NotNull
 String projectId,
 @NotNull
 String id)

Throws:

IllegalArgumentException - when projectId or id is empty string

Since:

3.9.1

Method Details

fromPath

@NotNull
public static CategoryReference fromPath(@NotNull
 String path)

The path is trimmed before parsing, so it can contain spaces at the start or end.

See toPath()

Throws:

IllegalArgumentException - in same conditions as WorkItemReference.fromPath(String)

See Also:

• ModelObjectSelector.path(String)

fromRelativePath

@NotNull
public static CategoryReference fromRelativePath(@Nullable
 String baseProjectId,
 @NotNull
 String path)

The path is trimmed before parsing, so it can contain spaces at the start or end.

The path can be obtained using toRelativePath(String). The baseProjectId used in both calls must be the same.

Throws:

IllegalArgumentException - in same conditions as WorkItemReference.fromRelativePath(String, String)

Since:

3.9.1

getFromRevision

@NotNull
public Category getFromRevision(@NotNull
 ReadOnlyTransaction transaction,
 @Nullable
 String revision)

Specified by:

getFromRevision in interface ModelObjectReference

Specified by:

getFromRevision in class ModelObjectReferenceBase<Category,CategoryReference>

revision - - null means current revision

getCurrent

@NotNull
public CategoryReference getCurrent()

Description copied from interface: ModelObjectReference

Returns the reference to current revision of the object, in other words reference without requested revision and actual revision. It is shortcut for calling ModelObjectReference.getWithRevision(String) with null

Specified by:

getCurrent in interface ModelObjectReference

Overrides:

getCurrent in class ModelObjectReferenceBase<Category,CategoryReference>

getWithRevision

@NotNull
public CategoryReference getWithRevision(@Nullable
 String requestedRevision)

Description copied from interface: ModelObjectReference

Returns the reference to the same object, but with different ModelObjectReference.requestedRevision(), the ModelObjectReference.actualRevision() of the returned reference is null.

Specified by:

getWithRevision in interface ModelObjectReference

Specified by:

getWithRevision in class ModelObjectReferenceBase<Category,CategoryReference>

See Also:

• which is shortcut for calling this method with null

projectId

@NotNull
public String projectId()

Description copied from interface: ModelObjectReference

It is shortcut for ModelObjectReference.scope().Scope.projectId()

Specified by:

projectId in interface HasProjectId

Specified by:

projectId in interface ModelObjectReference

Overrides:

projectId in class ModelObjectReferenceBase<Category,CategoryReference>

scope

@NotNull
public Scope scope()

Specified by:

scope in interface ModelObjectReference

id

@NotNull
public String id()

Specified by:

id in interface HasId

toPath

@NotNull
public String toPath()

Description copied from interface: ModelObjectReference

Returns type specific unique identification path of the object, for example for Work Items in project it is 'projectId/workItemId', the ModelObjectReference.requestedRevision() and ModelObjectReference.actualRevision() are ignored.

Specified by:

toPath in interface ModelEntityReference

Specified by:

toPath in interface ModelObjectReference

See Also:

• ModelObjectSelector.path(String)

toRelativePath

@NotNull
public String toRelativePath(@Nullable
 String baseProjectId)

Returns the id() if the baseProjectId is same as projectId() otherwise returns the same value as toPath().

The fromRelativePath(String, String) can be used to get the reference from the returned path. The baseProjectId used in both calls must be the same.

Specified by:

toRelativePath in interface HasRelativePath

Parameters:

baseProjectId - - null means global scope

Since:

3.9.1

hashCode

public int hashCode()

Overrides:

hashCode in class ModelObjectReferenceBase<Category,CategoryReference>

equals

public boolean equals(Object obj)

Overrides:

equals in class ModelObjectReferenceBase<Category,CategoryReference>

prototype

@NotNull
public PrototypeEnum prototype()

Specified by:

prototype in interface ModelObjectReference