com.ibm.commerce.foundation.common.datatypes

Interface DocumentRoot

    • Method Detail

      • getMixed

        commonj.sdo.Sequence getMixed()
        Returns the value of the 'Mixed' attribute list.

        If the meaning of the 'Mixed' attribute list isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Mixed' attribute list.
        See Also:
        CommerceFoundationPackage.getDocumentRoot_Mixed()

      • getXMLNSPrefixMap

        java.util.Map getXMLNSPrefixMap()
        Returns the value of the 'XMLNS Prefix Map' map. The key is of type String, and the value is of type String,

        If the meaning of the 'XMLNS Prefix Map' map isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'XMLNS Prefix Map' map.
        See Also:
        CommerceFoundationPackage.getDocumentRoot_XMLNSPrefixMap()

      • getXSISchemaLocation

        java.util.Map getXSISchemaLocation()
        Returns the value of the 'XSI Schema Location' map. The key is of type String, and the value is of type String,

        If the meaning of the 'XSI Schema Location' map isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'XSI Schema Location' map.
        See Also:
        CommerceFoundationPackage.getDocumentRoot_XSISchemaLocation()

      • getUserData

        UserDataType getUserData()
        Returns the value of the 'User Data' containment reference. The element definition of a user data area.
        Returns:
        the value of the 'User Data' containment reference.
        See Also:
        setUserData(UserDataType), CommerceFoundationPackage.getDocumentRoot_UserData()

      • setUserData

        void setUserData(UserDataType value)
        Sets the value of the 'User Data' containment reference.
        Parameters:
        value - the new value of the 'User Data' containment reference.
        See Also:
        getUserData()

      • getApplicationArea

        ApplicationAreaType getApplicationArea()
        Returns the value of the 'Application Area' containment reference. Element definition of the application area of a business object document. A substitution for the OAGIS application area.
        Returns:
        the value of the 'Application Area' containment reference.
        See Also:
        setApplicationArea(ApplicationAreaType), CommerceFoundationPackage.getDocumentRoot_ApplicationArea()

      • getBusinessContext

        BusinessContextType getBusinessContext()
        Returns the value of the 'Business Context' containment reference. Element definition of the business context.
        Returns:
        the value of the 'Business Context' containment reference.
        See Also:
        setBusinessContext(BusinessContextType), CommerceFoundationPackage.getDocumentRoot_BusinessContext()

      • getContextData

        ContextDataType getContextData()
        Returns the value of the 'Context Data' containment reference. The element definition of a context data.
        Returns:
        the value of the 'Context Data' containment reference.
        See Also:
        setContextData(ContextDataType), CommerceFoundationPackage.getDocumentRoot_ContextData()

      • setContextData

        void setContextData(ContextDataType value)
        Sets the value of the 'Context Data' containment reference.
        Parameters:
        value - the new value of the 'Context Data' containment reference.
        See Also:
        getContextData()

      • getMetadata

        com.ibm.commerce.foundation.common.datatypes.MetadataType getMetadata()
        Returns the value of the 'Metadata' containment reference.

        If the meaning of the 'Metadata' containment reference isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Metadata' containment reference.
        See Also:
        setMetadata(MetadataType), CommerceFoundationPackage.getDocumentRoot_Metadata()

      • setMetadata

        void setMetadata(com.ibm.commerce.foundation.common.datatypes.MetadataType value)
        Sets the value of the 'Metadata' containment reference.
        Parameters:
        value - the new value of the 'Metadata' containment reference.
        See Also:
        getMetadata()

      • getResponseCriteria

        com.ibm.commerce.foundation.common.datatypes.ResponseActionCriteriaType getResponseCriteria()
        Returns the value of the 'Response Criteria' containment reference.

        If the meaning of the 'Response Criteria' containment reference isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Response Criteria' containment reference.
        See Also:
        setResponseCriteria(ResponseActionCriteriaType), CommerceFoundationPackage.getDocumentRoot_ResponseCriteria()

      • setResponseCriteria

        void setResponseCriteria(com.ibm.commerce.foundation.common.datatypes.ResponseActionCriteriaType value)
        Sets the value of the 'Response Criteria' containment reference.
        Parameters:
        value - the new value of the 'Response Criteria' containment reference.
        See Also:
        getResponseCriteria()

      • getAddress

        AddressType getAddress()
        Returns the value of the 'Address' containment reference. The element definition of an address.
        Returns:
        the value of the 'Address' containment reference.
        See Also:
        setAddress(AddressType), CommerceFoundationPackage.getDocumentRoot_Address()

      • setAddress

        void setAddress(AddressType value)
        Sets the value of the 'Address' containment reference.
        Parameters:
        value - the new value of the 'Address' containment reference.
        See Also:
        getAddress()

      • getAdjustment

        AdjustmentType getAdjustment()
        Returns the value of the 'Adjustment' containment reference. Element definition of an adjustment.
        Returns:
        the value of the 'Adjustment' containment reference.
        See Also:
        setAdjustment(AdjustmentType), CommerceFoundationPackage.getDocumentRoot_Adjustment()

      • setAdjustment

        void setAdjustment(AdjustmentType value)
        Sets the value of the 'Adjustment' containment reference.
        Parameters:
        value - the new value of the 'Adjustment' containment reference.
        See Also:
        getAdjustment()

      • getAttachmentAsset

        AttachmentAssetType getAttachmentAsset()
        Returns the value of the 'Attachment Asset' containment reference. Definition of an attachment asset.
        Returns:
        the value of the 'Attachment Asset' containment reference.
        See Also:
        setAttachmentAsset(AttachmentAssetType), CommerceFoundationPackage.getDocumentRoot_AttachmentAsset()

      • getAttachmentDescription

        AttachmentDescriptionType getAttachmentDescription()
        Returns the value of the 'Attachment Description' containment reference. Language or locale specific description of an attachment.
        Returns:
        the value of the 'Attachment Description' containment reference.
        See Also:
        setAttachmentDescription(AttachmentDescriptionType), CommerceFoundationPackage.getDocumentRoot_AttachmentDescription()

      • getAttachmentReference

        AttachmentReferenceType getAttachmentReference()
        Returns the value of the 'Attachment Reference' containment reference. An attachment relation or reference to a supported Commerce business objects.
        Returns:
        the value of the 'Attachment Reference' containment reference.
        See Also:
        setAttachmentReference(AttachmentReferenceType), CommerceFoundationPackage.getDocumentRoot_AttachmentReference()

      • getAttachmentReferenceDescription

        AttachmentDescriptionType getAttachmentReferenceDescription()
        Returns the value of the 'Attachment Reference Description' containment reference. Language or locale specific description of the attachment relation.
        Returns:
        the value of the 'Attachment Reference Description' containment reference.
        See Also:
        setAttachmentReferenceDescription(AttachmentDescriptionType), CommerceFoundationPackage.getDocumentRoot_AttachmentReferenceDescription()

      • getAttachmentUsage

        AttachmentUsageType getAttachmentUsage()
        Returns the value of the 'Attachment Usage' containment reference. Definition of usage type in an attachment relation.
        Returns:
        the value of the 'Attachment Usage' containment reference.
        See Also:
        setAttachmentUsage(AttachmentUsageType), CommerceFoundationPackage.getDocumentRoot_AttachmentUsage()

      • getAttachmentUsageDescription

        AttachmentDescriptionType getAttachmentUsageDescription()
        Returns the value of the 'Attachment Usage Description' containment reference. Language or locale specific description of the usage of an attachment.
        Returns:
        the value of the 'Attachment Usage Description' containment reference.
        See Also:
        setAttachmentUsageDescription(AttachmentDescriptionType), CommerceFoundationPackage.getDocumentRoot_AttachmentUsageDescription()

      • getBestCallingTime

        java.lang.Object getBestCallingTime()
        Returns the value of the 'Best Calling Time' attribute. The best time to call.
        Returns:
        the value of the 'Best Calling Time' attribute.
        See Also:
        setBestCallingTime(Object), CommerceFoundationPackage.getDocumentRoot_BestCallingTime()

      • setBestCallingTime

        void setBestCallingTime(java.lang.Object value)
        Sets the value of the 'Best Calling Time' attribute.
        Parameters:
        value - the new value of the 'Best Calling Time' attribute.
        See Also:
        getBestCallingTime()

      • getContactName

        PersonNameType getContactName()
        Returns the value of the 'Contact Name' containment reference. The element definition of the contact's name.
        Returns:
        the value of the 'Contact Name' containment reference.
        See Also:
        setContactName(PersonNameType), CommerceFoundationPackage.getDocumentRoot_ContactName()

      • setContactName

        void setContactName(PersonNameType value)
        Sets the value of the 'Contact Name' containment reference.
        Parameters:
        value - the new value of the 'Contact Name' containment reference.
        See Also:
        getContactName()

      • getCreatedTime

        java.lang.Object getCreatedTime()
        Returns the value of the 'Created Time' attribute. The create time..
        Returns:
        the value of the 'Created Time' attribute.
        See Also:
        setCreatedTime(Object), CommerceFoundationPackage.getDocumentRoot_CreatedTime()

      • setCreatedTime

        void setCreatedTime(java.lang.Object value)
        Sets the value of the 'Created Time' attribute.
        Parameters:
        value - the new value of the 'Created Time' attribute.
        See Also:
        getCreatedTime()

      • getEmailAddress

        EmailAddressType getEmailAddress()
        Returns the value of the 'Email Address' containment reference. The element definition of an email address.
        Returns:
        the value of the 'Email Address' containment reference.
        See Also:
        setEmailAddress(EmailAddressType), CommerceFoundationPackage.getDocumentRoot_EmailAddress()

      • setEmailAddress

        void setEmailAddress(EmailAddressType value)
        Sets the value of the 'Email Address' containment reference.
        Parameters:
        value - the new value of the 'Email Address' containment reference.
        See Also:
        getEmailAddress()

      • getExternalContentAsset

        com.ibm.commerce.foundation.common.datatypes.ExternalContentAssetType getExternalContentAsset()
        Returns the value of the 'External Content Asset' containment reference. The assets belong to the external content.
        Returns:
        the value of the 'External Content Asset' containment reference.
        See Also:
        setExternalContentAsset(ExternalContentAssetType), CommerceFoundationPackage.getDocumentRoot_ExternalContentAsset()

      • setExternalContentAsset

        void setExternalContentAsset(com.ibm.commerce.foundation.common.datatypes.ExternalContentAssetType value)
        Sets the value of the 'External Content Asset' containment reference.
        Parameters:
        value - the new value of the 'External Content Asset' containment reference.
        See Also:
        getExternalContentAsset()

      • getExternalContentBODVersion

        java.lang.String getExternalContentBODVersion()
        Returns the value of the 'External Content BOD Version' attribute. The default value is "7.0". The version of WebSphere Commerce when the ExternalContent noun was last changed. The value is set as the versionID attribute in the corresponding BODs.
        Returns:
        the value of the 'External Content BOD Version' attribute.
        See Also:
        setExternalContentBODVersion(String), CommerceFoundationPackage.getDocumentRoot_ExternalContentBODVersion()

      • getExternalContentReference

        com.ibm.commerce.foundation.common.datatypes.ExternalContentReferenceType getExternalContentReference()
        Returns the value of the 'External Content Reference' containment reference. An external content relation or reference to a supported Commerce business objects.
        Returns:
        the value of the 'External Content Reference' containment reference.
        See Also:
        setExternalContentReference(ExternalContentReferenceType), CommerceFoundationPackage.getDocumentRoot_ExternalContentReference()

      • setExternalContentReference

        void setExternalContentReference(com.ibm.commerce.foundation.common.datatypes.ExternalContentReferenceType value)
        Sets the value of the 'External Content Reference' containment reference.
        Parameters:
        value - the new value of the 'External Content Reference' containment reference.
        See Also:
        getExternalContentReference()

      • getFax

        FaxType getFax()
        Returns the value of the 'Fax' containment reference. The element definition of a fax number.
        Returns:
        the value of the 'Fax' containment reference.
        See Also:
        setFax(FaxType), CommerceFoundationPackage.getDocumentRoot_Fax()

      • setFax

        void setFax(FaxType value)
        Sets the value of the 'Fax' containment reference.
        Parameters:
        value - the new value of the 'Fax' containment reference.
        See Also:
        getFax()

      • getLastUpdateTime

        java.lang.Object getLastUpdateTime()
        Returns the value of the 'Last Update Time' attribute. The last update time.
        Returns:
        the value of the 'Last Update Time' attribute.
        See Also:
        setLastUpdateTime(Object), CommerceFoundationPackage.getDocumentRoot_LastUpdateTime()

      • setLastUpdateTime

        void setLastUpdateTime(java.lang.Object value)
        Sets the value of the 'Last Update Time' attribute.
        Parameters:
        value - the new value of the 'Last Update Time' attribute.
        See Also:
        getLastUpdateTime()

      • getMobilePhone

        com.ibm.commerce.foundation.common.datatypes.MobilePhoneType getMobilePhone()
        Returns the value of the 'Mobile Phone' containment reference. The element definition of a mobile phone number.
        Returns:
        the value of the 'Mobile Phone' containment reference.
        See Also:
        setMobilePhone(MobilePhoneType), CommerceFoundationPackage.getDocumentRoot_MobilePhone()

      • setMobilePhone

        void setMobilePhone(com.ibm.commerce.foundation.common.datatypes.MobilePhoneType value)
        Sets the value of the 'Mobile Phone' containment reference.
        Parameters:
        value - the new value of the 'Mobile Phone' containment reference.
        See Also:
        getMobilePhone()

      • getScheduleInfo

        com.ibm.commerce.foundation.common.datatypes.ScheduleInfoType getScheduleInfo()
        Returns the value of the 'Schedule Info' containment reference.

        If the meaning of the 'Schedule Info' containment reference isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Schedule Info' containment reference.
        See Also:
        setScheduleInfo(ScheduleInfoType), CommerceFoundationPackage.getDocumentRoot_ScheduleInfo()

      • setScheduleInfo

        void setScheduleInfo(com.ibm.commerce.foundation.common.datatypes.ScheduleInfoType value)
        Sets the value of the 'Schedule Info' containment reference.
        Parameters:
        value - the new value of the 'Schedule Info' containment reference.
        See Also:
        getScheduleInfo()

      • getSEOProperties

        com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType getSEOProperties()
        Returns the value of the 'SEO Properties' containment reference. Language/locale specific SEO properties for a store page (e.g. content pages, catalog group, and catalog entry pages).
        Returns:
        the value of the 'SEO Properties' containment reference.
        See Also:
        setSEOProperties(SEOPropertiesType), CommerceFoundationPackage.getDocumentRoot_SEOProperties()

      • setSEOProperties

        void setSEOProperties(com.ibm.commerce.foundation.common.datatypes.SEOPropertiesType value)
        Sets the value of the 'SEO Properties' containment reference.
        Parameters:
        value - the new value of the 'SEO Properties' containment reference.
        See Also:
        getSEOProperties()

      • getSEOSiteMapInfo

        com.ibm.commerce.foundation.common.datatypes.SEOSiteMapInfoType getSEOSiteMapInfo()
        Returns the value of the 'SEO Site Map Info' containment reference.

        If the meaning of the 'SEO Site Map Info' containment reference isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'SEO Site Map Info' containment reference.
        See Also:
        setSEOSiteMapInfo(SEOSiteMapInfoType), CommerceFoundationPackage.getDocumentRoot_SEOSiteMapInfo()

      • setSEOSiteMapInfo

        void setSEOSiteMapInfo(com.ibm.commerce.foundation.common.datatypes.SEOSiteMapInfoType value)
        Sets the value of the 'SEO Site Map Info' containment reference.
        Parameters:
        value - the new value of the 'SEO Site Map Info' containment reference.
        See Also:
        getSEOSiteMapInfo()

      • getSEOURL

        com.ibm.commerce.foundation.common.datatypes.SEOURLType getSEOURL()
        Returns the value of the 'SEOURL' containment reference.

        If the meaning of the 'SEOURL' containment reference isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'SEOURL' containment reference.
        See Also:
        setSEOURL(SEOURLType), CommerceFoundationPackage.getDocumentRoot_SEOURL()

      • setSEOURL

        void setSEOURL(com.ibm.commerce.foundation.common.datatypes.SEOURLType value)
        Sets the value of the 'SEOURL' containment reference.
        Parameters:
        value - the new value of the 'SEOURL' containment reference.
        See Also:
        getSEOURL()

      • getSEOURLKeyword

        com.ibm.commerce.foundation.common.datatypes.SEOURLKeywordType getSEOURLKeyword()
        Returns the value of the 'SEOURL Keyword' containment reference.

        If the meaning of the 'SEOURL Keyword' containment reference isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'SEOURL Keyword' containment reference.
        See Also:
        setSEOURLKeyword(SEOURLKeywordType), CommerceFoundationPackage.getDocumentRoot_SEOURLKeyword()

      • setSEOURLKeyword

        void setSEOURLKeyword(com.ibm.commerce.foundation.common.datatypes.SEOURLKeywordType value)
        Sets the value of the 'SEOURL Keyword' containment reference.
        Parameters:
        value - the new value of the 'SEOURL Keyword' containment reference.
        See Also:
        getSEOURLKeyword()

      • getSubscriptionInfo

        com.ibm.commerce.foundation.common.datatypes.SubscriptionInfoType getSubscriptionInfo()
        Returns the value of the 'Subscription Info' containment reference.

        If the meaning of the 'Subscription Info' containment reference isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Subscription Info' containment reference.
        See Also:
        setSubscriptionInfo(SubscriptionInfoType), CommerceFoundationPackage.getDocumentRoot_SubscriptionInfo()

      • setSubscriptionInfo

        void setSubscriptionInfo(com.ibm.commerce.foundation.common.datatypes.SubscriptionInfoType value)
        Sets the value of the 'Subscription Info' containment reference.
        Parameters:
        value - the new value of the 'Subscription Info' containment reference.
        See Also:
        getSubscriptionInfo()

      • getTaxByTaxCategory

        TaxByTaxCategoryType getTaxByTaxCategory()
        Returns the value of the 'Tax By Tax Category' containment reference. Element definition of the tax amount for a tax category.
        Returns:
        the value of the 'Tax By Tax Category' containment reference.
        See Also:
        setTaxByTaxCategory(TaxByTaxCategoryType), CommerceFoundationPackage.getDocumentRoot_TaxByTaxCategory()

      • getTelephone

        TelephoneType getTelephone()
        Returns the value of the 'Telephone' containment reference. The element definition of a phone number.
        Returns:
        the value of the 'Telephone' containment reference.
        See Also:
        setTelephone(TelephoneType), CommerceFoundationPackage.getDocumentRoot_Telephone()

      • setTelephone

        void setTelephone(TelephoneType value)
        Sets the value of the 'Telephone' containment reference.
        Parameters:
        value - the new value of the 'Telephone' containment reference.
        See Also:
        getTelephone()

      • getTotalTaxByTaxCategory

        TaxByTaxCategoryType getTotalTaxByTaxCategory()
        Returns the value of the 'Total Tax By Tax Category' containment reference. Element definition of the total tax amount for a tax category.
        Returns:
        the value of the 'Total Tax By Tax Category' containment reference.
        See Also:
        setTotalTaxByTaxCategory(TaxByTaxCategoryType), CommerceFoundationPackage.getDocumentRoot_TotalTaxByTaxCategory()
Skip navigation links
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method