|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface of common fields and methods in all upper-level elements of the content. This interface simplifies the handling of these upper-level elements, which for the reference implementation include <manifest-document>, <manifest-package> and <document-ordering> XML elements.
Field Summary | |
static int |
CHANGE_ADDED
Value of 2; integer constant showing that the element has been added. |
static int |
CHANGE_DELETED
Value of 4; integer constant showing that the element has been deleted. |
static int |
CHANGE_LOCKED
Value of 1; integer constant showing that the element has been locked in preparation for updating or deleting. |
static int |
CHANGE_NONE
Value of 0; integer constant showing that the element is unchanged. |
static int |
CHANGE_UPDATED
Value of 3; integer constant showing that the element has been updated. |
Method Summary | |
void |
deleteSeq()
Marks the update sequence number to "unset" for this element. |
int |
getChange()
Returns the changed flag for this element. |
java.lang.String |
getGuid()
Returns the Content Engine GUID for this element. |
java.lang.String |
getManifestID()
Returns the manifest identifier for this element. |
int |
getSeq()
Returns the update sequence number for this element. |
int |
getType()
Returns this element's type. |
boolean |
hasSeq()
Determines whether or not the update sequence number is set for this element. |
void |
marshal(java.io.BufferedWriter out)
Writes a "marshaled" version of the element to an OutputStream object. |
void |
setChange(int change)
Sets the changed flag for this element. |
void |
setGuid(java.lang.String guid)
Sets the Content Engine GUID for this element. |
void |
setManifestID(java.lang.String manifestID)
Sets the manifest identifier for this element. |
void |
setSeq(int seq)
Sets the update sequence number for this element. |
Field Detail |
public static final int CHANGE_NONE
public static final int CHANGE_LOCKED
public static final int CHANGE_ADDED
public static final int CHANGE_UPDATED
public static final int CHANGE_DELETED
Method Detail |
public int getType()
integer
that represents the element type,
specific to the application.public int getChange()
CHANGE_
constants, for example, CHANGE_NONE
to indicate
that this element has not been changed.
integer
representing the value of the change flag.public void setChange(int change)
change
- An integer
value indicating the type of change.public java.lang.String getGuid()
String
containing the element's GUID.public void setGuid(java.lang.String guid)
guid
- A String
containing the Content
Engine's ID for this element.public java.lang.String getManifestID()
public void setManifestID(java.lang.String manifestID)
BsoUID
object.
manifestID
- A String
that contains the
unique identifier for this element.public int getSeq()
hasSeq()
method to determine if the field is present.
integer
that represents the update sequence number.public void setSeq(int seq)
seq
- An integer
that represents the new
value for the update sequence number.public boolean hasSeq()
true
if the value has been set; otherwise, returns false
.public void deleteSeq()
public void marshal(java.io.BufferedWriter out) throws java.io.IOException
OutputStream
object. In
this implementation, the marshaled output will always be an XML representation.
out
- The BufferedWriter
object to which the
XML is written.
java.io.IOException
- Thrown if the marshaling operation fails.
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |