org.newsml.toolkit
Interface RevisionId

All Superinterfaces:
BaseNode, IdNode

public interface RevisionId
extends BaseNode, IdNode

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:
1.0
Author:
Reuters PLC

Method Summary
 int getPreviousRevision()
          Get the number of the previous revision of the news item.
 java.lang.String getUpdate()
          Get the update parameter for the revision information.
 int getValue()
          Get the number of this revision of the news item.
 
Methods inherited from interface org.newsml.toolkit.BaseNode
getSession, getXMLName
 
Methods inherited from interface org.newsml.toolkit.IdNode
getDuid, getEuid
 

Method Detail

getValue

public int getValue()
Get the number of this revision of the news item.
Returns:
A positive, non-zero integer indicating the current revision number, or -1 if the revision number was omitted (in which case the document is not NewsML-conformant).

getPreviousRevision

public int getPreviousRevision()
Get the number of the previous revision of the news item.
Returns:
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 java.lang.String 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:
The update parameter as a string (not null).