org.rhq.enterprise.server.content
Interface ContentUIManagerLocal

All Known Implementing Classes:

ContentUIManagerBean

public interface ContentUIManagerLocal

EJB interface for operations that support the UI for the content subsystem.

Author:

Jason Dobies

Method Summary

PageList<InstalledPackageHistory>	findInstalledPackageHistoryByCriteria(Subject subject, InstalledPackageHistoryCriteria criteria) Returns a pagable list of all package events that have taken place on the given resource.
PageList<ContentServiceRequest>	getContentRequestsWithNotStatus(Subject user, int resourceId, ContentRequestStatus status, PageControl pageControl) Returns a list of all content requests made against the specified resource that do not match the specified status.
PageList<ContentServiceRequest>	getContentRequestsWithStatus(Subject user, int resourceId, ContentRequestStatus status, PageControl pageControl) Returns a list of all content requests made against the specified resource that match the specified status.
ContentServiceRequest	getContentServiceRequest(int requestId) Retrieves a content request by its ID.
InstalledPackage	getInstalledPackage(int id) Loads the installed package identified by the ID from the database.
InstalledPackageHistory	getInstalledPackageHistory(int historyId) Retrieves a specific history entry by its ID.
PageList<InstalledPackageHistory>	getInstalledPackageHistory(int contentServiceRequestId, PageControl pc) Returns a list of installed package history entries that were created as a result of executing the indicated request.
PageList<InstalledPackageHistory>	getInstalledPackageHistory(Subject subject, int resourceId, int generalPackageId, PageControl pc)
PageList<InstalledPackageHistory>	getInstalledPackageHistoryForResource(int resourceId, PageControl pc) Returns a pagable list of all package events that have taken place on the given resource.
PageList<PackageListItemComposite>	getInstalledPackages(Subject user, int resourceId, Integer packageTypeFilterId, String packageVersionFilter, String search, PageControl pageControl) Returns a list of all installed packages on the specified resource.
List<IntegerOptionItem>	getInstalledPackageTypes(Subject user, int resourceId)
LoadedPackageBitsComposite	getLoadedPackageBitsComposite(int packageVersionId) This will return a composite object that tells you if the actual content (the "bits") for a particular package version is loaded into inventory or not, and, if the content is loaded, whether or not that content is stored in the database.
PackageInstallationStep	getPackageInstallationStep(int stepId) Retrieves a specific step entry by its ID.
List<PackageInstallationStep>	getPackageInstallationSteps(int installedPackageHistoryId) Retrieves the individual steps executed during the specified package installation history.
PackageType	getPackageType(int id) Loads the package type identified by the ID from the database.
List<PackageType>	getPackageTypes()
List<PackageType>	getPackageTypes(int resourceTypeId) Returns all package types that are available to the specified resource type.
PageList<PackageType>	getPackageTypes(int resourceTypeId, PageControl pageControl) Returns all package types that are available to the specified resource type in a page control.
PackageVersion	getPackageVersion(int packageVersionId) Retrieves a package version by its ID.
List<PackageVersionComposite>	getPackageVersionComposites(Subject user, int[] packageVersionIds) Used to retrieve information about multiple packages to display to the user.
PageList<PackageVersionComposite>	getPackageVersionComposites(Subject user, int[] packageVersionIds, PageControl pageControl) Used to retrieve information about multiple packages to display to the user.
PageList<PackageVersionComposite>	getPackageVersionCompositesByFilter(Subject user, int resourceId, String filter, PageControl pc)
PageList<PackageVersionComposite>	getUpdatePackageVersionCompositesByFilter(Subject user, int resourceId, String filter, PageControl pc)
AdvisoryDetailsComposite	loadAdvisoryDetailsComposite(Subject user, Integer id) Retrieves Advisory Details by its ID.
PackageVersionComposite	loadPackageVersionComposite(Subject user, int packageVersionId) Used to retrieve information about a package version to display to a user.
PackageVersionComposite	loadPackageVersionCompositeWithExtraProperties(Subject user, int packageVersionId) Used to retrieve information about a package version to display to a user.

