hudson.scm
Class IntegrityCMProject

java.lang.Object
  hudson.scm.IntegrityCMProject

All Implemented Interfaces:

Serializable

public class IntegrityCMProject
extends Object
implements Serializable

This class represents a MKS Integrity Configuration Management Project Provides metadata information about a Project

See Also:

Serialized Form

Field Summary

static String	BUILD_PROJECT
static Comparator<IntegrityCMMember>	FILES_ORDER
static String	NORMAL_PROJECT
static String	VARIANT_PROJECT

Constructor Summary

IntegrityCMProject(com.mks.api.response.WorkItem wi)
Creates an instance of an Integrity CM Project and extracts all information from the API Response Field

Method Summary

void	compareBaseline(IntegrityCMProject baselineProject) Compares this version of the project to a previous/new version to determine what are the updates and what was deleted
List<IntegrityCMMember>	getAddedMembers() Returns the newly added members to this project based on a baseline comparison
int	getChangeCount() Returns the total number of changes found from the baseline comparison This assumes that compareBaseline() has been called already *
String	getChangeLog(String version, APISession api) Returns the Change Log based on the project baseline comparison This assumes that compareBaseline() has been called already
String	getConfigurationPath() Returns the Full Configuration Path for this Integrity CM Project
List<IntegrityCMMember>	getDroppedMembers() Returns the dropped members to this project based on a baseline comparison
Date	getLastCheckpointDate() Returns the date when the last checkpoint was performed on this Project
List<IntegrityCMMember>	getProjectMembers() Returns the previously parsed output from the si viewproject command to get a list of members
String	getProjectName() Returns the project path for this Integrity CM Project
List<IntegrityCMMember>	getUpdatedMembers() Returns the updated members to this project based on a baseline comparison
boolean	hasProjectChanged() Determines whether this project has changed based on a baseline comparison This assumes that compareBaseline() has been called already
boolean	isBuild() Returns true if this is a Build Project
boolean	isNormal() Returns true is this is a Normal Project
boolean	isVariant() Returns true if this is a Variant Project
void	parseProject(com.mks.api.response.WorkItemIterator wit, APISession api) Parses the output from the si viewproject command to get a list of members
void	setLineTerminator(String lineTerminator) Sets the optional line terminator option for this project
void	setRestoreTimestamp(boolean restoreTimestamp) Sets the optional restore timestamp option for this project

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NORMAL_PROJECT

public static final String NORMAL_PROJECT

See Also:

Constant Field Values

VARIANT_PROJECT

public static final String VARIANT_PROJECT

See Also:

Constant Field Values

BUILD_PROJECT

public static final String BUILD_PROJECT

See Also:

Constant Field Values

FILES_ORDER

public static final Comparator<IntegrityCMMember> FILES_ORDER

Constructor Detail

IntegrityCMProject

public IntegrityCMProject(com.mks.api.response.WorkItem wi)

Creates an instance of an Integrity CM Project and extracts all information from the API Response Field

Parameters:

wi - Work Item associated with the response from running si projectinfo

Method Detail

setLineTerminator

public void setLineTerminator(String lineTerminator)

Sets the optional line terminator option for this project

Parameters:

lineTerminator -

setRestoreTimestamp

public void setRestoreTimestamp(boolean restoreTimestamp)

Sets the optional restore timestamp option for this project

Parameters:

restoreTimestamp -

parseProject

public void parseProject(com.mks.api.response.WorkItemIterator wit,
                         APISession api)
                  throws com.mks.api.response.APIException

Parses the output from the si viewproject command to get a list of members

Parameters:

wit - WorkItemIterator

api - The current MKS API Session

Throws:

com.mks.api.response.APIException

compareBaseline

public void compareBaseline(IntegrityCMProject baselineProject)

Compares this version of the project to a previous/new version to determine what are the updates and what was deleted

Parameters:

baselineProject -

getChangeLog

public String getChangeLog(String version,
                           APISession api)
                    throws com.mks.api.response.APIException

Returns the Change Log based on the project baseline comparison This assumes that compareBaseline() has been called already

Returns:

Throws:

com.mks.api.response.APIException

hasProjectChanged

public boolean hasProjectChanged()

Determines whether this project has changed based on a baseline comparison This assumes that compareBaseline() has been called already

Returns:

getChangeCount

public int getChangeCount()

Returns the total number of changes found from the baseline comparison This assumes that compareBaseline() has been called already *

Returns:

getProjectMembers

public List<IntegrityCMMember> getProjectMembers()

Returns the previously parsed output from the si viewproject command to get a list of members

Returns:

getAddedMembers

public List<IntegrityCMMember> getAddedMembers()

Returns the newly added members to this project based on a baseline comparison

Returns:

getUpdatedMembers

public List<IntegrityCMMember> getUpdatedMembers()

Returns the updated members to this project based on a baseline comparison

Returns:

getDroppedMembers

public List<IntegrityCMMember> getDroppedMembers()

Returns the dropped members to this project based on a baseline comparison

Returns:

getProjectName

public String getProjectName()

Returns the project path for this Integrity CM Project

Returns:

isNormal

public boolean isNormal()

Returns true is this is a Normal Project

Returns:

isVariant

public boolean isVariant()

Returns true if this is a Variant Project

Returns:

isBuild

public boolean isBuild()

Returns true if this is a Build Project

Returns:

getConfigurationPath

public String getConfigurationPath()

Returns the Full Configuration Path for this Integrity CM Project

Returns:

getLastCheckpointDate

public Date getLastCheckpointDate()

Returns the date when the last checkpoint was performed on this Project

Returns: