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.

Constructor Summary

Constructors

Constructor and Description
ClassifyReturn()

Method Summary

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

getClass, notify, notifyAll, wait, wait, wait

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 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 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 List<Element> getElements()

Gets the elements.

Document elements identified by the service.

Returns:

the elements

getEffectiveDates

public List<EffectiveDates> getEffectiveDates()

Gets the effectiveDates.

The date or dates on which the document becomes effective.

Returns:

the effectiveDates

getContractAmounts

public 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 List<TerminationDates> getTerminationDates()

Gets the terminationDates.

The dates on which the document is to be terminated.

Returns:

the terminationDates

getContractTypes

public List<ContractTypes> getContractTypes()

Gets the contractTypes.

The contract type as declared in the document.

Returns:

the contractTypes

getContractTerms

public List<ContractTerms> getContractTerms()

Gets the contractTerms.

The durations of the contract.

Returns:

the contractTerms

getPaymentTerms

public List<PaymentTerms> getPaymentTerms()

Gets the paymentTerms.

The document's payment durations.

Returns:

the paymentTerms

getContractCurrencies

public List<ContractCurrencies> getContractCurrencies()

Gets the contractCurrencies.

The contract currencies as declared in the document.

Returns:

the contractCurrencies

getTables

public 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 List<Parties> getParties()

Gets the parties.

Definitions of the parties identified in the input document.

Returns:

the parties