Class WorkPackageLink

java.lang.Object
com.xwiki.projectmanagement.openproject.store.WorkPackageLink

public class WorkPackageLink extends Object
The base object wrapper that enables the manipulation if Work Package links.
Since:
1.2.0-rc-1
Version:
$Id$
  • Field Details

    • CLASS_FULLNAME

      public static final String CLASS_FULLNAME
      The String reference of the class defining the object which contains an OIDC configuration.
      See Also:
    • CLASS_REFERENCE

      public static final org.xwiki.model.reference.LocalDocumentReference CLASS_REFERENCE
      The local reference of the configuration class.
    • FIELD_PROJECT

      public static final String FIELD_PROJECT
      The name of the project property within the XClass.
      See Also:
    • FIELD_WORK_PACKAGE

      public static final String FIELD_WORK_PACKAGE
      The name of the work package property within the XClass.
      See Also:
    • FIELD_INSTANCE

      public static final String FIELD_INSTANCE
      The name of the instance property within the XClass.
      See Also:
    • FIELD_PRIMARY

      public static final String FIELD_PRIMARY
      The name of the instance property within the XClass.
      See Also:
  • Constructor Details

    • WorkPackageLink

      public WorkPackageLink(com.xpn.xwiki.objects.BaseObject xobject)
      Parameters:
      xobject - the xobject that stores the work package link information.
  • Method Details

    • getProject

      public String getProject()
      Returns:
      the id of the OpenProject project that is linked to a xwiki page.
    • setProject

      public void setProject(String project)
      Parameters:
      project - see getProject().
    • getWorkPackage

      public String getWorkPackage()
      Returns:
      the id of the OpenProject work package that is linked to a xwiki page.
    • setWorkPackage

      public void setWorkPackage(String workPackage)
      Parameters:
      workPackage - see getWorkPackage().
    • getInstance

      public String getInstance()
      Returns:
      the id of the configured OpenProject instance where the linked work package/project can be found.
    • setInstance

      public void setInstance(String instance)
      Parameters:
      instance - see getInstance().
    • isPrimary

      public boolean isPrimary()
      Returns:
      denotes whether this link is the one with the most significance within the page or not.
    • setPrimary

      public void setPrimary(boolean primary)
      Parameters:
      primary - see isPrimary()}.