Method Detail

getLoadedPackageBitsComposite

LoadedPackageBitsComposite getLoadedPackageBitsComposite(int packageVersionId)

This will return a composite object that tells you if the actual content (the "bits") for a particular package version is loaded into inventory or not, and, if the content is loaded, whether or not that content is stored in the database.

Parameters:

packageVersionId - the PackageVersion identifier

Returns:

indicates if the package version content is loaded and available

See Also:

LoadedPackageBitsComposite

getInstalledPackage

InstalledPackage getInstalledPackage(int id)

Loads the installed package identified by the ID from the database.

Parameters:

id - identifies the installed package

Returns:

installed package if one exists; null otherwise

getInstalledPackageTypes

List<IntegerOptionItem> getInstalledPackageTypes(Subject user,
                                                 int resourceId)

getPackageType

PackageType getPackageType(int id)

Loads the package type identified by the ID from the database.

Parameters:

id - package type to load

Returns:

package type if one exists for the ID; null otherwise

getPackageTypes

List<PackageType> getPackageTypes()

Returns:

all package types

getPackageTypes

List<PackageType> getPackageTypes(int resourceTypeId)

Returns all package types that are available to the specified resource type.

Parameters:

resourceTypeId - identifies the resource type

Returns:

set of package types

getPackageTypes

PageList<PackageType> getPackageTypes(int resourceTypeId,
                                      PageControl pageControl)

Returns all package types that are available to the specified resource type in a page control.

Parameters:

resourceTypeId - identifies the resource type

pageControl - paging control

Returns:

pagable list of package types

getContentRequestsWithStatus

PageList<ContentServiceRequest> getContentRequestsWithStatus(Subject user,
                                                             int resourceId,
                                                             ContentRequestStatus status,
                                                             PageControl pageControl)

Returns a list of all content requests made against the specified resource that match the specified status.

Parameters:

user - the user who is requesting the retrieval

resourceId - identifies the resource whose requests to retrieve

status - request status being matched

pageControl - pagination controller

Returns:

list of artifact requests for the specified resource

getContentRequestsWithNotStatus

PageList<ContentServiceRequest> getContentRequestsWithNotStatus(Subject user,
                                                                int resourceId,
                                                                ContentRequestStatus status,
                                                                PageControl pageControl)

Returns a list of all content requests made against the specified resource that do not match the specified status.

Parameters:

user - the user who is requesting the retrieval

resourceId - identifies the resource whose requests to retrieve

status - request status to not match

pageControl - pagination controller

Returns:

list of content requests for the specified resource

getInstalledPackages

PageList<PackageListItemComposite> getInstalledPackages(Subject user,
                                                        int resourceId,
                                                        Integer packageTypeFilterId,
                                                        String packageVersionFilter,
                                                        String search,
                                                        PageControl pageControl)

Returns a list of all installed packages on the specified resource.

Parameters:

user - the user who is requesting the retrieval

resourceId - identifies the resource whose requests to retrieve

search - string to search against filtering by name or description

pageControl - pagination controller

Returns:

pagable list of packages installed on the resource

getInstalledPackageHistory

PageList<InstalledPackageHistory> getInstalledPackageHistory(Subject subject,
                                                             int resourceId,
                                                             int generalPackageId,
                                                             PageControl pc)

getPackageVersionCompositesByFilter

PageList<PackageVersionComposite> getPackageVersionCompositesByFilter(Subject user,
                                                                      int resourceId,
                                                                      String filter,
                                                                      PageControl pc)

getUpdatePackageVersionCompositesByFilter

PageList<PackageVersionComposite> getUpdatePackageVersionCompositesByFilter(Subject user,
                                                                            int resourceId,
                                                                            String filter,
                                                                            PageControl pc)

loadPackageVersionComposite

PackageVersionComposite loadPackageVersionComposite(Subject user,
                                                    int packageVersionId)

Used to retrieve information about a package version to display to a user.

Parameters:

