com.affinda.api.client.models

Class Workspace

java.lang.Object

com.affinda.api.client.models.Workspace

public final class Workspace
extends Object

The Workspace model.

Constructor Summary

Constructors

Constructor and Description
Workspace()

Method Summary

Modifier and Type	Method and Description
List<WorkspaceCollectionsItem>	getCollections() Get the collections property: The collections property.
Integer	getConfirmedDocsCount() Get the confirmedDocsCount property: Number of validated documents in the workspace.
String	getIdentifier() Get the identifier property: Uniquely identify a workspace.
String	getIngestEmail() Get the ingestEmail property: The ingestEmail property.
List<User>	getMembers() Get the members property: The members property.
String	getName() Get the name property: The name property.
Organization	getOrganization() Get the organization property: The organization property.
Integer	getUnvalidatedDocsCount() Get the unvalidatedDocsCount property: Number of unvalidated documents in the workspace.
WorkspaceVisibility	getVisibility() Get the visibility property: Visibility "organization" means everyone in the organization can access the workspace.
Boolean	isRejectDuplicates() Get the rejectDuplicates property: If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed.
Boolean	isRejectInvalidDocuments() Get the rejectInvalidDocuments property: If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined.
Workspace	setCollections(List<WorkspaceCollectionsItem> collections) Set the collections property: The collections property.
Workspace	setConfirmedDocsCount(Integer confirmedDocsCount) Set the confirmedDocsCount property: Number of validated documents in the workspace.
Workspace	setIdentifier(String identifier) Set the identifier property: Uniquely identify a workspace.
Workspace	setIngestEmail(String ingestEmail) Set the ingestEmail property: The ingestEmail property.
Workspace	setMembers(List<User> members) Set the members property: The members property.
Workspace	setName(String name) Set the name property: The name property.
Workspace	setOrganization(Organization organization) Set the organization property: The organization property.
Workspace	setRejectDuplicates(Boolean rejectDuplicates) Set the rejectDuplicates property: If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed.
Workspace	setRejectInvalidDocuments(Boolean rejectInvalidDocuments) Set the rejectInvalidDocuments property: If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined.
Workspace	setUnvalidatedDocsCount(Integer unvalidatedDocsCount) Set the unvalidatedDocsCount property: Number of unvalidated documents in the workspace.
Workspace	setVisibility(WorkspaceVisibility visibility) Set the visibility property: Visibility "organization" means everyone in the organization can access the workspace.

Methods inherited from class java.lang.Object

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

Constructor Detail

Workspace

public Workspace()

Method Detail

getIdentifier

public String getIdentifier()

Get the identifier property: Uniquely identify a workspace.

Returns:

the identifier value.

setIdentifier

public Workspace setIdentifier(String identifier)

Set the identifier property: Uniquely identify a workspace.

Parameters:

identifier - the identifier value to set.

Returns:

the Workspace object itself.

getOrganization

public Organization getOrganization()

Get the organization property: The organization property.

Returns:

the organization value.

setOrganization

public Workspace setOrganization(Organization organization)

Set the organization property: The organization property.

Parameters:

organization - the organization value to set.

Returns:

the Workspace object itself.

getName

public String getName()

Get the name property: The name property.

Returns:

the name value.

setName

public Workspace setName(String name)

Set the name property: The name property.

Parameters:

name - the name value to set.

Returns:

the Workspace object itself.

getVisibility

public WorkspaceVisibility getVisibility()

Get the visibility property: Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the workspace.

Returns:

the visibility value.

setVisibility

public Workspace setVisibility(WorkspaceVisibility visibility)

Set the visibility property: Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the workspace.

Parameters:

visibility - the visibility value to set.

Returns:

the Workspace object itself.

getCollections

public List<WorkspaceCollectionsItem> getCollections()

Get the collections property: The collections property.

Returns:

the collections value.

setCollections

public Workspace setCollections(List<WorkspaceCollectionsItem> collections)

Set the collections property: The collections property.

Parameters:

collections - the collections value to set.

Returns:

the Workspace object itself.

isRejectInvalidDocuments

public Boolean isRejectInvalidDocuments()

Get the rejectInvalidDocuments property: If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed.

Returns:

the rejectInvalidDocuments value.

setRejectInvalidDocuments

public Workspace setRejectInvalidDocuments(Boolean rejectInvalidDocuments)

Set the rejectInvalidDocuments property: If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed.

Parameters:

rejectInvalidDocuments - the rejectInvalidDocuments value to set.

Returns:

the Workspace object itself.

isRejectDuplicates

public Boolean isRejectDuplicates()

Get the rejectDuplicates property: If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false" (default), will parse the document normally whether its a duplicate or not.

Returns:

the rejectDuplicates value.

setRejectDuplicates

public Workspace setRejectDuplicates(Boolean rejectDuplicates)

Set the rejectDuplicates property: If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false" (default), will parse the document normally whether its a duplicate or not.

Parameters:

rejectDuplicates - the rejectDuplicates value to set.

Returns:

the Workspace object itself.

getMembers

public List<User> getMembers()

Get the members property: The members property.

Returns:

the members value.

setMembers

public Workspace setMembers(List<User> members)

Set the members property: The members property.

Parameters:

members - the members value to set.

Returns:

the Workspace object itself.

getUnvalidatedDocsCount

public Integer getUnvalidatedDocsCount()

Get the unvalidatedDocsCount property: Number of unvalidated documents in the workspace.

Returns:

the unvalidatedDocsCount value.

setUnvalidatedDocsCount

public Workspace setUnvalidatedDocsCount(Integer unvalidatedDocsCount)

Set the unvalidatedDocsCount property: Number of unvalidated documents in the workspace.

Parameters:

unvalidatedDocsCount - the unvalidatedDocsCount value to set.

Returns:

the Workspace object itself.

getConfirmedDocsCount

public Integer getConfirmedDocsCount()

Get the confirmedDocsCount property: Number of validated documents in the workspace.

Returns:

the confirmedDocsCount value.

setConfirmedDocsCount

public Workspace setConfirmedDocsCount(Integer confirmedDocsCount)

Set the confirmedDocsCount property: Number of validated documents in the workspace.

Parameters:

confirmedDocsCount - the confirmedDocsCount value to set.

Returns:

the Workspace object itself.

getIngestEmail

public String getIngestEmail()

Get the ingestEmail property: The ingestEmail property.

Returns:

the ingestEmail value.

setIngestEmail

public Workspace setIngestEmail(String ingestEmail)

Set the ingestEmail property: The ingestEmail property.

Parameters:

ingestEmail - the ingestEmail value to set.

Returns:

the Workspace object itself.