org.newsml.toolkit
Interface RightsMetadata

All Superinterfaces:
AssignmentNode, BaseNode, CatalogNode, IdNode, PropertyNode

public interface RightsMetadata
extends AssignmentNode, BaseNode, CatalogNode, IdNode, PropertyNode

Information about the rights for a news component.

Rights typically include time and geographical restrictions and the right to use news content in different ways. The rights metadata is attached to a NewsComponent.

Version:
2.0
Author:
Reuters PLC

Method Summary
 Copyright[] getCopyright()
          Get all Copyright children in an array.
 Copyright getCopyright(int index)
          Get a copyright attached to the news component.
 int getCopyrightCount()
          Count the copyrights.
 UsageRights[] getUsageRights()
          Get all UsageRights children in an array.
 UsageRights getUsageRights(int index)
          Return the usage rights attached to the news component.
 int getUsageRightsCount()
          Count the usage rights statements.
 
Methods inherited from interface org.newsml.toolkit.AssignmentNode
getAssignedBy, getAssignmentDateAndTime, getConfidence, getHowPresent, getImportance
 
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.CatalogNode
getCatalog
 
Methods inherited from interface org.newsml.toolkit.IdNode
getDuid, getEuid
 
Methods inherited from interface org.newsml.toolkit.PropertyNode
getProperty, getProperty, getPropertyCount
 

Method Detail

getCopyrightCount

public int getCopyrightCount()
Count the copyrights.
Returns:
The number of copyrights present.

getCopyright

public Copyright getCopyright(int index)
Get a copyright attached to the news component.
Parameters:
index - The index of the copyright, zero-based, numbered sequentially.
Returns:
An object representing the copyright, or null if none was provided at the specified index.

getCopyright

public Copyright[] getCopyright()
Get all Copyright children in an array.
Returns:
A (possibly-empty) array of Copyright children.

getUsageRightsCount

public int getUsageRightsCount()
Count the usage rights statements.
Returns:
The number of usage-rights statements present.

getUsageRights

public UsageRights getUsageRights(int index)
Return the usage rights attached to the news component.
Parameters:
index - The index of the usage rights, zero-based, numbered sequentially.
Returns:
An object representing the usage rights, or null if none was provided at the specified index.

getUsageRights

public UsageRights[] getUsageRights()
Get all UsageRights children in an array.
Returns:
A (possibly-empty) array of UsageRights children.