com.sun.syndication.feed.sse
Class Sync

java.lang.Object
  extended by com.sun.syndication.feed.sse.Sync

public class Sync
extends java.lang.Object

Element within RSS
or OPML
.


Constructor Summary
Sync()
           
 
Method Summary
 java.lang.String getId()
          Provides access to the sync id, a required, string attribute.
 int 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 setDeleted(boolean deleted)
          Set an indication of whether this item has been deleted and is a tombstone.
 void setId(java.lang.String id)
          Set the identifier for the item.
 void setVersion(int version)
          Set the modification sequence number of the item.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Sync

public Sync()
Method Detail

getId

public java.lang.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(java.lang.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 int 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(int 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.


Copyright © 2004-2006 Sun Microsystems. All Rights Reserved.