Package lumis.portal.project

Interface IProjectManager

All Known Subinterfaces:

IProjectManagerSPI

All Known Implementing Classes:

ProjectManager

@StableMinor(version="17.0",
             sinceVersion="17.0")
public interface IProjectManager

Manages LumisXP projects.

Since:

17.0.0

Version:

$Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

Method Summary

Modifier and Type	Method	Description
java.util.Collection<IProject>	getAllProjects()	Returns all projects.
java.util.Optional<IProject>	getProjectByChannelId(java.lang.String channelId)	Returns an optional project based on the given channel identifier.
default java.util.Optional<IProject>	getProjectByServiceInstanceId(java.lang.String serviceInstanceId)	Returns an optional project based on the given service instance identifier.
java.util.Optional<IProject>	getProjectByWebsiteId(java.lang.String websiteId)	Returns an optional project based on the given website identifier.

Method Detail

getAllProjects

java.util.Collection<IProject> getAllProjects()
                                       throws PortalException

Returns all projects.

Returns:

all projects.

Throws:

PortalException - if some error occur.

Since:

17.0.0

getProjectByWebsiteId

java.util.Optional<IProject> getProjectByWebsiteId(java.lang.String websiteId)
                                            throws PortalException

Returns an optional project based on the given website identifier. The optional will not be present if no such project could be found. This operation tries to find the project recursively among the given website's channel and all its parents.

Parameters:

websiteId - the website identifier.

Returns:

an optional project based on the given website identifier.

Throws:

PortalException - if some error occur.

Since:

17.0.0

getProjectByChannelId

java.util.Optional<IProject> getProjectByChannelId(java.lang.String channelId)
                                            throws PortalException

Returns an optional project based on the given channel identifier. The optional will not be present if no such project could be found. This operation tries to find the project recursively among the given channel and all its parents.

Parameters:

channelId - the channel identifier.

Returns:

an optional project based on the given channel identifier.

Throws:

PortalException - if some error occur.

Since:

17.0.0

getProjectByServiceInstanceId

default java.util.Optional<IProject> getProjectByServiceInstanceId(java.lang.String serviceInstanceId)
                                                            throws PortalException

Returns an optional project based on the given service instance identifier. The optional will not be present if no such project could be found. This operation tries to find the project recursively among the parent channels of the given service instance.

Parameters:

serviceInstanceId - the service instance identifier.

Returns:

an optional project based on the given service instance identifier.

Throws:

PortalException - if some error occur.

Since:

17.0.0