com.reqdesign.reqif

Class ReqIFHeader

java.lang.Object

com.reqdesign.reqif.ReqIFHeader

public final class ReqIFHeader
extends java.lang.Object

This class represents the REQ-IF-HEADER element within a ReqIF file.

This header contains a number of child elements and takes the following form:

     <REQ-IF-HEADER IDENTIFIER="...">
         <COMMENT>...</COMMENT>                xsd:string, optional
         <CREATION-TIME>...</CREATION-TIME>    xsd:dateTime, required
         <REPOSITORY-ID>...</REPOSITORY-ID>    xsd:string, optional
         <REQ-IF-TOOL-ID>...</REQ-IF-TOOL-ID>  xsd:string, required
         <REQ-IF-VERSION>1.0</REQ-IF-VERSION>  xsd:string, required
         <SOURCE-TOOL-ID>...</SOURCE-TOOL-ID>  xsd:string, required
         <TITLE>...</TITLE>                    xsd:string, required
     </REQ-IF-HEADER>
 

Constructor Summary

Constructors

Constructor and Description
ReqIFHeader(ReqIFFile reqIFFile, java.lang.String filename, java.lang.String comment, java.util.Date creationTime, java.lang.String repositoryId, java.lang.String reqIFToolId, java.lang.String sourceToolId, java.lang.String title, java.lang.String reqIFIdentifier)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComment() Optional comment associated with the Exchange Document as a whole.
java.util.Date	getCreationTime() Gets the time of creation of the exchange XML document in the format of the XML Schema data type "dateTime" which specifies the time format as CCYY-MM-DDThh:mm:ss with optional time zone indicator as a suffix ±hh:mm.
java.lang.String	getCreationTimeText() Gets the time of creation of the exchange XML document in the format of the XML Schema data type "dateTime" which specifies the time format as CCYY-MM-DDThh:mm:ss with optional time zone indicator as a suffix ±hh:mm.
java.lang.String	getIdentifier() The ReqIF identifier (mandatory)
java.lang.String	getRepositoryId() Optional unique identifier of the repository containing the requirements that have been exported.
java.lang.String	getReqIFToolId() Identifier of the exporting ReqIF tool
java.lang.String	getReqIFVersion() ReqIF interchange format and protocol version.
java.lang.String	getSourceToolId() Identifier of the exporting requirements management tool (required)
java.lang.String	getTitle() Title of the Exchange Document.
void	setComment(java.lang.String comment) Sets the ReqIF comment to the supplied value.
void	setCreationTime(java.util.Date creationTime) Sets the time of creation of the exchange XML document in the format of the XML Schema data type "dateTime" which specifies the time format as CCYY-MM-DDThh:mm:ss with optional time zone indicator as a suffix ±hh:mm.
void	setCreationTimeText(java.lang.String creationTimeText) Sets the time of creation of the exchange XML document in the format of the XML Schema data type "dateTime" which specifies the time format as CCYY-MM-DDThh:mm:ss with optional time zone indicator as a suffix ±hh:mm.
void	setCreationTimetoNow() Sets the time of creation of the exchange XML document in the format of the XML Schema data type "dateTime" to now.
void	setIdentifier(java.lang.String reqIFIdentifier) Sets the ReqIF identifier to the supplied value
void	setRepositoryId(java.lang.String repositoryId) Sets the Repository ID to the specified value
void	setReqIFToolId(java.lang.String reqIFToolId) Sets the ReqIF Tool Id.
void	setSourceToolId(java.lang.String sourceToolId)
void	setTitle(java.lang.String title) Sets the exchange document title.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReqIFHeader

public ReqIFHeader(ReqIFFile reqIFFile,
                   java.lang.String filename,
                   java.lang.String comment,
                   java.util.Date creationTime,
                   java.lang.String repositoryId,
                   java.lang.String reqIFToolId,
                   java.lang.String sourceToolId,
                   java.lang.String title,
                   java.lang.String reqIFIdentifier)
            throws InvalidIdentifierException,
                   InvalidValueException

Throws:

InvalidIdentifierException

InvalidValueException

Method Detail

getIdentifier

public java.lang.String getIdentifier()

The ReqIF identifier (mandatory)

Returns:

the ReqIF identifier

