com.jamasoftware.contour.ws.v3.domain
Class WsRelationship

java.lang.Object
  com.jamasoftware.contour.ws.v3.domain.WsRelationship

public class WsRelationship
extends java.lang.Object

This object represents a Contour relationship. In Contour, relationships are used to link Items together that are related, what is known as "Traceability". By creating relationships between Items, Contour allows you to easily assess the impact a change to one Item can have on other Items within the Project. This feature will help you manage change effectively and keep your team in sync during development.

Author:

Dylan

Constructor Summary

WsRelationship()
Creates an empty WsRelationship object.

WsRelationship(WsItem fromItem, WsItem toItem, WsRelationshipType relationshipType, java.lang.String relationshipStatus, java.lang.String relationshipNote)
Creates a new WsRelationship object with the given "to" item, "from" item, type, status and note.

Method Summary

WsItem	getFromItem() Gets the "From" item in the relationship.
java.lang.Long	getId() Gets the id of the relationship.
java.lang.String	getRelationshipNote() Gets the note associated with the relationship.
java.lang.String	getRelationshipStatus() Gets the relationship's status.
WsRelationshipType	getRelationshipType() Gets the relationship's type (Related To, Dependent On, etc...)
WsItem	getToItem() Gets the "To" item in the relationship.
void	setFromItem(WsItem fromItem) Sets the "From" item in the relationship.
void	setId(java.lang.Long id)
void	setRelationshipNote(java.lang.String relationshipNote) Sets the note associated with the relationship.
void	setRelationshipStatus(java.lang.String relationshipStatus) Sets the relationship's status.
void	setRelationshipType(WsRelationshipType relationshipType) Sets the relationship's type (Related To, Dependent On, etc...)
void	setToItem(WsItem toItem) Sets the "To" item in the relationship.
java.lang.String	toString() Gets a string representation of this relationship.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsRelationship

public WsRelationship()

Creates an empty WsRelationship object.

WsRelationship

public WsRelationship(WsItem fromItem,
                      WsItem toItem,
                      WsRelationshipType relationshipType,
                      java.lang.String relationshipStatus,
                      java.lang.String relationshipNote)

Creates a new WsRelationship object with the given "to" item, "from" item, type, status and note.

Parameters:

fromItem - the upstream item

toItem - the downstream item

relationshipType - relationship type

relationshipStatus - relationship status (can be null)

relationshipNote - a note about the relationship (can be null)

Method Detail

getId

public java.lang.Long getId()

Gets the id of the relationship.

Returns:

relationship id

setId

public void setId(java.lang.Long id)

getFromItem

public WsItem getFromItem()

Gets the "From" item in the relationship.

Returns:

the upstream item

setFromItem

public void setFromItem(WsItem fromItem)

Sets the "From" item in the relationship.

Parameters:

fromItem - the upstream item

getToItem

public WsItem getToItem()

Gets the "To" item in the relationship.

Returns:

the downstream item

setToItem

public void setToItem(WsItem toItem)

Sets the "To" item in the relationship.

Parameters:

toItem - the downstream item

getRelationshipType

public WsRelationshipType getRelationshipType()

Gets the relationship's type (Related To, Dependent On, etc...)

Returns:

type String

setRelationshipType

public void setRelationshipType(WsRelationshipType relationshipType)

Sets the relationship's type (Related To, Dependent On, etc...)

Parameters:

relationshipType - the relationship's type

getRelationshipStatus

public java.lang.String getRelationshipStatus()

Gets the relationship's status.

Returns:

status String

setRelationshipStatus

public void setRelationshipStatus(java.lang.String relationshipStatus)

Sets the relationship's status.

Parameters:

relationshipStatus - the relationship's type

getRelationshipNote

public java.lang.String getRelationshipNote()

Gets the note associated with the relationship.

Returns:

relationship note

setRelationshipNote

public void setRelationshipNote(java.lang.String relationshipNote)

Sets the note associated with the relationship.

Parameters:

relationshipNote - relationship note

toString

public java.lang.String toString()

Gets a string representation of this relationship.

Overrides:

toString in class java.lang.Object

Returns:

String