Interface PackageVersion
@NonExtendable
public interface PackageVersion
Definition for accessing version information of a package.
- Since:
- 3.1.158
-
Method Summary
Modifier and TypeMethodDescriptionvoidactivateCustomEvent(String customEventName) Deprecated, for removal: This API element is subject to removal in a future version.since 5.0.39 - no replacementvoidaddDependentPackage(Package dependentPackage) Adds a dependent package to this version.voidaddPublishGroup(PublishGroup group) Adds the given PublishGroup to the Set of publish groups this PackageVersion is published for.voiddeactivateCustomEvent(String customEventName) Deprecated, for removal: This API element is subject to removal in a future version.since 5.0.39 - no replacementDeprecated, for removal: This API element is subject to removal in a future version.since 5.0.39 - no replacementReturns the comment of this PackageVersion.Returns the date when this PackageVersion was created.Provides a set of all dependent packages of this version.Returns a read-only Set ofPublishGroup's this PackageVersion is published for.getTag()Returns the user defined version TAG.intReturns the version of this PackageVersion.booleanisUpdate()Indicates whether this package version is an update version or not.voidremoveDependentPackage(Package packageToRemove) Removes a dependent package from this version.voidremovePublishGroup(PublishGroup group) Removes the given PublishGroup from the Set of publish groups this PackageVersion is published forvoidsetComment(String comment) Sets the comment of this PackageVersion.voidSets the user defined version TAG of this package version.
-
Method Details
-
getVersion
int getVersion()Returns the version of this PackageVersion. This version number is the version number of the belonging package at creation moment of this PackageVersion.- Returns:
- the version of this package
- Since:
- 3.1.158
-
getTag
String getTag()Returns the user defined version TAG.- Returns:
- the version TAG
- Since:
- 3.1.158
-
setTag
Sets the user defined version TAG of this package version.- Parameters:
tag-- Since:
- 3.1.158
-
getComment
String getComment()Returns the comment of this PackageVersion.- Returns:
- String the comment
- Since:
- 3.1.158
-
setComment
Sets the comment of this PackageVersion.- Parameters:
comment- the comment String- Since:
- 3.1.158
-
isUpdate
boolean isUpdate()Indicates whether this package version is an update version or not.- Returns:
trueif this package version is an update version,falseotherwise.- Since:
- 4.2.455
-
getCreationDate
Calendar getCreationDate()Returns the date when this PackageVersion was created.- Returns:
- creationDate
- Since:
- 3.1.158
-
getPublishGroups
Set<PublishGroup> getPublishGroups()Returns a read-only Set ofPublishGroup's this PackageVersion is published for.- Returns:
- read-only Set of
PublishGroup's - Since:
- 3.1.158
-
addPublishGroup
Adds the given PublishGroup to the Set of publish groups this PackageVersion is published for.- Parameters:
group- the PublishGroup to add- Since:
- 3.1.158
-
removePublishGroup
Removes the given PublishGroup from the Set of publish groups this PackageVersion is published for- Parameters:
group- the PublishGroup to remove- Since:
- 3.1.158
-
getActivatedCustomEvents
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0.39 - no replacementAlways returns an empty set.- Returns:
- An empty set.
-
activateCustomEvent
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0.39 - no replacementDoes nothing.- Parameters:
customEventName- A name.
-
deactivateCustomEvent
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0.39 - no replacementDoes nothing.- Parameters:
customEventName- A name.
-
addDependentPackage
Adds a dependent package to this version.- Parameters:
dependentPackage- A package.- Since:
- 3.1.170
-
removeDependentPackage
Removes a dependent package from this version.- Parameters:
packageToRemove- A package.- Since:
- 3.1.170
-
getDependentPackages
Provides a set of all dependent packages of this version.- Returns:
- A set of packages.
- Since:
- 3.1.170
-