org.newsml.toolkit
Interface NewsEnvelope

All Superinterfaces:
BaseNode, IdNode

public interface NewsEnvelope
extends BaseNode, IdNode

Information about the transmission of the NewsML package.

A news envelope contains information about the transmission itself rather than about the transmission's content; it is the equivalent of an address label on the outside of a package.

Version:
2.0
Author:
Reuters PLC

Method Summary
 IdText getDateAndTime()
          Get the date on time when this package was transmitted.
 FormalName[] getNewsProduct()
          Get all NewsProduct children in an array.
 FormalName getNewsProduct(int index)
          Get one of the news products associated with this package.
 int getNewsProductCount()
          Count the news products.
 FormalName[] getNewsService()
          Get all NewsService children in an array.
 FormalName getNewsService(int index)
          Get one of the news services associated with this package.
 int getNewsServiceCount()
          Count the news services present.
 FormalName getPriority()
          Get the priority of this package.
 PartyList getSentFrom()
          Get a list of senders of this package.
 PartyList getSentTo()
          Get a list of recipients of this package.
 TransmissionId getTransmissionId()
          Get the identifier for this transmission.
 
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

getTransmissionId

public TransmissionId getTransmissionId()
Get the identifier for this transmission.
Returns:
The transmission identifier, or null if none was specified.

getSentFrom

public PartyList getSentFrom()
Get a list of senders of this package.
Returns:
A list of parties representing the senders, or null if none were provided.

getSentTo

public PartyList getSentTo()
Get a list of recipients of this package.
Returns:
A list of recipients, or null of none were provided.

getDateAndTime

public IdText getDateAndTime()
Get the date on time when this package was transmitted.
Returns:
Text representing the date and time of transmission, in ISO 8601 Basic format.

getNewsServiceCount

public int getNewsServiceCount()
Count the news services present.
Returns:
The number of news services.

getNewsService

public FormalName getNewsService(int index)
Get one of the news services associated with this package.
Parameters:
index - The index of the service, zero-based, numbered sequentially.
Returns:
A formal name representing the service, or null if none was provided at the specified index.

getNewsService

public FormalName[] getNewsService()
Get all NewsService children in an array.
Returns:
A (possibly-empty) array of NewsService children.

getNewsProductCount

public int getNewsProductCount()
Count the news products.
Returns:
The number of news products present.

getNewsProduct

public FormalName getNewsProduct(int index)
Get one of the news products associated with this package.
Parameters:
index - The index of the product, zero-based, numbered sequentially.
Returns:
A formal name representing the product, or null if none was provided at the specified index.

getNewsProduct

public FormalName[] getNewsProduct()
Get all NewsProduct children in an array.
Returns:
A (possibly-empty) array of NewsProduct children.

getPriority

public FormalName getPriority()
Get the priority of this package.
Returns:
A formal name representing the priority, or null if none was provided.