Constructor Detail

• ModuleContextBinding

  public ModuleContextBinding()

Method Detail

• getIdentifier

  @Deprecated(since="2.1.0",
              forRemoval=false)
  public String getIdentifier()

  Deprecated.

  this information is not provided by GetModuleStructure but only by GetModuleContext.
  Returns the short identifier of the underlying requirement.

  Returns:

  the short identifier of the underlying requirement.

  See Also:

  Requirement.getShortTitle()

• setIdentifier

  public void setIdentifier​(String identifier)

• getTitle

  @Deprecated(since="2.1.0",
              forRemoval=false)
  public String getTitle()

  Deprecated.

  this information is not provided by GetModuleStructure but only by GetModuleContext.
  Returns the title of the underlying requirement.

  Returns:

  the title of the underlying requirement.

  See Also:

  Requirement.getTitle()

• setTitle

  public void setTitle​(String title)

• isHeading

  @OslcName("isHeading")
  @OslcOccurs(ZeroOrOne)
  @OslcPropertyDefinition("http://jazz.net/ns/rm/dng/module#isHeading")
  @OslcValueType(Boolean)
  public Boolean isHeading()

  Determines whether the underlying requirement is displayed as a heading.

  Returns:

  true if the underlying requirement is displayed as a heading, false otherwise.

• setHeading

  public void setHeading​(Boolean heading)

• getFormat

  @Deprecated(since="2.1.0",
              forRemoval=false)
  public String getFormat()

  Deprecated.

  this information is not provided by GetModuleStructure but only by GetModuleContext.
  Returns the format of the underlying requirement, which can be either Text or Diagram.

  Returns:

  the format of the underlying requirement, which can be either Text or Diagram.

• setFormat

  public void setFormat​(String format)

• getSection

  public String getSection()

  Returns the section information of the underlying requirement, e.g. 1.3.4.

  Returns:

  the section information of the underlying requirement, e.g. 1.3.4.

• setSection

  public void setSection​(String section)

• getBookOrder

  public int getBookOrder()

  Returns the order of the underlying requirement in the list of requirements displayed in the module.

  Returns:

  the order of the underlying requirement in the list of requirements displayed in the module.

• setBookOrder

  public void setBookOrder​(int bookOrder)

• getDepth

  public int getDepth()

  Returns the depth information of the underlying requirement, which determines the number of recursive parents.

  Returns:

  the depth information of the underlying requirement, which determines the number of recursive parents.

• setDepth

  public void setDepth​(int depth)

• isStructureRoot

  @OslcName("isStructureRoot")
  @OslcOccurs(ZeroOrOne)
  @OslcPropertyDefinition("http://jazz.net/ns/rm/dng/module#isStructureRoot")
  @OslcValueType(Boolean)
  public Boolean isStructureRoot()

  Indicates if the actual Binding is the root one representing the module

  Returns:

  true if it is the module, false otherwise

  Since:

  2.2.0

• setStructureRoot

  public void setStructureRoot​(Boolean isStructureRoot)

• getChildBindings

  @OslcValueType(LocalResource)
  @OslcPropertyDefinition("http://jazz.net/ns/rm/dng/module#childBindings")
  public List<ModuleContextBinding> getChildBindings()

  Returns the child bindings of this object

  Returns:

  a list of the first level child bindings

  Since:

  2.2.0

• setChildBindings

  public void setChildBindings​(List<ModuleContextBinding> childBindings)

• addChildBinding

  public void addChildBinding​(ModuleContextBinding child)

  Adds a child to this object

  Parameters:

  child - the child to add

  Since:

  2.2.0

• getComponent

  @OslcOccurs(ExactlyOne)
  @OslcPropertyDefinition("http://open-services.net/ns/config#component")
  @OslcValueType(Resource)
  public URI getComponent()

  Returns the component's URI where the module is located

  Returns:

  the component's URI

  Since:

  2.2.0

• setComponent

  public void setComponent​(URI component)

• getBoundArtifact

  @OslcOccurs(ExactlyOne)
  @OslcPropertyDefinition("http://jazz.net/ns/rm/dng/module#boundArtifact")
  @OslcValueType(Resource)
  public URI getBoundArtifact()

  Returns the artifact represented by the actual binding

  Returns:

  the artifact's URI

  Since:

  2.2.0

• setBoundArtifact

  public void setBoundArtifact​(URI boundArtifact)

• getModule

  @OslcOccurs(ExactlyOne)
  @OslcPropertyDefinition("http://jazz.net/ns/rm/dng/module#module")
  @OslcValueType(Resource)
  public URI getModule()

  Return this context's module

  Returns:

  the module's URI

  Since:

  2.2.0

• setModule

  public void setModule​(URI module)

• findChildBinding

  public Optional<ModuleContextBinding> findChildBinding​(URI child)

  Search recursively in all descendants the ModuleContextBinding with the given URI

  Parameters:

  child - the child to look for with its about or base artifact

  Returns:

  the ModuleContextBinding of the given child

  Since:

  2.2.0

• getAllChildren

  public List<ModuleContextBinding> getAllChildren()

  Return all bindings below this recursively

  Returns:

  the list of bindings located under this

  Since:

  2.2.0