Package com.coveo.pushapiclient

Class DocumentBuilder

java.lang.Object

com.coveo.pushapiclient.DocumentBuilder

public class DocumentBuilder
extends Object

Utility class to build a Document

Constructor Summary

Constructors

Constructor	Description
DocumentBuilder(String uri, String title)

Method Summary

Modifier and Type	Method	Description
Document	getDocument()
String	marshal()	Marshal the document into a JSON string accepted by the push API.
com.google.gson.JsonObject	marshalJsonObject()	Marshal the document into a JSON object accepted by the push API.
DocumentBuilder	withAllowAnonymousUsers(Boolean allowAnonymous)	Set allowAnonymous for permissions on the document.
DocumentBuilder	withAllowedPermissions(SecurityIdentityBuilder allowedPermissions)	Set allowed identities on the document.
DocumentBuilder	withAuthor(String author)	Set the author on the document.
DocumentBuilder	withClickableUri(String clickableUri)	Set the clickableURI on the document.
DocumentBuilder	withCompressedBinaryData(CompressedBinaryData compressedBinaryData)	Set the base64 encoded, compressed binary data of the document.
DocumentBuilder	withCompressedBinaryDataFileId(String compressedBinaryDataFileId)	Set the file container file ID for the compressed binary data of the document.
DocumentBuilder	withData(String data)	Set the data of the document.
DocumentBuilder	withDate(Long date)	Set the date of the document.
DocumentBuilder	withDate(String date)	Set the date of the document.
DocumentBuilder	withDate(Date date)	Set the date of the document.
DocumentBuilder	withDate(org.joda.time.DateTime date)	Set the date of the document.
DocumentBuilder	withDeniedPermissions(SecurityIdentityBuilder deniedPermissions)	Set denied identities on the document.
DocumentBuilder	withDocumentPermissions(DocumentPermissions[] documentPermissions)	Set the fully built out DocumentPermissions array.
DocumentBuilder	withFileExtension(String fileExtension)	Set the file extension on the document.
DocumentBuilder	withMetadata(Map<String,Object> metadata)	Set metadata on the document.
DocumentBuilder	withMetadataValue(String key, Integer metadataValue)	Add a single metadata key and value pair on the document.
DocumentBuilder	withMetadataValue(String key, Integer[] metadataValue)	Add a single metadata key and value pair on the document.
DocumentBuilder	withMetadataValue(String key, String metadataValue)	Add a single metadata key and value pair on the document.
DocumentBuilder	withMetadataValue(String key, String[] metadataValue)	Add a single metadata key and value pair on the document.
DocumentBuilder	withModifiedDate(Long date)	Set the modified date of the document.
DocumentBuilder	withModifiedDate(String date)	Set the modified date of the document.
DocumentBuilder	withModifiedDate(Date date)	Set the modified date of the document.
DocumentBuilder	withModifiedDate(org.joda.time.DateTime date)	Set the modified date of the document.
DocumentBuilder	withParentID(String parentID)	Set the parentID on the document.
DocumentBuilder	withPermanentId(String permanentId)	Set the permanentID of the document.

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentBuilder

public DocumentBuilder(String uri,
 String title)

Parameters:

uri - the URI of the document. See Document.uri

title - the title of the document. See Document.title

Method Details

getDocument

public Document getDocument()

withData

public DocumentBuilder withData(String data)

Set the data of the document. See Document.data

Parameters:

data -

Returns:

withDate

public DocumentBuilder withDate(String date)

Set the date of the document. See Document.date

Parameters:

date -

Returns:

withDate

public DocumentBuilder withDate(Long date)

Set the date of the document. See Document.date

Parameters:

date -

Returns:

withDate

public DocumentBuilder withDate(Date date)

Set the date of the document. See Document.date

Parameters:

date -

Returns:

withDate

public DocumentBuilder withDate(org.joda.time.DateTime date)

Set the date of the document. See Document.date

Parameters:

date -

Returns:

withModifiedDate

public DocumentBuilder withModifiedDate(String date)

Set the modified date of the document. See Document.modifiedDate

