java.lang.Object
de.hybris.platform.tuawebservicesresources.v2.dto.Agreement

public class Agreement extends Object
An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.
  • Constructor Details

    • Agreement

      public Agreement()
  • Method Details

    • id

      public Agreement id(String id)
    • getId

      public String getId()
      Unique identifier for the agreement
      Returns:
      id
    • setId

      public void setId(String id)
    • href

      public Agreement href(String href)
    • getHref

      public String getHref()
      Unique url identifying the agreement as a resource
      Returns:
      href
    • setHref

      public void setHref(String href)
    • agreementType

      public Agreement agreementType(String agreementType)
    • getAgreementType

      public String getAgreementType()
      The type of the agreement. For example commercial
      Returns:
      agreementType
    • setAgreementType

      public void setAgreementType(String agreementType)
    • description

      public Agreement description(String description)
    • getDescription

      public String getDescription()
      Narrative that explains the agreement and details about the it , such as why the agreement is taking place.
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • documentNumber

      public Agreement documentNumber(Integer documentNumber)
    • getDocumentNumber

      public Integer getDocumentNumber()
      A reference number assigned to an Agreement that follows a prescribed numbering system.
      Returns:
      documentNumber
    • setDocumentNumber

      public void setDocumentNumber(Integer documentNumber)
    • initialDate

      public Agreement initialDate(Date initialDate)
    • getInitialDate

      @Valid public @Valid Date getInitialDate()
      Date at which the agreement was initialized
      Returns:
      initialDate
    • setInitialDate

      public void setInitialDate(Date initialDate)
    • name

      public Agreement name(String name)
    • getName

      @NotNull public @NotNull String getName()
      A human-readable name for the agreement
      Returns:
      name
    • setName

      public void setName(String name)
    • statementOfIntent

      public Agreement statementOfIntent(String statementOfIntent)
    • getStatementOfIntent

      public String getStatementOfIntent()
      An overview and goals of the Agreement
      Returns:
      statementOfIntent
    • setStatementOfIntent

      public void setStatementOfIntent(String statementOfIntent)
    • status

      public Agreement status(String status)
    • getStatus

      public String getStatus()
      The current status of the agreement. Typical values are: in process, approved and rejected
      Returns:
      status
    • setStatus

      public void setStatus(String status)
    • version

      public Agreement version(String version)
    • getVersion

      public String getVersion()
      A string identifying the version of the agreement
      Returns:
      version
    • setVersion

      public void setVersion(String version)
    • agreementAuthorization

      public Agreement agreementAuthorization(List<AgreementAuthorization> agreementAuthorization)
    • addAgreementAuthorizationItem

      public Agreement addAgreementAuthorizationItem(AgreementAuthorization agreementAuthorizationItem)
    • getAgreementAuthorization

      @Valid public @Valid List<AgreementAuthorization> getAgreementAuthorization()
      Get agreementAuthorization
      Returns:
      agreementAuthorization
    • setAgreementAuthorization

      public void setAgreementAuthorization(List<AgreementAuthorization> agreementAuthorization)
    • agreementItem

      public Agreement agreementItem(List<AgreementItem> agreementItem)
    • addAgreementItemItem

      public Agreement addAgreementItemItem(AgreementItem agreementItemItem)
    • getAgreementItem

      @Valid @Size(min=1) public @Valid @Size(min=1) List<AgreementItem> getAgreementItem()
      Get agreementItem
      Returns:
      agreementItem
    • setAgreementItem

      public void setAgreementItem(List<AgreementItem> agreementItem)
    • agreementPeriod

      public Agreement agreementPeriod(TimePeriod agreementPeriod)
    • getAgreementPeriod

      @Valid public @Valid TimePeriod getAgreementPeriod()
      Get agreementPeriod
      Returns:
      agreementPeriod
    • setAgreementPeriod

      public void setAgreementPeriod(TimePeriod agreementPeriod)
    • agreementSpecification

      public Agreement agreementSpecification(AgreementSpecificationRef agreementSpecification)
    • getAgreementSpecification

      @Valid public @Valid AgreementSpecificationRef getAgreementSpecification()
      Get agreementSpecification
      Returns:
      agreementSpecification
    • setAgreementSpecification

      public void setAgreementSpecification(AgreementSpecificationRef agreementSpecification)
    • associatedAgreement

      public Agreement associatedAgreement(List<AgreementRef> associatedAgreement)
    • addAssociatedAgreementItem

      public Agreement addAssociatedAgreementItem(AgreementRef associatedAgreementItem)
    • getAssociatedAgreement

      @Valid public @Valid List<AgreementRef> getAssociatedAgreement()
      Get associatedAgreement
      Returns:
      associatedAgreement
    • setAssociatedAgreement

      public void setAssociatedAgreement(List<AgreementRef> associatedAgreement)
    • characteristic

      public Agreement characteristic(List<AgreementCharacteristic> characteristic)
    • addCharacteristicItem

      public Agreement addCharacteristicItem(AgreementCharacteristic characteristicItem)
    • getCharacteristic

      @Valid public @Valid List<AgreementCharacteristic> getCharacteristic()
      Get characteristic
      Returns:
      characteristic
    • setCharacteristic

      public void setCharacteristic(List<AgreementCharacteristic> characteristic)
    • completionDate

      public Agreement completionDate(TimePeriod completionDate)
    • getCompletionDate

      @Valid public @Valid TimePeriod getCompletionDate()
      Get completionDate
      Returns:
      completionDate
    • setCompletionDate

      public void setCompletionDate(TimePeriod completionDate)
    • engagedParty

      public Agreement engagedParty(List<RelatedParty> engagedParty)
    • addEngagedPartyItem

      public Agreement addEngagedPartyItem(RelatedParty engagedPartyItem)
    • getEngagedParty

      @Valid public @Valid List<RelatedParty> getEngagedParty()
      Get engagedParty
      Returns:
      engagedParty
    • setEngagedParty

      public void setEngagedParty(List<RelatedParty> engagedParty)
    • atBaseType

      public Agreement atBaseType(String atBaseType)
    • getAtBaseType

      public String getAtBaseType()
      When sub-classing, this defines the super-class
      Returns:
      atBaseType
    • setAtBaseType

      public void setAtBaseType(String atBaseType)
    • atSchemaLocation

      public Agreement atSchemaLocation(String atSchemaLocation)
    • getAtSchemaLocation

      public String getAtSchemaLocation()
      A URI to a JSON-Schema file that defines additional attributes and relationships
      Returns:
      atSchemaLocation
    • setAtSchemaLocation

      public void setAtSchemaLocation(String atSchemaLocation)
    • atType

      public Agreement atType(String atType)
    • getAtType

      public String getAtType()
      When sub-classing, this defines the sub-class entity name
      Returns:
      atType
    • setAtType

      public void setAtType(String atType)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object