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

Interface ModelObjectBase<T extends ModelObjectBase<T,R>,R extends ModelObjectReferenceBase<T,R>>

All Superinterfaces:

CanRender<Renderer<? extends Renderer<?>>>, HasFields, HasReference<ModelEntityReference>, ModelEntity, ModelEntityBase<T,R>, ModelObject

All Known Subinterfaces:

Baseline, BaselineCollection, Category, Document, Plan, Project, RichPage, TestRun, TimePoint, UpdatableBaseline, UpdatableBaselineCollection, UpdatableCategory, UpdatableDocument, UpdatableModelObjectBase<T,R>, UpdatablePlan, UpdatableProject, UpdatableRichPage, UpdatableTestRun, UpdatableTimePoint, UpdatableUser, UpdatableUserGroup, UpdatableWikiPage, UpdatableWorkItem, User, UserGroup, WikiPage, WorkItem

public interface ModelObjectBase<T extends ModelObjectBase<T,R>,R extends ModelObjectReferenceBase<T,R>>
extends ModelEntityBase<T,R>, ModelObject, HasFields

Generic version of ModelObject interface. Should only be used in rare cases of generic code where unchecked cast would otherwise be needed.

Since:

3.9.0

Method Summary

Modifier and Type	Method	Description
R	getReference()	Returns a reference including the requested and actual revisions.
R	getReferenceToCurrent()	Returns a reference without the requested and actual revisions, so it is much faster than ModelObject.getReference(), because it does not have to read the actual revisions.
UpdatableModelObjectBase<T,R>	getUpdatable(WriteTransaction transaction)
IterableWithSize<R>	history()	Returns history of object.

Methods inherited from interface com.polarion.alm.shared.api.model.ModelEntity

equals, hashCode, isUnresolvable, render, transaction

Methods inherited from interface com.polarion.alm.shared.api.model.ModelObject

can, copyFieldsTo, fields, forget, getOldApi, label, resolve

Method Detail

getReferenceToCurrent

@NotNull
R getReferenceToCurrent()

Description copied from interface: ModelObject

Returns a reference without the requested and actual revisions, so it is much faster than ModelObject.getReference(), because it does not have to read the actual revisions.

Specified by:

getReferenceToCurrent in interface ModelObject

getReference

@NotNull
R getReference()

Description copied from interface: ModelObject

Returns a reference including the requested and actual revisions. If you are not interested in those, consider using the much faster ModelObject.getReferenceToCurrent() method.

Specified by:

getReference in interface HasReference<T extends ModelObjectBase<T,R>>

Specified by:

getReference in interface ModelEntityBase<T extends ModelObjectBase<T,R>,R extends ModelObjectReferenceBase<T,R>>

Specified by:

getReference in interface ModelObject

getUpdatable

@NotNull
UpdatableModelObjectBase<T,R> getUpdatable(@NotNull
                                                 WriteTransaction transaction)

Specified by:

getUpdatable in interface ModelObject

history

@NotNull
IterableWithSize<R> history()

Description copied from interface: ModelObject

Returns history of object. If object is versioned (has requested revision) then history up to this revision will be returned. The history list is sorted from the oldest (coming first) to the newest (last).

Specified by:

history in interface ModelObject