API Documentation
Back to top  

AgreementInterface

Extends

Interface AgreementInterface

category

Core
package

Agreement
subpackage

Interfaces

Methods

Deletes the agreement.

delete() : $this|\AgreementInterface

Response

$this|\AgreementInterface

Same instance for chained method calls.

Returns the content group ID of the legal text.

getContentGroup() : \IdType

Response

\IdType

Returns the customers of the agreement.

getCustomer() : \AgreementCustomerInterface

Response

\AgreementCustomerInterface

Customer.

Returns the date and time of the agreement.

getDateAdded() : \DateTime

Response

\DateTime

Date and time of the agreement.

Returns the agreement id.

getId() : \IdType

Response

\IdType

Agreement id.

Returns the IP address of the customer which confirmed the agreement.

getIpAddress() : \StringType

Response

\StringType

Returns the language ID of the agreement.

getLanguageId() : \IdType

Response

\IdType

Language ID.

Returns the last modified date of the agreement.

getLastModifiedDateTime() : \DateTime

Response

\DateTime

Date and time of the agreement.

Returns the version of the legal text.

getLegalTextVersion() : \StringType

Response

\StringType

Returns the text of the agreement.

getText() : \StringType

Response

\StringType

Sets the content group of the legal text.

setContentGroup(\IdType $contentGroup) : $this|\AgreementInterface

Arguments

$contentGroup

\IdType

Response

$this|\AgreementInterface

Same instance for chained method calls.

Sets the customer of the agreement.

setCustomer(\AgreementCustomerInterface $customer) : $this|\AgreementInterface

Arguments

$customer

\AgreementCustomerInterface

Customer.

Response

$this|\AgreementInterface

Same instance for chained method calls.

Sets the date of the agreement.

setDateAdded(\DateTime $dateTime) : $this|\AgreementInterface

Arguments

$dateTime

\DateTime

Date and time.

Response

$this|\AgreementInterface

Same instance for chained method calls.

Sets the agreement id.

setId(\IdType $id) : $this|\AgreementInterface

Arguments

$id

\IdType

The agreement id to be set.

Response

$this|\AgreementInterface

Same instance for chained method calls.

Sets the IP address of the customer which confirmed the agreement.

setIpAddress(\StringType $ipAddress) : $this|\AgreementInterface

Arguments

$ipAddress

\StringType

Response

$this|\AgreementInterface

Same instance for chained method calls.

Sets the language ID of the agreement.

setLanguageId(\IdType $languageId) : $this|\AgreementInterface

Arguments

$languageId

\IdType

Language ID.

Response

$this|\AgreementInterface

Same instance for chained method calls.

Sets the last modified date of the agreement.

setLastModifiedDate(\DateTime $dateTime) : $this|\AgreementInterface

Arguments

$dateTime

\DateTime

Date and time.

Response

$this|\AgreementInterface

Same instance for chained method calls.

Sets the version of the legal text.

setLegalTextVersion(\StringType $legalTextVersion) : $this|\AgreementInterface

Arguments

$legalTextVersion

\StringType

Version of the legal text.

Response

$this|\AgreementInterface

Same instance for chained method calls.

Sets the text of the agreement.

setText(\NonEmptyStringType $text) : $this|\AgreementInterface

Arguments

$text

\NonEmptyStringType

Agreement text.

Response

$this|\AgreementInterface

Same instance for chained method calls.

Stores the agreement.

store() : $this|\AgreementInterface

Response

$this|\AgreementInterface

Same instance for chained method calls.