user - user who wants to see the information

packageVersionId - identifies what package version to return info on

Returns:

the information on the package version

loadPackageVersionCompositeWithExtraProperties

PackageVersionComposite loadPackageVersionCompositeWithExtraProperties(Subject user,
                                                                       int packageVersionId)

Used to retrieve information about a package version to display to a user. This call will also load the extra properties configuration object on the package version.

Parameters:

user - user who wants to see the information

packageVersionId - identifies what package version to return info on

Returns:

the information on the package version

getPackageVersionComposites

List<PackageVersionComposite> getPackageVersionComposites(Subject user,
                                                          int[] packageVersionIds)

Used to retrieve information about multiple packages to display to the user.

Parameters:

user - user who wants to see the information

packageVersionIds - identifies what package versions to return info on

Returns:

package version information for each package identified

getPackageVersionComposites

PageList<PackageVersionComposite> getPackageVersionComposites(Subject user,
                                                              int[] packageVersionIds,
                                                              PageControl pageControl)

Used to retrieve information about multiple packages to display to the user.

Parameters:

user - user who wants to see the information

packageVersionIds - identifies what package versions to return info on

pageControl - pagination controller

Returns:

package version information for each package identified

getPackageVersion

PackageVersion getPackageVersion(int packageVersionId)

Retrieves a package version by its ID. One and only one package version must exist for the ID; an error will be thrown if exactly one package version is not found.

Parameters:

packageVersionId - identifies the package version

Returns:

package version entity

getContentServiceRequest

ContentServiceRequest getContentServiceRequest(int requestId)

Retrieves a content request by its ID. One and only one content request must exist for the ID; an error will be thrown if exactly one content request is not found.

Parameters:

requestId - identifies the request

Returns:

content request entity

getInstalledPackageHistory

PageList<InstalledPackageHistory> getInstalledPackageHistory(int contentServiceRequestId,
                                                             PageControl pc)

Returns a list of installed package history entries that were created as a result of executing the indicated request.

Parameters:

contentServiceRequestId - identifies the request that caused the history entries

pc - pagination controller

Returns:

list of history entries

getInstalledPackageHistory

InstalledPackageHistory getInstalledPackageHistory(int historyId)

Retrieves a specific history entry by its ID. One and only one history entry must exist for the ID; an error will be thrown if exactly one history entry is not found.

Parameters:

historyId - identifies the history entry

Returns:

history entry

getPackageInstallationSteps

List<PackageInstallationStep> getPackageInstallationSteps(int installedPackageHistoryId)

Retrieves the individual steps executed during the specified package installation history.

Parameters:

installedPackageHistoryId - identifies the history entry

Returns:

list of steps; empty list if there were no steps reported

getPackageInstallationStep

PackageInstallationStep getPackageInstallationStep(int stepId)

Retrieves a specific step entry by its ID.

Parameters:

stepId - identifies the step to retrieve

Returns:

step entry

getInstalledPackageHistoryForResource

PageList<InstalledPackageHistory> getInstalledPackageHistoryForResource(int resourceId,
                                                                        PageControl pc)

Returns a pagable list of all package events that have taken place on the given resource.

Parameters:

resourceId - must refer to a valid resource in the database

pc - pagination controller

Returns:

pagable list of package change items; will not be null

findInstalledPackageHistoryByCriteria

PageList<InstalledPackageHistory> findInstalledPackageHistoryByCriteria(Subject subject,
                                                                        InstalledPackageHistoryCriteria criteria)

Returns a pagable list of all package events that have taken place on the given resource.

Parameters:

resourceId - must refer to a valid resource in the database

pc - pagination controller

Returns:

pagable list of package change items; will not be null

loadAdvisoryDetailsComposite

AdvisoryDetailsComposite loadAdvisoryDetailsComposite(Subject user,
                                                      Integer id)

Retrieves Advisory Details by its ID. One and only one must exist for the ID;

Parameters:

user - user who wants to see the information

id - identifier for advisory

Returns:

AdvisoryDetailsComposite entity