Class ProjectManagementRelation
java.lang.Object
com.xwiki.projectmanagement.relations.store.ProjectManagementRelation
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 client property within the XClass.static final StringThe name of the client params 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 TypeMethodDescriptionvoidvoidsetClientParams(String clientParams) voidsetProject(String project) voidsetWorkItem(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_CLIENT
The name of the client property within the XClass.- See Also:
-
FIELD_PROJECT
The name of the project property within the XClass.- See Also:
-
FIELD_WORK_ITEM
The name of the work package property within the XClass.- See Also:
-
FIELD_CLIENT_PARAMS
The name of the client params property within the XClass.- See Also:
-
-
Constructor Details
-
ProjectManagementRelation
public ProjectManagementRelation(com.xpn.xwiki.objects.BaseObject xobject) - Parameters:
xobject- the xobject that stores the work package link information.
-
-
Method Details
-
getClient
- Returns:
- the id of the project management client. i.e. openproject.
-
setClient
- Parameters:
client- seegetClient().
-
getProject
- Returns:
- the id of the OpenProject project that is linked to a xwiki page.
-
setProject
- Parameters:
project- seegetProject().
-
getWorkItem
- Returns:
- the id of the OpenProject work package that is linked to a xwiki page.
-
setWorkItem
- Parameters:
workPackage- seegetWorkItem()()}.
-
getClientParams
- Returns:
- the stored client params in a string format. The storage format is defined by the client.
-
setClientParams
- Parameters:
clientParams- seegetClientParams().
-