Parameters:

date -

Returns:

withModifiedDate

public DocumentBuilder withModifiedDate(Long date)

Set the modified date of the document. See Document.modifiedDate

Parameters:

date -

Returns:

withModifiedDate

public DocumentBuilder withModifiedDate(org.joda.time.DateTime date)

Set the modified date of the document. See Document.modifiedDate

Parameters:

date -

Returns:

withModifiedDate

public DocumentBuilder withModifiedDate(Date date)

Set the modified date of the document. See Document.modifiedDate

Parameters:

date -

Returns:

withPermanentId

public DocumentBuilder withPermanentId(String permanentId)

Set the permanentID of the document. See Document.permanentId

Parameters:

permanentId -

Returns:

withCompressedBinaryData

public DocumentBuilder withCompressedBinaryData(CompressedBinaryData compressedBinaryData)

Set the base64 encoded, compressed binary data of the document. See Document.compressedBinaryData

Parameters:

compressedBinaryData -

Returns:

withCompressedBinaryDataFileId

public DocumentBuilder withCompressedBinaryDataFileId(String compressedBinaryDataFileId)

Set the file container file ID for the compressed binary data of the document. See Document.compressedBinaryDataFileId

Parameters:

compressedBinaryDataFileId -

Returns:

withFileExtension

public DocumentBuilder withFileExtension(String fileExtension)

Set the file extension on the document. See Document.fileExtension

Parameters:

fileExtension -

Returns:

withParentID

public DocumentBuilder withParentID(String parentID)

Set the parentID on the document. See Document.parentId

Parameters:

parentID -

Returns:

withClickableUri

public DocumentBuilder withClickableUri(String clickableUri)

Set the clickableURI on the document. See Document.clickableUri

Parameters:

clickableUri -

Returns:

withAuthor

public DocumentBuilder withAuthor(String author)

Set the author on the document. See Document.author

Parameters:

author -

Returns:

withMetadataValue

public DocumentBuilder withMetadataValue(String key,
 String metadataValue)

Add a single metadata key and value pair on the document. See Document.metadata

Parameters:

key -

metadataValue -

Returns:

withMetadataValue

public DocumentBuilder withMetadataValue(String key,
 String[] metadataValue)

Add a single metadata key and value pair on the document. See Document.metadata

Parameters:

key -

metadataValue -

Returns:

withMetadataValue

public DocumentBuilder withMetadataValue(String key,
 Integer metadataValue)

Add a single metadata key and value pair on the document. See Document.metadata

Parameters:

key -

metadataValue -

Returns:

withMetadataValue

public DocumentBuilder withMetadataValue(String key,
 Integer[] metadataValue)

Add a single metadata key and value pair on the document. See Document.metadata

Parameters:

key -

metadataValue -

Returns:

withMetadata

public DocumentBuilder withMetadata(Map<String,Object> metadata)

Set metadata on the document. See Document.metadata

Parameters:

metadata -

Returns:

withAllowedPermissions

public DocumentBuilder withAllowedPermissions(SecurityIdentityBuilder allowedPermissions)

Set allowed identities on the document. See Document.permissions

Parameters:

allowedPermissions -

Returns:

withDeniedPermissions

public DocumentBuilder withDeniedPermissions(SecurityIdentityBuilder deniedPermissions)

Set denied identities on the document. See Document.permissions

Parameters:

deniedPermissions -

Returns:

withAllowAnonymousUsers

public DocumentBuilder withAllowAnonymousUsers(Boolean allowAnonymous)

Set allowAnonymous for permissions on the document. See Document.permissions

Parameters:

allowAnonymous -

Returns:

withDocumentPermissions

public DocumentBuilder withDocumentPermissions(DocumentPermissions[] documentPermissions)

Set the fully built out DocumentPermissions array. See Document.permissions

Parameters:

documentPermissions -

Returns:

marshal

public String marshal()

Marshal the document into a JSON string accepted by the push API.

Returns:

marshalJsonObject

public com.google.gson.JsonObject marshalJsonObject()

Marshal the document into a JSON object accepted by the push API.

Returns: