scm.pub.transport
Class ChangeRequestCreator_d

java.lang.Object
  scm.pub.transport.ChangeRequestCreator_d

public final class ChangeRequestCreator_d

extends java.lang.Object

ChangeRequestCreator_d. Use an instance of this class and the Project gateway to create a new ChangeRequest in the system.

ChangeRequestCreator_d

public ChangeRequestCreator_d(java.lang.String creator,
                              java.lang.String assignee,
                              java.lang.String header,
                              java.lang.String description,
                              java.lang.String creationState,
                              java.lang.String assignedState,
                              java.lang.String assignedGeneric,
                              java.util.HashMap attributes)
                       throws InvalidUser

Create a ChangeRequest_d object from a persisten ChangeRequest_p.

Parameters:

creator - The user that is creating this CR.

assignee - The user that this CR is to be assigned to.

header - The header information for this CR. This is usually limited to a single line of text.

description - The multi-line description for this CR.

creationState - The current project life-cycle state. For instance, if the current project is in the "Testing" phase, then this attribute would be set to "Testing".

assignedState - The phase in the development life-cycle that this CR should be set to.

assignedGeneric - The generic/branch that this CR should be assigned to.

attributes - A HashMap of attribute/value pairs for this CR.

Throws:

InvalidUser - If the user information is incorrect.

getAssignedGeneric

public java.lang.String getAssignedGeneric()

Get the assigned generic information for this CR.

Returns:

The assigned generic information as a String.

getAttributes

public java.util.HashMap getAttributes()

Get the attribute/value pairs for this CR.

Returns:

The attribute/value pairs as a HashMap.

getAssignedState

public java.lang.String getAssignedState()

Get the assigned state information for this CR.

Returns:

The assigned state information as a String.

getCreationState

public java.lang.String getCreationState()

Get the creation state information for this CR.

Returns:

The creation state information as a String.

getAssignee

public java.lang.String getAssignee()

Get the assignee information for this CR.

Returns:

The assignee information as a String.

getCreator

public java.lang.String getCreator()

Get the creator information for this CR.

Returns:

The creator information as a String.

getDescription

public java.lang.String getDescription()

Get the description information for this CR.

Returns:

The description information as a String.

getHeader

public java.lang.String getHeader()

Get the header information for this CR.

Returns:

The header information as a String.

setAttributeAndValue

public void setAttributeAndValue(java.lang.String attribute,
                                 java.lang.String value)

Add a CR attribute/value pair to this CR. CR attributes and values are well defined for a particular project. Use the Project object to get the applicable values for the parameters to this call.

Parameters:

attribute - An attribute for this CR.

value - The value of the supplied attribute.

setCreatedState

public void setCreatedState(java.lang.String state)

Set the Creation state for this CR

Parameters:

state - The creation state for a CR does not have to match the assigned state for the CR. The creation state is an indication of the current state of development that this CR was created in.

setAssignedState

public void setAssignedState(java.lang.String state)

Set the assigned state for this CR. The assigned state can be any within the projects associated life-cycle. Use the Project object to get a complete list of possible states.

Parameters:

state - The state to assign this CR to.

setHeader

public void setHeader(java.lang.String header)

Set the head for this CR

Parameters:

header - The header information for this CR. Normally the header is no more than one (1) line long.

setDescription

public void setDescription(java.lang.String desc)

Set the description for this CR

Parameters:

desc - The Description for a CR is any amount of text and can include embedded new lines.

setGeneric

public void setGeneric(java.lang.String generic)

Set the assigned generic for this CR

Parameters:

generic - The generic that this CR should be assigned to.