com.businessobjects.dsws.saveservice
Interface SaveResult

public interface SaveResult

The SaveResult is an object that is returned after performing Save and SaveAs operations.
SaveResult contains following three members:
DocumentReference Updated documentReference after save operation
DocumentID In the case of saveAs, it is new document ID of the latest document reference and in the case of save, it is same document ID of original document.
DocumentProperties A set of NameValuePair BusinessObjects.DSWS.NameValuePair objects used to modify document properties after save/saveAs operation.

Since:

11.7

Nested Class Summary

static class

SaveResult.Factory A class with methods for creating instances of the SaveResult type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

NameValuePair	addNewDocumentProperty() Internal Use Only.
NameValuePair[]	getDocumentPropertyArray() This returns Document Properties as NameValuePair objects.
NameValuePair	getDocumentPropertyArray(int i) This returns Document Property as NameValuePair object at the specified index.
java.lang.String	getDocumentReference() This returns updated Document Reference of the current document instance.
java.lang.String	getDocumentUID() This returns Document UID of the current document instance.
NameValuePair	insertNewDocumentProperty(int i) Internal Use Only.
boolean	isNilDocumentPropertyArray(int i) Checks if the ith documentProperty element is nil.
boolean	isSetDocumentReference() Checks if the documentReference attribute is set.
boolean	isSetDocumentUID() Checks if the documentUID attribute is set.
void	removeDocumentProperty(int i) Internal Use Only.
void	setDocumentPropertyArray(int i, NameValuePair documentProperty) Internal Use Only.
void	setDocumentPropertyArray(NameValuePair[] documentPropertyArray) Internal Use Only.
void	setDocumentReference(java.lang.String documentReference) Internal Use Only.
void	setDocumentUID(java.lang.String documentUID) Internal Use Only.
void	setNilDocumentPropertyArray(int i) Internal Use Only.
int	sizeOfDocumentPropertyArray() Returns the number of documentProperty element.
void	unsetDocumentReference() Internal Use Only.
void	unsetDocumentUID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDocumentReference() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDocumentUID() Internal Use Only.
void	xsetDocumentReference(org.apache.xmlbeans.XmlString documentReference) Internal Use Only.
void	xsetDocumentUID(org.apache.xmlbeans.XmlString documentUID) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getDocumentPropertyArray

NameValuePair[] getDocumentPropertyArray()

This returns Document Properties as NameValuePair objects. These objects are modified as part of Save and SaveAs using SaveService. This is one way of confirming to the user modified properties and its values.

Returns:

NameValuePair[] Array of NameValuePair depicting DocumentProperties modified as part of Save/SaveAs

See Also:

NameValuePair

getDocumentPropertyArray

NameValuePair getDocumentPropertyArray(int i)

This returns Document Property as NameValuePair object at the specified index. This object is modified as part of Save and SaveAs using SaveService. This is one way of confirming to the user modified properties and its values.

Parameters:

i - index of the specified document Property (NameValuePair Object)

Returns:

NameValuePair depicting DocumentProperty modified as part of Save/SaveAs

See Also:

NameValuePair

isNilDocumentPropertyArray

boolean isNilDocumentPropertyArray(int i)

Checks if the ith documentProperty element is nil.

Parameters:

i - the index of the DocumentProperty element.

Returns:

true if the DocumentProperty element is nil, otherwise false.

sizeOfDocumentPropertyArray

int sizeOfDocumentPropertyArray()

Returns the number of documentProperty element.

Returns:

the size of the DocumentProperty array.

setDocumentPropertyArray

void setDocumentPropertyArray(NameValuePair[] documentPropertyArray)

Internal Use Only.

setDocumentPropertyArray

void setDocumentPropertyArray(int i,
                              NameValuePair documentProperty)

Internal Use Only.

setNilDocumentPropertyArray

void setNilDocumentPropertyArray(int i)

Internal Use Only.

insertNewDocumentProperty

NameValuePair insertNewDocumentProperty(int i)

Internal Use Only.

addNewDocumentProperty

NameValuePair addNewDocumentProperty()

Internal Use Only.

removeDocumentProperty

void removeDocumentProperty(int i)

Internal Use Only.

getDocumentReference

java.lang.String getDocumentReference()

This returns updated Document Reference of the current document instance. For SaveAs(), it is new document's document reference and for Save, it is current document's reference.

Returns:

documentReference. A string value, which represents document reference of the current document instance.

See Also:

DocumentInformation

xgetDocumentReference

org.apache.xmlbeans.XmlString xgetDocumentReference()

Internal Use Only.

isSetDocumentReference

boolean isSetDocumentReference()

Checks if the documentReference attribute is set.

Returns:

true if the DocumentReference element is set, otherwise false.

setDocumentReference

void setDocumentReference(java.lang.String documentReference)

Internal Use Only.

xsetDocumentReference

void xsetDocumentReference(org.apache.xmlbeans.XmlString documentReference)

Internal Use Only.

unsetDocumentReference

void unsetDocumentReference()

Internal Use Only.

getDocumentUID

java.lang.String getDocumentUID()

This returns Document UID of the current document instance. For SaveAs(), it is new document's ID and for Save, it is current document's ID.

Returns:

documentUID. A string value, which represents document ID of the current document instance.

xgetDocumentUID

org.apache.xmlbeans.XmlString xgetDocumentUID()

Internal Use Only.

isSetDocumentUID

boolean isSetDocumentUID()

Checks if the documentUID attribute is set.

Returns:

true if the DocumentUID element is set, otherwise false.

setDocumentUID

void setDocumentUID(java.lang.String documentUID)

Internal Use Only.

xsetDocumentUID

void xsetDocumentUID(org.apache.xmlbeans.XmlString documentUID)

Internal Use Only.

unsetDocumentUID

void unsetDocumentUID()

Internal Use Only.