Index (Project Management - Open Project

B C F G I K L O P S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

B

BaseOpenProjectObject - Class in com.xwiki.projectmanagement.openproject.model: Describes the base object for Open Project objects.
BaseOpenProjectObject() - Constructor for class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject: Default constructor.
BaseOpenProjectObject(JsonNode) - Constructor for class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject: Create a BaseOpenProjectObject from a JsonNode.

C

CLASS_FULLNAME - Static variable in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink: The String reference of the class defining the object which contains an OIDC configuration.
CLASS_REFERENCE - Static variable in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink: The local reference of the configuration class.
cleanCache() - Method in interface com.xwiki.projectmanagement.openproject.config.OpenProjectConfiguration: Clean the various caches used by the application, such as the entities retrieved from the configured Open Project instances.
ColoredOpenProjectObject - Class in com.xwiki.projectmanagement.openproject.model: Describes the Open Project entities that can have custom colors associated to them such as Status and Type.
ColoredOpenProjectObject() - Constructor for class com.xwiki.projectmanagement.openproject.model.ColoredOpenProjectObject: Default constructor.
ColoredOpenProjectObject(JsonNode) - Constructor for class com.xwiki.projectmanagement.openproject.model.ColoredOpenProjectObject: Create a ColoredOpenProjectObject from a JsonNode.
com.xwiki.projectmanagement.openproject - package com.xwiki.projectmanagement.openproject
com.xwiki.projectmanagement.openproject.config - package com.xwiki.projectmanagement.openproject.config
com.xwiki.projectmanagement.openproject.exception - package com.xwiki.projectmanagement.openproject.exception
com.xwiki.projectmanagement.openproject.model - package com.xwiki.projectmanagement.openproject.model
com.xwiki.projectmanagement.openproject.rest.document - package com.xwiki.projectmanagement.openproject.rest.document
com.xwiki.projectmanagement.openproject.script - package com.xwiki.projectmanagement.openproject.script
com.xwiki.projectmanagement.openproject.store - package com.xwiki.projectmanagement.openproject.store
createNewToken(String, String) - Method in interface com.xwiki.projectmanagement.openproject.config.OpenProjectConfiguration: Creates a new OAuth token using the specified connection name and redirect URL.
createSpace(String, String, Boolean) - Method in interface com.xwiki.projectmanagement.openproject.rest.document.OpenProjectSpaceResource: Creates the OpenProject project template at the given document reference.
createWorkPackage(String, String) - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Creates a work package in OpenProject.
CreateWorkPackage - Class in com.xwiki.projectmanagement.openproject.model: Describes the payload for creating a work package in OpenProject.
CreateWorkPackage() - Constructor for class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Default constructor.
CreateWorkPackage(String, String, String, String, String, String) - Constructor for class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Constructor.

F

FIELD_INSTANCE - Static variable in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink: The name of the instance property within the XClass.
FIELD_PRIMARY - Static variable in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink: The name of the instance property within the XClass.
FIELD_PROJECT - Static variable in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink: The name of the project property within the XClass.
FIELD_WORK_PACKAGE - Static variable in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink: The name of the work package property within the XClass.

G

generateStyling() - Method in class com.xwiki.projectmanagement.openproject.script.OpenProjectScriptService: Generate the styling for the configured instances.
getAccessTokenForConfiguration(String) - Method in interface com.xwiki.projectmanagement.openproject.config.OpenProjectConfiguration: Retrieves the server URL associated with a given connection name.
getAssignee() - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Getter for the assignee of the work package.
getAssignee() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the assignee of the work package, including their value and reference link.
getAuthor() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the author of the work package, including their value and reference link.
getAvailableProjects(String, int, int, String) - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieves a paginated list of available projects for creating work packages based on the specified page size and filter criteria from the current OpenProject configuration.
getAvailableUsers(String, int, int, String) - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieves a list of available users for creating a work package based on the specified page size and filter criteria from the current OpenProject configuration.
getClientId() - Method in class com.xwiki.projectmanagement.openproject.config.OpenProjectConnection
getClientSecret() - Method in class com.xwiki.projectmanagement.openproject.config.OpenProjectConnection
getColor() - Method in class com.xwiki.projectmanagement.openproject.model.ColoredOpenProjectObject
getConnection(String) - Method in interface com.xwiki.projectmanagement.openproject.config.OpenProjectConfiguration: Retrieves the server URL associated with a given connection name.
getConnectionName() - Method in class com.xwiki.projectmanagement.openproject.config.OpenProjectConnection
getConnectionOptions() - Method in class com.xwiki.projectmanagement.openproject.script.OpenProjectScriptService: Retrieves a list of available OpenProject connections.
getContentType() - Method in class com.xwiki.projectmanagement.openproject.model.UserAvatar
getCreatedAt() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the creation timestamp of the work package.
getDerivedDueDate() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the derived due date of the work package.
getDerivedStartDate() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the derived start date of the work package.
getDescription() - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Getter for the description of the work package.
getDescription() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the description of the work package.
getDocument(String, String, Boolean, Boolean, Boolean, Boolean) - Method in interface com.xwiki.projectmanagement.openproject.rest.document.OpenProjectDocumentResource: Retrieve the reference of a document given its unique identifier.
getDueDate() - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Getter for the due date of the work package.
getDueDate() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the due date of the work package.
getId() - Method in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject
getInstance() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackageLink
getInstance() - Method in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink
getMapEntries() - Method in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject
getName() - Method in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject
getName() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage
getOpenProjectApiClient(String) - Method in interface com.xwiki.projectmanagement.openproject.config.OpenProjectConfiguration: Provides an instance of OpenProjectApiClient for interacting with the OpenProject API.
getOpenProjectConnections() - Method in interface com.xwiki.projectmanagement.openproject.config.OpenProjectConfiguration: Retrieves a list of available OpenProject connections.
getPercentageDone() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the percentage done for the work package.
getPriorities() - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieves all available priorities from the current OpenProject configuration.
getPriority() - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Getter for the priority of the work package.
getPriority() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the priority of the work package, including its value and reference link.
getProject() - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Getter for the project identifier.
getProject() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the progress associated with the work package, including its reference.
getProject() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackageLink
getProject() - Method in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink
getProjects(int, int, String) - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieves a paginated list of available projects based on the specified page size and filter criteria from the current OpenProject configuration.
getProjects(String, String, Boolean, Integer, Integer, String, String, Boolean) - Method in interface com.xwiki.projectmanagement.openproject.rest.document.OpenProjectLinkSearchResource
getProjectWorkPackages(String, int, int, String, String) - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieves a list of available work packages from the current OpenProject configuration and specified project.
getSelf() - Method in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject: Gets the reference to itself, including their value and reference link.
getServerURL() - Method in class com.xwiki.projectmanagement.openproject.config.OpenProjectConnection
getStartDate() - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Getter for the start date of the work package.
getStartDate() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the start date of the work package.
getStatus() - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Getter for the status of the work package.
getStatus() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the status of the work package, including its value and reference link.
getStatuses() - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieves all available statuses from the current OpenProject configuration.
getStreamingOutput() - Method in class com.xwiki.projectmanagement.openproject.model.UserAvatar
getSubject() - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Getter for the subject of the work package.
getSubject() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the subject or title of the work package.
getType() - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Getter for the type of the work package.
getType() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the internal type of the work package.
getTypeOfWorkPackage() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the type of work package, which includes its value and reference link.
getTypes() - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieves all available types from the current OpenProject configuration.
getUpdatedAt() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Gets the last updated timestamp of the work package.
getUserAvatar(String) - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieve the user avatar.
getUsers(int, int, String) - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieves a list of available users based on the specified page size and filter criteria from the current OpenProject configuration.
getWorkPackage() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackageLink
getWorkPackage() - Method in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink
getWorkPackages(int, int, String, String) - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieves a list of available work packages from the current OpenProject configuration.
getWorkPackages(String, String, Boolean, Integer, Integer, String, String, Boolean) - Method in interface com.xwiki.projectmanagement.openproject.rest.document.OpenProjectLinkSearchResource
getWorkPackagesFormResponse(String) - Method in interface com.xwiki.projectmanagement.openproject.OpenProjectApiClient: Retrieves work packages form response.

I

initializeSelfWithPath(String, String) - Method in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject: Initializes the self link of the object from a connection URL and a resource path.
isPrimary() - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackageLink
isPrimary() - Method in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink
isUserAuthorized(String) - Method in class com.xwiki.projectmanagement.openproject.script.OpenProjectScriptService

K

KEY_COLOR - Static variable in class com.xwiki.projectmanagement.openproject.model.ColoredOpenProjectObject: The key that retrieves the color attribute of this entity.
KEY_ID - Static variable in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject: The key identifying the id property of the open project object.
KEY_NAME - Static variable in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject: The key identifying the name property of the open project object.

L

link(String, String, Boolean, Boolean, WorkPackageLink) - Method in interface com.xwiki.projectmanagement.openproject.rest.document.OpenProjectLinkObjectsResource: Creates the link between an xwiki page and an OpenProject entity.

O

OpenProjectApiClient - Interface in com.xwiki.projectmanagement.openproject: Defines the methods that a OpenProject api client should implement.
OpenProjectConfiguration - Interface in com.xwiki.projectmanagement.openproject.config: Provides methods for retrieving OpenProject configuration properties and access tokens.
OpenProjectConnection - Class in com.xwiki.projectmanagement.openproject.config: Represents the connection configuration for an OpenProject instance.
OpenProjectConnection(String, String, String, String) - Constructor for class com.xwiki.projectmanagement.openproject.config.OpenProjectConnection: Constructs a new OpenProjectConnection with the provided values.
OpenProjectDocumentResource - Interface in com.xwiki.projectmanagement.openproject.rest.document: Resource for creating and retrieving document based on unique identifiers.
OpenProjectLinkObjectsResource - Interface in com.xwiki.projectmanagement.openproject.rest.document: Resource for creating the link to an Open Project entity.
OpenProjectLinkSearchResource - Interface in com.xwiki.projectmanagement.openproject.rest.document: Resource for retrieving pages containing WorkPackageLink to an Open Project entity.
OpenProjectScriptService - Class in com.xwiki.projectmanagement.openproject.script
OpenProjectScriptService() - Constructor for class com.xwiki.projectmanagement.openproject.script.OpenProjectScriptService
OpenProjectSpaceResource - Interface in com.xwiki.projectmanagement.openproject.rest.document: Resource for handling the OpenProject integration spaces.

P

Priority - Class in com.xwiki.projectmanagement.openproject.model: Describes the priority object of a work package.
Priority() - Constructor for class com.xwiki.projectmanagement.openproject.model.Priority: Default constructor.
Priority(JsonNode) - Constructor for class com.xwiki.projectmanagement.openproject.model.Priority: Create a Priority object from a JsonNode.
Project - Class in com.xwiki.projectmanagement.openproject.model: Describes the project object of a work package.
Project() - Constructor for class com.xwiki.projectmanagement.openproject.model.Project: Default constructor.
Project(JsonNode) - Constructor for class com.xwiki.projectmanagement.openproject.model.Project: Create a Project object from a JsonNode.
putEntry(String, Object) - Method in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject

S

setAssignee(Linkable) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the assignee of the work package, including their value and reference link.
setAssignee(String) - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Setter for the assignee of the work package.
setAuthor(Linkable) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the author of the work package, including their value and reference link.
setClientId(String) - Method in class com.xwiki.projectmanagement.openproject.config.OpenProjectConnection: Sets the client ID used for authentication.
setClientSecret(String) - Method in class com.xwiki.projectmanagement.openproject.config.OpenProjectConnection: Sets the client secret used for authentication.
setColor(String) - Method in class com.xwiki.projectmanagement.openproject.model.ColoredOpenProjectObject
setConnectionName(String) - Method in class com.xwiki.projectmanagement.openproject.config.OpenProjectConnection: Sets the name of this connection configuration.
setContentType(String) - Method in class com.xwiki.projectmanagement.openproject.model.UserAvatar
setCreatedAt(Date) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the creation timestamp of the work package.
setDerivedDueDate(Date) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the derived due date of the work package.
setDerivedStartDate(Date) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the derived start date of the work package.
setDescription(String) - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Setter for the description of the work package.
setDescription(String) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the description of the work package.
setDueDate(String) - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Setter for the due date of the work package.
setDueDate(Date) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the due date of the work package.
setId(int) - Method in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject
setInstance(String) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackageLink
setInstance(String) - Method in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink
setName(String) - Method in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject
setName(String) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage
setPercentageDone(Integer) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the percentage done for the work package.
setPrimary(boolean) - Method in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink
setPrimary(Boolean) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackageLink
setPriority(Linkable) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the priority of the work package, including its value and reference link.
setPriority(String) - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Setter for the priority.
setProject(Linkable) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the project associated with the work package.
setProject(String) - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Setter for the project.
setProject(String) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackageLink
setProject(String) - Method in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink
setSelf(Linkable) - Method in class com.xwiki.projectmanagement.openproject.model.BaseOpenProjectObject: Sets the reference to itself, including their value and reference link.
setServerURL(String) - Method in class com.xwiki.projectmanagement.openproject.config.OpenProjectConnection: Sets the URL of the OpenProject server.
setStartDate(String) - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Setter for the start date of the work package.
setStartDate(Date) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the start date of the work package.
setStatus(Linkable) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the status of the work package, including its value and reference link.
setStatus(String) - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Setter for the status of the work package.
setStreamingOutput(StreamingOutput) - Method in class com.xwiki.projectmanagement.openproject.model.UserAvatar
setSubject(String) - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Setter for the subject.
setSubject(String) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the subject or title of the work package.
setType(String) - Method in class com.xwiki.projectmanagement.openproject.model.CreateWorkPackage: Setter for the type of the work package.
setType(String) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the internal type of the work package.
setTypeOfWorkPackage(Linkable) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the type of work package, including its value and reference link.
setUpdatedAt(Date) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackage: Sets the last updated timestamp of the work package.
setWorkPackage(String) - Method in class com.xwiki.projectmanagement.openproject.model.WorkPackageLink
setWorkPackage(String) - Method in class com.xwiki.projectmanagement.openproject.store.WorkPackageLink
Status - Class in com.xwiki.projectmanagement.openproject.model: Describes the type object of a work package.
Status() - Constructor for class com.xwiki.projectmanagement.openproject.model.Status: Default constructor.
Status(JsonNode) - Constructor for class com.xwiki.projectmanagement.openproject.model.Status: Create a Status object from a JsonNode.

T

Type - Class in com.xwiki.projectmanagement.openproject.model: Describes the type object of a work package.
Type() - Constructor for class com.xwiki.projectmanagement.openproject.model.Type: Default constructor.
Type(JsonNode) - Constructor for class com.xwiki.projectmanagement.openproject.model.Type: Create a Type object from a JsonNode.

U

updateDocument(String, String, Boolean, Page) - Method in interface com.xwiki.projectmanagement.openproject.rest.document.OpenProjectDocumentResource: Updates or creates a xwiki document based on an unique identifier.
User - Class in com.xwiki.projectmanagement.openproject.model: Describes the user object of a work package.
User() - Constructor for class com.xwiki.projectmanagement.openproject.model.User: Default constructor.
User(JsonNode) - Constructor for class com.xwiki.projectmanagement.openproject.model.User: Create a User object from a JsonNode.
UserAvatar - Class in com.xwiki.projectmanagement.openproject.model: Models the response of a UserAvatar coming from Open Project.
UserAvatar(StreamingOutput, String) - Constructor for class com.xwiki.projectmanagement.openproject.model.UserAvatar

W

WorkPackage - Class in com.xwiki.projectmanagement.openproject.model: Describes a Work package related to OpenProject.
WorkPackage() - Constructor for class com.xwiki.projectmanagement.openproject.model.WorkPackage
WorkPackageLink - Class in com.xwiki.projectmanagement.openproject.model: The model of a link to a work package.
WorkPackageLink - Class in com.xwiki.projectmanagement.openproject.store: The base object wrapper that enables the manipulation if Work Package links.
WorkPackageLink() - Constructor for class com.xwiki.projectmanagement.openproject.model.WorkPackageLink
WorkPackageLink(BaseObject) - Constructor for class com.xwiki.projectmanagement.openproject.store.WorkPackageLink
WorkPackageRetrievalBadRequestException - Exception in com.xwiki.projectmanagement.openproject.exception: Exception thrown when the parameters used to retrieve WorkPackages from the OpenProject API are invalid or improperly formatted, resulting in a 400 Bad Request response.
WorkPackageRetrievalBadRequestException(String) - Constructor for exception com.xwiki.projectmanagement.openproject.exception.WorkPackageRetrievalBadRequestException
WorkPackageRetrievalBadRequestException(String, Throwable) - Constructor for exception com.xwiki.projectmanagement.openproject.exception.WorkPackageRetrievalBadRequestException

B C F G I K L O P S T U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form