com.ibm.watson.compare_comply.v1.model

Class ClassifyReturn

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.compare_comply.v1.model.ClassifyReturn

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class ClassifyReturn
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The analysis of objects returned by the **Element classification** method.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<ContractAmts>	contractAmounts
protected java.util.List<ContractCurrencies>	contractCurrencies
protected java.util.List<ContractTerms>	contractTerms
protected java.util.List<ContractTypes>	contractTypes
protected Document	document
protected DocStructure	documentStructure
protected java.util.List<EffectiveDates>	effectiveDates
protected java.util.List<Element>	elements
protected java.lang.String	modelId
protected java.lang.String	modelVersion
protected java.util.List<Parties>	parties
protected java.util.List<PaymentTerms>	paymentTerms
protected java.util.List<Tables>	tables
protected java.util.List<TerminationDates>	terminationDates

Constructor Summary

Constructors

Constructor and Description
ClassifyReturn()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ContractAmts>	getContractAmounts() Gets the contractAmounts.
java.util.List<ContractCurrencies>	getContractCurrencies() Gets the contractCurrencies.
java.util.List<ContractTerms>	getContractTerms() Gets the contractTerms.
java.util.List<ContractTypes>	getContractTypes() Gets the contractTypes.
Document	getDocument() Gets the document.
DocStructure	getDocumentStructure() Gets the documentStructure.
java.util.List<EffectiveDates>	getEffectiveDates() Gets the effectiveDates.
java.util.List<Element>	getElements() Gets the elements.
java.lang.String	getModelId() Gets the modelId.
java.lang.String	getModelVersion() Gets the modelVersion.
java.util.List<Parties>	getParties() Gets the parties.
java.util.List<PaymentTerms>	getPaymentTerms() Gets the paymentTerms.
java.util.List<Tables>	getTables() Gets the tables.
java.util.List<TerminationDates>	getTerminationDates() Gets the terminationDates.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

document

protected Document document

modelId

@SerializedName(value="model_id")
protected java.lang.String modelId

modelVersion

@SerializedName(value="model_version")
protected java.lang.String modelVersion

elements

protected java.util.List<Element> elements

effectiveDates

@SerializedName(value="effective_dates")
protected java.util.List<EffectiveDates> effectiveDates

contractAmounts

@SerializedName(value="contract_amounts")
protected java.util.List<ContractAmts> contractAmounts

terminationDates

@SerializedName(value="termination_dates")
protected java.util.List<TerminationDates> terminationDates

contractTypes

@SerializedName(value="contract_types")
protected java.util.List<ContractTypes> contractTypes

contractTerms

@SerializedName(value="contract_terms")
protected java.util.List<ContractTerms> contractTerms

paymentTerms

@SerializedName(value="payment_terms")
protected java.util.List<PaymentTerms> paymentTerms

contractCurrencies

@SerializedName(value="contract_currencies")
protected java.util.List<ContractCurrencies> contractCurrencies

tables

protected java.util.List<Tables> tables

documentStructure

@SerializedName(value="document_structure")
protected DocStructure documentStructure

parties

protected java.util.List<Parties> parties

Constructor Detail

ClassifyReturn

public ClassifyReturn()

Method Detail

getDocument

public Document getDocument()

Gets the document.

Basic information about the input document.

Returns:

the document

getModelId

public java.lang.String getModelId()

Gets the modelId.

The analysis model used to classify the input document. For the **Element classification** method, the only valid value is `contracts`.

Returns:

the modelId

getModelVersion

public java.lang.String getModelVersion()

Gets the modelVersion.

The version of the analysis model identified by the value of the `model_id` key.

Returns:

the modelVersion

getElements

public java.util.List<Element> getElements()

Gets the elements.

Document elements identified by the service.

Returns:

the elements

getEffectiveDates

public java.util.List<EffectiveDates> getEffectiveDates()

Gets the effectiveDates.

The date or dates on which the document becomes effective.

Returns:

the effectiveDates

getContractAmounts

public java.util.List<ContractAmts> getContractAmounts()

Gets the contractAmounts.

The monetary amounts that identify the total amount of the contract that needs to be paid from one party to another.

Returns:

the contractAmounts

getTerminationDates

public java.util.List<TerminationDates> getTerminationDates()

Gets the terminationDates.

The dates on which the document is to be terminated.

Returns:

the terminationDates

getContractTypes

public java.util.List<ContractTypes> getContractTypes()

Gets the contractTypes.

The contract type as declared in the document.

Returns:

the contractTypes

getContractTerms

public java.util.List<ContractTerms> getContractTerms()

Gets the contractTerms.

The durations of the contract.

Returns:

the contractTerms

getPaymentTerms

public java.util.List<PaymentTerms> getPaymentTerms()

Gets the paymentTerms.

The document's payment durations.

Returns:

the paymentTerms

getContractCurrencies

public java.util.List<ContractCurrencies> getContractCurrencies()

Gets the contractCurrencies.

The contract currencies as declared in the document.

Returns:

the contractCurrencies

getTables

public java.util.List<Tables> getTables()

Gets the tables.

Definition of tables identified in the input document.

Returns:

the tables

getDocumentStructure

public DocStructure getDocumentStructure()

Gets the documentStructure.

The structure of the input document.

Returns:

the documentStructure

getParties

public java.util.List<Parties> getParties()

Gets the parties.

Definitions of the parties identified in the input document.

Returns:

the parties