Document

All Superinterfaces:: CanRender<Renderer<? extends Renderer<?>>>, ContainedInSpace, HasFields, HasReference<ModelEntityReference>, ModelEntity, ModelEntityBase<Document,DocumentReference>, ModelObject, ModelObjectBase<Document,DocumentReference>

All Known Subinterfaces:: UpdatableDocument

public interface Document extends ModelObjectBase<Document,DocumentReference>, ContainedInSpace

Since:: 3.9.0

Method Summary

Modifier and Type

Method

Description

DocumentPermissions

can()

DocumentFields

fields()

com.polarion.alm.tracker.model.IModule

getOldApi()

UpdatableDocument

getUpdatable(WriteTransaction transaction)

DocumentWorkItems

items()

The returned instances allows iterating over all Work Items from the document (even the unreferenced) and contains other helper methods related to Work Items

The iterator never returns null value.

DocumentRenderer

render()

Methods inherited from interface com.polarion.alm.shared.api.model.space.ContainedInSpace
getReference, space

Methods inherited from interface com.polarion.alm.shared.api.model.ModelEntity
equals, hashCode, isUnresolvable, transaction

Methods inherited from interface com.polarion.alm.shared.api.model.ModelObject
copyFieldsTo, forget, label, resolve

Methods inherited from interface com.polarion.alm.shared.api.model.ModelObjectBase
getReference, getReferenceToCurrent, history

Method Details
- getOldApi
  
  @NotNull @GwtIncompatible com.polarion.alm.tracker.model.IModule getOldApi()
  
  Specified by:
  
  getOldApi in interface ModelObject
- getUpdatable
  
  @NotNull UpdatableDocument getUpdatable(@NotNull WriteTransaction transaction)
  
  Specified by:
  
  getUpdatable in interface ModelObject
  
  Specified by:
  
  getUpdatable in interface ModelObjectBase<Document,DocumentReference>
- items
  
  @NotNull DocumentWorkItems items()
  
  The returned instances allows iterating over all Work Items from the document (even the unreferenced) and contains other helper methods related to Work Items
  
  The iterator never returns null value.
- render
  
  @NotNull DocumentRenderer render()
  
  Specified by:
  
  render in interface CanRender<Renderer<? extends Renderer<?>>>
  
  Specified by:
  
  render in interface ModelEntity
- fields
  
  @NotNull DocumentFields fields()
  
  Specified by:
  
  fields in interface HasFields
  
  Specified by:
  
  fields in interface ModelObject
- can
  
  @NotNull DocumentPermissions can()
  
  Specified by:
  
  can in interface ModelEntity
  
  Specified by:
  
  can in interface ModelObject
  
  Since:
  
  3.9.1