setIdentifier

public void setIdentifier(java.lang.String reqIFIdentifier)
                   throws InvalidIdentifierException

Sets the ReqIF identifier to the supplied value

Parameters:

reqIFIdentifier - New ReqIF identifier conforming to xsd:ID

Throws:

InvalidIdentifierException - if the identifier is null, blank or not conforming to XSD:ID rules

getComment

public java.lang.String getComment()

Optional comment associated with the Exchange Document as a whole.

Returns:

The comment string (can be null)

setComment

public void setComment(java.lang.String comment)

Sets the ReqIF comment to the supplied value.

Parameters:

comment - the new comment to set, can be null

getCreationTimeText

public java.lang.String getCreationTimeText()

Gets the time of creation of the exchange XML document in the format of the XML Schema data type "dateTime" which specifies the time format as CCYY-MM-DDThh:mm:ss with optional time zone indicator as a suffix ±hh:mm. Example: 2005-03-04T10:24:18+01:00 (MET time zone).

Returns:

rhe ReqIF creation timestamp as text, not null

setCreationTimeText

public void setCreationTimeText(java.lang.String creationTimeText)
                         throws InvalidDateTimeException

Sets the time of creation of the exchange XML document in the format of the XML Schema data type "dateTime" which specifies the time format as CCYY-MM-DDThh:mm:ss with optional time zone indicator as a suffix ±hh:mm. Example: 2005-03-04T10:24:18+01:00 (MET time zone).

Parameters:

creationTimeText - the new creation time to set, not null

Throws:

InvalidDateTimeException - if the supplied String value cannot be converted to a valid Calendar

getCreationTime

public java.util.Date getCreationTime()

Gets the time of creation of the exchange XML document in the format of the XML Schema data type "dateTime" which specifies the time format as CCYY-MM-DDThh:mm:ss with optional time zone indicator as a suffix ±hh:mm. Example: 2005-03-04T10:24:18+01:00 (MET time zone).

Returns:

The ReqIF creation timestamp as text

setCreationTime

public void setCreationTime(java.util.Date creationTime)

Sets the time of creation of the exchange XML document in the format of the XML Schema data type "dateTime" which specifies the time format as CCYY-MM-DDThh:mm:ss with optional time zone indicator as a suffix ±hh:mm. Example: 2005-03-04T10:24:18+01:00 (MET time zone).

Parameters:

creationTime - the new Date value to set for the creation time, not null

setCreationTimetoNow

public void setCreationTimetoNow()

Sets the time of creation of the exchange XML document in the format of the XML Schema data type "dateTime" to now.

getRepositoryId

public java.lang.String getRepositoryId()

Optional unique identifier of the repository containing the requirements that have been exported. Examples for repositoryID: databaseId, URL.

Returns:

Repository ID as String

setRepositoryId

public void setRepositoryId(java.lang.String repositoryId)

Sets the Repository ID to the specified value

Parameters:

repositoryId - New Repository ID to set

getReqIFToolId

public java.lang.String getReqIFToolId()

Identifier of the exporting ReqIF tool

Returns:

Identifier of the exporting ReqIF tool (required)

setReqIFToolId

public void setReqIFToolId(java.lang.String reqIFToolId)
                    throws InvalidValueException

Sets the ReqIF Tool Id. Must be specified.

Parameters:

reqIFToolId - the new ReqIF tool identifier to set, not null

Throws:

InvalidValueException - if the specified value is an empty String

getReqIFVersion

public java.lang.String getReqIFVersion()

ReqIF interchange format and protocol version. Currently set to 1.0.

Returns:

ReqIF version

getSourceToolId

public java.lang.String getSourceToolId()

Identifier of the exporting requirements management tool (required)

Returns:

Tool Identifier as String

setSourceToolId

public void setSourceToolId(java.lang.String sourceToolId)
                     throws InvalidValueException

Throws:

InvalidValueException

getTitle

public java.lang.String getTitle()

Title of the Exchange Document. Must be specified.

Returns:

Exchange document title as String

setTitle

public void setTitle(java.lang.String title)
              throws InvalidValueException

Sets the exchange document title. Must be specified

Parameters:

title - the new exchange document title to set, not null

Throws:

InvalidValueException - if the specified value is an empty string