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

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

All Implemented Interfaces:

java.io.Serializable

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

Contains information about title, absolutePath, author, sitePath, isDocument, documentLibraryName, relativePath of the document. More information about these fields:

title	Title of the document
absolutePath	Absolute Path of the document in SharePoint. An absolute path includes SharePoint site, document library/list name, folder, and file location information
author	Author of the Document
isDocument	Refers to the isDocument property for any SharePoint document. In case of folders, the value returned should be false
documentLibraryName	Name of the document library where document exists
relativePath	Folder and file path of the document. A relative path does not contain the SharePoint site url and Document library path information

See Also:

Serialized Form

Constructor Summary

SearchDocument()

Method Summary

java.lang.String	getAbsolutePath() Retrieves the absolute path.
java.lang.String	getAuthor() Retrieves the author of the document.
java.lang.String	getDocumentLibraryName() Retrieves the name of the document library.
java.lang.Boolean	getIsDocument() Used to determine if an entity is a document or a folder.
java.lang.String	getRelativePath() Retrieves the relative path.
java.lang.String	getSitePath() Retrieves the path to the site.
java.lang.String	getTitle() Retrieves the title.
void	setAbsolutePath(java.lang.String absolutePath) Sets the absolute path.
void	setAuthor(java.lang.String author) Sets the author of a document.
void	setDocumentLibraryName(java.lang.String documentLibraryName) Sets the name of the document library.
void	setIsDocument(java.lang.Boolean isDocument) Sets a flag indicating the entity is a document or folder.
void	setRelativePath(java.lang.String relativePath) Sets the relative path.
void	setSitePath(java.lang.String sitePath) Sets the path of the site.
void	setTitle(java.lang.String title) Sets the title.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchDocument

public SearchDocument()

Method Detail

getAuthor

public java.lang.String getAuthor()

Retrieves the author of the document.

setAuthor

public void setAuthor(java.lang.String author)

Sets the author of a document.

getAbsolutePath

public java.lang.String getAbsolutePath()

Retrieves the absolute path.

setAbsolutePath

public void setAbsolutePath(java.lang.String absolutePath)

Sets the absolute path.

getTitle

public java.lang.String getTitle()

Retrieves the title.

setTitle

public void setTitle(java.lang.String title)

Sets the title.

getIsDocument

public java.lang.Boolean getIsDocument()

Used to determine if an entity is a document or a folder.

setIsDocument

public void setIsDocument(java.lang.Boolean isDocument)

Sets a flag indicating the entity is a document or folder.

getSitePath

public java.lang.String getSitePath()

Retrieves the path to the site.

setSitePath

public void setSitePath(java.lang.String sitePath)

Sets the path of the site.

getDocumentLibraryName

public java.lang.String getDocumentLibraryName()

Retrieves the name of the document library.

setDocumentLibraryName

public void setDocumentLibraryName(java.lang.String documentLibraryName)

Sets the name of the document library.

getRelativePath

public java.lang.String getRelativePath()

Retrieves the relative path.

setRelativePath

public void setRelativePath(java.lang.String relativePath)

Sets the relative path.