com.adobe.livecycle.crc.sharepoint.client.types
Class CreateDocumentResultType

java.lang.Object
  com.adobe.livecycle.crc.sharepoint.client.types.CreateDocumentResultType

All Implemented Interfaces:

java.io.Serializable

public class CreateDocumentResultType
extends java.lang.Object
implements java.io.Serializable

Contains Information about absoluteFileURL, relativeFileURL, and a boolean flag indicating success of the operation.

See Also:

Serialized Form

Constructor Summary

CreateDocumentResultType()

Method Summary

java.lang.String	getAbsoluteFileUrl() Retrieves the absolute URL of the file in SharePoint.
java.lang.String	getRelativeFileUrl() Retrieves the relative URL of the file in SharePoint.
boolean	isFileUploadSuccessful() Confirms whether a document was successfully created or not.
void	setAbsoluteFileUrl(java.lang.String absoluteFileUrl) Sets the absolute URL of the file in SharePoint.
void	setFileUploadSuccessful(boolean fileUploadSuccessful) Sets if file creation in SharePoint is successful.
void	setRelativeFileUrl(java.lang.String relativeFileUrl) Sets the relative URL of the file in SharePoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateDocumentResultType

public CreateDocumentResultType()

Method Detail

getAbsoluteFileUrl

public java.lang.String getAbsoluteFileUrl()

Retrieves the absolute URL of the file in SharePoint.

Returns:

Absolute URL of the file in SharePoint

setAbsoluteFileUrl

public void setAbsoluteFileUrl(java.lang.String absoluteFileUrl)

Sets the absolute URL of the file in SharePoint.

isFileUploadSuccessful

public boolean isFileUploadSuccessful()

Confirms whether a document was successfully created or not.

Returns:

Returns true if the document was successfully created. In case of an error, or if the document already exists, this method returns a false.

setFileUploadSuccessful

public void setFileUploadSuccessful(boolean fileUploadSuccessful)

Sets if file creation in SharePoint is successful.

setRelativeFileUrl

public void setRelativeFileUrl(java.lang.String relativeFileUrl)

Sets the relative URL of the file in SharePoint. A Relative URL does not have SharePoint site and document library information in the URL. It contains information only about the parent folder and file path. This value can be directly passed to other SharePoint content repository connector operations.

Parameters:

relativeFileUrl - Relative URL of a file in SharePoint.

getRelativeFileUrl

public java.lang.String getRelativeFileUrl()

Retrieves the relative URL of the file in SharePoint. A Relative URL does not have SharePoint site and document library information in the URL. It contains information only about the parent folder and file path. This value can be directly passed to other SharePoint content repository connector operations.

Returns:

Relative URL of the file in SharePoint.