Class WorkPackageLink
java.lang.Object
com.xwiki.projectmanagement.openproject.store.WorkPackageLink
The base object wrapper that enables the manipulation if Work Package links.
- Since:
- 1.2.0-rc-1
- Version:
- $Id$
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe String reference of the class defining the object which contains an OIDC configuration.static final org.xwiki.model.reference.LocalDocumentReferenceThe local reference of the configuration class.static final StringThe name of the instance property within the XClass.static final StringThe name of the instance property within the XClass.static final StringThe name of the project property within the XClass.static final StringThe name of the work package property within the XClass. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanvoidsetInstance(String instance) voidsetPrimary(boolean primary) voidsetProject(String project) voidsetWorkPackage(String workPackage)
-
Field Details
-
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_REFERENCEThe local reference of the configuration class. -
FIELD_PROJECT
The name of the project property within the XClass.- See Also:
-
FIELD_WORK_PACKAGE
The name of the work package property within the XClass.- See Also:
-
FIELD_INSTANCE
The name of the instance property within the XClass.- See Also:
-
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
- Returns:
- the id of the OpenProject project that is linked to a xwiki page.
-
setProject
- Parameters:
project- seegetProject().
-
getWorkPackage
- Returns:
- the id of the OpenProject work package that is linked to a xwiki page.
-
setWorkPackage
- Parameters:
workPackage- seegetWorkPackage().
-
getInstance
- Returns:
- the id of the configured OpenProject instance where the linked work package/project can be found.
-
setInstance
- Parameters:
instance- seegetInstance().
-
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- seeisPrimary()}.
-