com.reqdesign.reqif

Class ExternalLink

java.lang.Object

com.reqdesign.reqif.ExternalLink

public final class ExternalLink
extends java.lang.Object

The External Links framework is documented in the ReqIF Implementation Guide. This class models this framework as a collection of ExternalLink objects accessible from the SpecObject.

Alternatively, you can get a collection of SpecObjectReference objects that refer to SpecObject objects that have at least one ExternalLink

For more information see ExternalLinks.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDesc() Returns the description of the external link as represented by the @DESC attribute value which is an optional attribute.
ExternalLinkDirection	getDirection() Returns the link direction of the external link.
java.lang.String	getLinkTechnology() Returns the link technology of the external link.
java.lang.String	getLinkType() Returns the link type of the external link.
java.lang.String	getLongName() Returns the name of the link represented by the @LONG-NAME attribute value which is a mandatory attribute.
java.lang.String	getURI() Returns the identifier of the external item e.g., the URI of a JIRA issue
void	setDesc(java.lang.String desc) Sets the description of the link.
void	setLinkDirection(ExternalLinkDirection direction) Sets the link direction
void	setLinkTechnology(java.lang.String linkTechnology) Sets the link type.
void	setLinkType(java.lang.String linkType) Sets the link type.
void	setLongName(java.lang.String longName) Sets the name of the link.
void	setURI(java.lang.String uri) Sets the identifier of the external link.

Methods inherited from class java.lang.Object

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

Method Detail

getLongName

public java.lang.String getLongName()

Returns the name of the link represented by the @LONG-NAME attribute value which is a mandatory attribute.

Returns:

the String value of the @LONG-NAME attribute, not null

setLongName

public void setLongName(java.lang.String longName)
                 throws InvalidValueException

Sets the name of the link.

Parameters:

longName - the value to set as the name of the link, not null and not empty

Throws:

InvalidValueException - if the specified value is null or empty

getURI

public java.lang.String getURI()

Returns the identifier of the external item e.g., the URI of a JIRA issue

Returns:

the String identifier of the external item, not null

setURI

public void setURI(java.lang.String uri)
            throws InvalidValueException

Sets the identifier of the external link.

Parameters:

uri - the String identifier, not null and not empty

Throws:

InvalidValueException - if the specified value is null or empty

getDesc

public java.lang.String getDesc()

Returns the description of the external link as represented by the @DESC attribute value which is an optional attribute.

Returns:

the String value of the @DESC attribute, can be null

setDesc

public void setDesc(java.lang.String desc)

Sets the description of the link.

Parameters:

desc - the value to set as the description of the link, can be null

getLinkType

public java.lang.String getLinkType()

Returns the link type of the external link.

Returns:

the link type as a String value, can be null

setLinkType

public void setLinkType(java.lang.String linkType)

Sets the link type.

Parameters:

linkType - the value to set as the link type, can be null

getLinkTechnology

public java.lang.String getLinkTechnology()

Returns the link technology of the external link.

Currently only "OSLC" is supported.

Returns:

the link technology as a String value, can be null

setLinkTechnology

public void setLinkTechnology(java.lang.String linkTechnology)

Sets the link type.

Currently only "OSLC" is supported.

Parameters:

linkTechnology - the value to set as the link type, can be null

getDirection

public ExternalLinkDirection getDirection()

Returns the link direction of the external link.

Returns:

the link direction as a value from the ExternalLinkDirection enumeration, not null

setLinkDirection

public void setLinkDirection(ExternalLinkDirection direction)

Sets the link direction

Parameters:

direction - the value to set as the link direction, can be null