com.microfocus.da.sct.interfaces

Interface ComponentInfo

public interface ComponentInfo

Interface for providing the information about a Component and its versions to the CommonIntegrator

Author:

Serena Software, Inc., a Micro Focus Company

Method Summary

Modifier and Type	Method and Description
List<VersionInfo>	getAllVersions() This method returns all the versions associated with this component.
UUID	getComponentId() This method returns the unique identifier of the component.
String	getComponentName() This method returns the name of the component this ComponentInfo is associated with.
VersionInfo	getLatestVersion() This method returns the VersionInfo composition object from the latest version created for this component.
VersionInfo	getVersionByName(String name) This method returns the VersionInfo composition object from the version with the specified name.
FileEntry	getVersionContent(VersionInfo versionInfo) This method returns a FileEntry interface composition object that contains all the necessary meta information.

Method Detail

getComponentId

UUID getComponentId()

This method returns the unique identifier of the component.

Returns:

The UUID of the component

getComponentName

String getComponentName()

This method returns the name of the component this ComponentInfo is associated with.

Returns:

The name of the component

getLatestVersion

VersionInfo getLatestVersion()

This method returns the VersionInfo composition object from the latest version created for this component.

Returns:

The VersionInfo composition object

getVersionByName

VersionInfo getVersionByName(String name)

This method returns the VersionInfo composition object from the version with the specified name.

Parameters:

name - Name of the version within the component

Returns:

The VersionInfo composition object if a version with the provided name exists, null otherwise

getAllVersions

List<VersionInfo> getAllVersions()

This method returns all the versions associated with this component. This call can be process intensive, so call it only when it is really needed.

Returns:

A list of VersionInfo objects

getVersionContent

FileEntry getVersionContent(VersionInfo versionInfo)

This method returns a FileEntry interface composition object that contains all the necessary meta information. This can be used at implementation time to compare file information, such as path and last modified date and size.

Parameters:

versionInfo - Contains required version information for creating a FileEntry

Returns:

A FileEntry Interface composition object containing file meta information