org.newsml.toolkit
Interface NewsManagement

All Superinterfaces:

BaseNode, IdNode, PropertyNode

public interface NewsManagement

extends BaseNode, IdNode, PropertyNode

Management information for a news item.

The NewsManagement class provides information about the context of a NewsItem, including the time when the item was first created, the time when the current revision was created, the current status, a scheduled future status change, the urgency, and its relationship to other news items.

Version:

2.0

Author:

Reuters PLC

Method Summary

NewsItemRef[]	getAssociatedWith() Get all AssociatedWith children in an array.
NewsItemRef	getAssociatedWith(int index) Get a reference to a news item associated with this one.
int	getAssociatedWithCount() Count the associated-with objects.
NewsItemRef[]	getDerivedFrom() Get all DerivedFrom children in an array.
NewsItemRef	getDerivedFrom(int index) Get a reference to a news item from which this item is derived.
int	getDerivedFromCount() Count the derived-from objects.
IdText	getFirstCreated() Get the date when the news item was first created.
Instruction[]	getInstruction() Get all Instruction children in an array.
Instruction	getInstruction(int index) Get a user-defined news-management instruction.
int	getInstructionCount() Count the instructions.
FormalName	getNewsItemType() Get the type of the news item.
RevisionHistory	getRevisionHistory() Get a pointer to the news item's revision history.
FormalName	getStatus() Get the current status of the news item.
StatusWillChange	getStatusWillChange() Get a schedule future status change.
IdText	getThisRevisionCreated() Get the creation date of the current revision of the news item.
FormalName	getUrgency() Get the news item's urgency.

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

Methods inherited from interface org.newsml.toolkit.PropertyNode

getProperty, getProperty, getPropertyCount

Method Detail

getNewsItemType

public FormalName getNewsItemType()

Get the type of the news item.

Returns:

A formal name representing the type (not null).

getFirstCreated

public IdText getFirstCreated()

Get the date when the news item was first created.

Returns:

The date of first creation as text in ISO 8601 basic format (not null).

See Also:

getThisRevisionCreated()

getThisRevisionCreated

public IdText getThisRevisionCreated()

Get the creation date of the current revision of the news item.

Returns:

The creation date as text in ISO 8601 basic format (not null).

See Also:

getFirstCreated()

getStatus

public FormalName getStatus()

Get the current status of the news item.

Returns:

A formal name representing the status (not null).

getStatusWillChange

public StatusWillChange getStatusWillChange()

Get a schedule future status change.

Returns:

An object representing a future status change, or null if none was specified.

See Also:

getStatusWillChange()

getUrgency

public FormalName getUrgency()

Get the news item's urgency.

Returns:

A formal name representing the urgency, or null if none was specified.

See Also:

getStatus()

getRevisionHistory

public RevisionHistory getRevisionHistory()

Get a pointer to the news item's revision history.

Returns:

A string containing the URL of a revision-history document for the news item, or null if none was specified.

getDerivedFromCount

public int getDerivedFromCount()

Count the derived-from objects.

Returns:

The number of derived-from objects present.

getDerivedFrom

public NewsItemRef getDerivedFrom(int index)

Get a reference to a news item from which this item is derived.

Parameters:

index - The index of the reference, zero-based, in sequential order.

Returns:

An object containing the reference, or null if none was provided with the specified index.

getDerivedFrom

public NewsItemRef[] getDerivedFrom()

Get all DerivedFrom children in an array.

Returns:

A (possibly-empty) array of DerivedFrom children.

getAssociatedWithCount

public int getAssociatedWithCount()

Count the associated-with objects.

Returns:

The number of associated-with objects present.

getAssociatedWith

public NewsItemRef getAssociatedWith(int index)

Get a reference to a news item associated with this one.

Parameters:

index - The index of the reference, zero-based, in sequential order.

Returns:

An object containing the reference, or null if none was provided with the specified index.

getAssociatedWith

public NewsItemRef[] getAssociatedWith()

Get all AssociatedWith children in an array.

Returns:

A (possibly-empty) array of AssociatedWith children.

getInstructionCount

public int getInstructionCount()

Count the instructions.

Returns:

The number of instructions present.

getInstruction

public Instruction getInstruction(int index)

Get a user-defined news-management instruction.

Parameters:

index - The index of the instruction, zero-based, in sequential order.

Returns:

An object containing the instruction, or null if none was provided with the specified index.

getInstruction

public Instruction[] getInstruction()

Get all Instruction children in an array.

Returns:

A (possibly-empty) array of Instruction children.