com.prosyst.mprm.admin.system

Interface BackendBundlePack

public interface BackendBundlePack

Represents a bundle package(pack) stored in the system database. Provides access to information about this pack available via the package manifest file like identification, version and dependencies on other packs.

Version:

1.0.0

Author:

Kaloyan Radev

Method Summary

Modifier and Type	Method and Description
BackendBundle[]	getBundles() Returns information about bundles included in this pack.
java.lang.String	getName() Returns the name of the pack.
java.util.Dictionary	getPackDependencies() Returns information about packages this package depends on.
java.lang.String	getVersion() Returns the version of the pack.
boolean	isActive() Returns whether this pack has been activated.
void	setActive(boolean enabled) Sets the active state of this bundle package.
void	setBundleEnabled(java.lang.String bundleLocation, boolean enabled) This method enables specified bundle from this pack to be installed when the pack is installed.

Method Detail

getName

java.lang.String getName()

Returns the name of the pack.

Returns:

the pack's name. If not set null is returned.

getVersion

java.lang.String getVersion()

Returns the version of the pack.

Returns:

the pack's version. If not set null is returned.

getPackDependencies

java.util.Dictionary getPackDependencies()

Returns information about packages this package depends on.

Returns:

a Dictionary object, holding as keys the names of the packs and String array values of versions. If the pack does not depend on other packs the value must be an empty array.

getBundles

BackendBundle[] getBundles()
                    throws CommunicationException,
                           java.lang.Exception

Returns information about bundles included in this pack.

Returns:

an array of BackendBundle objects, representing bundles included in this pack.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

isActive

boolean isActive()

Returns whether this pack has been activated.

Returns:

true if the pack is active and false otherwise.

setActive

void setActive(boolean enabled)
        throws CommunicationException,
               java.lang.Exception

Sets the active state of this bundle package.

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception

setBundleEnabled

void setBundleEnabled(java.lang.String bundleLocation,
                      boolean enabled)
               throws CommunicationException,
                      java.lang.Exception

This method enables specified bundle from this pack to be installed when the pack is installed. If this bundle is not optional the method should simply return.

Parameters:

bundleLocation - location of the bundle

enabled - requires enable state of the bundle

Throws:

{@link - CommunicationException} is thrown if communication with the remote Control Center fails.

Exception - is thrown if some other error occurs.

CommunicationException

java.lang.Exception