Package com.rometools.modules.sse.modules

Class Sync

java.lang.Object

com.rometools.modules.sse.modules.SSEModule

com.rometools.modules.sse.modules.Sync

All Implemented Interfaces:

CopyFrom, Module, Serializable, Cloneable

public class Sync
extends SSEModule

Element within RSS

or OPML

.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFLICT_ATTRIBUTE
static String	DELETED_ATTRIBUTE
static String	ID_ATTRIBUTE
static String	NAME
static String	VERSION_ATTRIBUTE

Fields inherited from class com.rometools.modules.sse.modules.SSEModule

NAMESPACES, PREFIX, SSE_NS, SSE_SCHEMA_URI

Constructor Summary

Constructors

Constructor	Description
Sync()

Method Summary

Modifier and Type	Method	Description
void	addConflict(Conflict conflict)
void	copyFrom(CopyFrom obj)
List<Conflict>	getConflicts()
History	getHistory()	Get the history for this sync object
String	getId()	Provides access to the sync id, a required, string attribute.
Integer	getVersion()	Provides access to a required, integer attribute.
Boolean	isConflict()	Provides access to an optional, Boolean conflict attribute.
Boolean	isDeleted()	Provide access to an optional, Boolean attribute.
void	setConflict(Boolean conflict)	Set an indication of whether there was an update conflict detected when processing an update of this item.
void	setConflicts(List<Conflict> conflicts)
void	setDeleted(Boolean deleted)	Set an indication of whether this item has been deleted and is a tombstone.
void	setHistory(History history)	The history history for this sync object
void	setId(String id)	Set the identifier for the item.
void	setVersion(Integer version)	Set the modification sequence number of the item.

Methods inherited from class com.rometools.modules.sse.modules.SSEModule

clone, getInterface, getUri

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

ID_ATTRIBUTE

public static final String ID_ATTRIBUTE

See Also:

Constant Field Values

VERSION_ATTRIBUTE

public static final String VERSION_ATTRIBUTE

See Also:

Constant Field Values

CONFLICT_ATTRIBUTE

public static final String CONFLICT_ATTRIBUTE

See Also:

Constant Field Values

DELETED_ATTRIBUTE

public static final String DELETED_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

Sync

public Sync()

Method Detail

copyFrom

public void copyFrom(CopyFrom obj)

Specified by:

copyFrom in interface CopyFrom

Specified by:

copyFrom in class SSEModule

getId

public String getId()

Provides access to the sync id, a required, string attribute. This is the identifier for the item.

The ID is assigned by the creator of the item, and MUST NOT be changed by subsequent publishers. Applications will collate and compare these identifiers, therefore they MUST conform to the syntax for Namespace Specific Strings (the NSS portion of a URN) in RFC 2141.

setId

public void setId(String id)

Set the identifier for the item. The ID MUST be globally unique within the feed and it MUST be identical across feeds if an item is being shared or replicated as part of multiple distinct independent feeds.

Parameters:

id - the identifier for the item.

getVersion

public Integer getVersion()

Provides access to a required, integer attribute. This is the modification sequence number of the item, starting at 1 and incrementing by 1 indefinitely for each subsequent modification.

setVersion

public void setVersion(Integer version)

Set the modification sequence number of the item.

Parameters:

version - the modification sequence number of the item.

isDeleted

public Boolean isDeleted()

Provide access to an optional, Boolean attribute. If present and its value is "true" (lower-case), it indicates that the item has been deleted and this is a tombstone. If not present, or if present with value of "false" or "", then the item is not deleted. All other values are invalid.

setDeleted

public void setDeleted(Boolean deleted)

Set an indication of whether this item has been deleted and is a tombstone.

Parameters:

deleted - an indication of whether this item has been deleted and is a tombstone.

isConflict

public Boolean isConflict()

Provides access to an optional, Boolean conflict attribute. If present and its value is "true" (lower-case), it indicates there was an update conflict detected when processing an update of this item, and it should potentially be examined by the user. If not present, or present with value of "false" or "", Then no conflict has been detected. All other values are invalid.

Returns:

indicates there was an update conflict detected when processing an update of this item.

setConflict

public void setConflict(Boolean conflict)

Set an indication of whether there was an update conflict detected when processing an update of this item.

Parameters:

conflict - an indication of whether there was an update conflict detected when processing an update of this item.

setHistory

public void setHistory(History history)

The history history for this sync object

Parameters:

history - the history for this sync object.

getHistory

public History getHistory()

Get the history for this sync object

Returns:

get the history for this sync object.

addConflict

public void addConflict(Conflict conflict)

getConflicts

public List<Conflict> getConflicts()

setConflicts

public void setConflicts(List<Conflict> conflicts)