hudson.scm
Class IntegrityCMProject

java.lang.Object
  hudson.scm.IntegrityCMProject

All Implemented Interfaces:

java.io.Serializable

public class IntegrityCMProject
extends java.lang.Object
implements java.io.Serializable

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

See Also:

Serialized Form

Field Summary

static java.lang.String	BUILD_PROJECT
static java.util.Comparator<IntegrityCMMember>	FILES_ORDER
static java.lang.String	NORMAL_PROJECT
static java.lang.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

com.mks.api.response.Response	addProjectLabel(APISession api, java.lang.String chkptLabel) Applies a Project Label on this Integrity CM Project
com.mks.api.response.Response	checkpoint(APISession api, java.lang.String chkptLabel) Performs a checkpoint on this Integrity CM Project
void	compareBaseline(IntegrityCMProject baselineProject, APISession api) Compares this version of the project to a previous/new version to determine what are the updates and what was deleted
java.util.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 *
java.lang.String	getChangeLog(java.lang.String version, APISession api) Returns the Change Log based on the project baseline comparison This assumes that compareBaseline() has been called already
java.lang.String	getConfigurationPath() Returns the Full Configuration Path for this Integrity CM Project
java.util.List<java.lang.String>	getDirList() Returns a string list of relative paths to all directories in this project
java.util.List<IntegrityCMMember>	getDroppedMembers() Returns the dropped members to this project based on a baseline comparison
java.util.Date	getLastCheckpointDate() Returns the date when the last checkpoint was performed on this Project
java.util.List<IntegrityCMMember>	getProjectMembers() Returns the previously parsed output from the si viewproject command to get a list of members
java.lang.String	getProjectName() Returns the project path for this Integrity CM Project
java.lang.String	getProjectRevision() Returns the project revision for this Integrity SCM Project
java.util.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
void	initializeProject(com.mks.api.response.WorkItem wi)
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(java.lang.String lineTerminator) Sets the optional line terminator option for this project
void	setRestoreTimestamp(boolean restoreTimestamp) Sets the optional restore timestamp option for this project
void	setSkipAuthorInfo(boolean skipAuthorInfo) Toggles whether or not to obtain the author using 'si revisioninfo'

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 java.lang.String NORMAL_PROJECT

See Also:

Constant Field Values

VARIANT_PROJECT

public static final java.lang.String VARIANT_PROJECT

See Also:

Constant Field Values

BUILD_PROJECT

public static final java.lang.String BUILD_PROJECT

See Also:

Constant Field Values

FILES_ORDER

public static final java.util.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

initializeProject

public void initializeProject(com.mks.api.response.WorkItem wi)

setLineTerminator

public void setLineTerminator(java.lang.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 -

setSkipAuthorInfo

public void setSkipAuthorInfo(boolean skipAuthorInfo)

Toggles whether or not to obtain the author using 'si revisioninfo'

Parameters:

skipAuthorInfo -

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,
                            APISession api)

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

Parameters:

baselineProject - The previous baseline (build) for this Integrity CM Project

api - The current MKS API Session to obtain the author information

getChangeLog

public java.lang.String getChangeLog(java.lang.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

checkpoint

public com.mks.api.response.Response checkpoint(APISession api,
                                                java.lang.String chkptLabel)
                                         throws com.mks.api.response.APIException

Performs a checkpoint on this Integrity CM Project

Parameters:

api - Authenticated MKS API Session

chkptLabel - Checkpoint label string

Returns:

MKS API Response object

Throws:

com.mks.api.response.APIException

addProjectLabel

public com.mks.api.response.Response addProjectLabel(APISession api,
                                                     java.lang.String chkptLabel)
                                              throws com.mks.api.response.APIException

Applies a Project Label on this Integrity CM Project

Parameters:

api - Authenticated MKS API Session

chkptLabel - Checkpoint label string

Returns:

MKS API Response object

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:

getDirList

public java.util.List<java.lang.String> getDirList()

Returns a string list of relative paths to all directories in this project

Returns:

getProjectMembers

public java.util.List<IntegrityCMMember> getProjectMembers()

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

Returns:

getAddedMembers

public java.util.List<IntegrityCMMember> getAddedMembers()

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

Returns:

getUpdatedMembers

public java.util.List<IntegrityCMMember> getUpdatedMembers()

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

Returns:

getDroppedMembers

public java.util.List<IntegrityCMMember> getDroppedMembers()

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

Returns:

getProjectName

public java.lang.String getProjectName()

Returns the project path for this Integrity CM Project

Returns:

getProjectRevision

public java.lang.String getProjectRevision()

Returns the project revision for this Integrity SCM 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 java.lang.String getConfigurationPath()

Returns the Full Configuration Path for this Integrity CM Project

Returns:

getLastCheckpointDate

public java.util.Date getLastCheckpointDate()

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

Returns: