org.newsml.toolkit
Interface RevisionId

All Superinterfaces:
BaseNode, IdNode, IdText, Text

public interface RevisionId
extends IdText

Revision information for a news item.

The RevisionId is part of the NewsIdentifier for a NewsItem. Each revision of a news item is identified by a positive integer higher than that of the previous revision (if any).

Version:
2.0
Author:
Reuters PLC

Method Summary
 Text getPreviousRevision()
          Get the number of the previous revision of the news item.
 Text getUpdate()
          Get the update parameter for the revision information.
 
Methods inherited from interface org.newsml.toolkit.Text
setBoolean, setInt, setString, toBoolean, toInt, toString
 
Methods inherited from interface org.newsml.toolkit.BaseNode
getAttr, getChild, getChild, getChild, getChild, getChildCount, getChildCount, getParent, getPath, getSession, getXMLName, getXPath, insertAfter, insertAfter, insertAfter, insertAfter, insertAfterDuid, insertAfterDuid, insertBefore, insertBefore, insertBefore, insertBefore, insertBeforeDuid, insertBeforeDuid, insertChild, insertChild, insertFirst, insertFirst, insertLast, insertLast, removeChild, removeChild, removeSelf, replaceChild, replaceChild, replaceChild, replaceChild, replaceChild, replaceChild, setAttr, setAttr, toXML, toXML, unsetAttr, unsetAttr, writeXML, writeXML
 
Methods inherited from interface org.newsml.toolkit.IdNode
getDuid, getEuid
 

Method Detail

getPreviousRevision

public Text getPreviousRevision()
Get the number of the previous revision of the news item.

To get the integer value, use the Text.toInt() method in the Text object returned.

Returns:
Text containing a positive, non-zero integer indicating the previous revision, 0 if this is the first revision, or -1 if the previous revision number was omitted (in which case the document is not NewsML-conformant).

getUpdate

public Text getUpdate()
Get the update parameter for the revision information. The value of the parameter will be "U" if the news item contains an Update element (not explicitly supported by this library), "A" if the news item contains only updated NewsManagement information, or "N" otherwise.
Returns:
Text containing the update parameter (not null).