com.ibm.commerce.catalog.facade.datatypes

Interface CatalogNavigationViewType

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.catalog.facade.datatypes.BreadCrumbTrailViewType getBreadCrumbTrailView()
      Returns the value of the 'Bread Crumb Trail View' containment reference.
      java.util.List getCatalogEntryView()
      Returns the value of the 'Catalog Entry View' containment reference list.
      java.util.List getCatalogGroupView()
      Returns the value of the 'Catalog Group View' containment reference list.
      java.util.List getFacetView()
      Returns the value of the 'Facet View' containment reference list.
      java.util.Map getMetaData()
      Returns the value of the 'Meta Data' map.
      com.ibm.commerce.catalog.facade.datatypes.PreviewReportType getPreviewReport()
      Returns the value of the 'Preview Report' containment reference.
      java.util.List getSuggestionView()
      Returns the value of the 'Suggestion View' containment reference list.
      UserDataType getUserData()
      Returns the value of the 'User Data' containment reference.
      java.util.List getWebContentView()
      Returns the value of the 'Web Content View' containment reference list.
      void setBreadCrumbTrailView(com.ibm.commerce.catalog.facade.datatypes.BreadCrumbTrailViewType value)
      Sets the value of the 'Bread Crumb Trail View' containment reference.
      void setPreviewReport(com.ibm.commerce.catalog.facade.datatypes.PreviewReportType value)
      Sets the value of the 'Preview Report' containment reference.
      void setUserData(UserDataType value)
      Sets the value of the 'User Data' containment reference.
    • Method Detail

      • getCatalogEntryView

        java.util.List getCatalogEntryView()
        Returns the value of the 'Catalog Entry View' containment reference list. The list contents are of type CatalogEntryViewType. List of catalog entries within the given catalog navigation view scope.
        Returns:
        the value of the 'Catalog Entry View' containment reference list.
        See Also:
        CatalogPackage.getCatalogNavigationViewType_CatalogEntryView()
      • getCatalogGroupView

        java.util.List getCatalogGroupView()
        Returns the value of the 'Catalog Group View' containment reference list. The list contents are of type CatalogGroupViewType. List of catalog groups within the given catalog navigation view scope.
        Returns:
        the value of the 'Catalog Group View' containment reference list.
        See Also:
        CatalogPackage.getCatalogNavigationViewType_CatalogGroupView()
      • getFacetView

        java.util.List getFacetView()
        Returns the value of the 'Facet View' containment reference list. The list contents are of type FacetViewType. Additional meta data for this catalog.
        Returns:
        the value of the 'Facet View' containment reference list.
        See Also:
        CatalogPackage.getCatalogNavigationViewType_FacetView()
      • getMetaData

        java.util.Map getMetaData()
        Returns the value of the 'Meta Data' map. The key is of type String, and the value is of type String,

        If the meaning of the 'Meta Data' map isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Meta Data' map.
        See Also:
        CatalogPackage.getCatalogNavigationViewType_MetaData()
      • getBreadCrumbTrailView

        com.ibm.commerce.catalog.facade.datatypes.BreadCrumbTrailViewType getBreadCrumbTrailView()
        Returns the value of the 'Bread Crumb Trail View' containment reference.

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

        Returns:
        the value of the 'Bread Crumb Trail View' containment reference.
        See Also:
        setBreadCrumbTrailView(BreadCrumbTrailViewType), CatalogPackage.getCatalogNavigationViewType_BreadCrumbTrailView()
      • setBreadCrumbTrailView

        void setBreadCrumbTrailView(com.ibm.commerce.catalog.facade.datatypes.BreadCrumbTrailViewType value)
        Sets the value of the 'Bread Crumb Trail View' containment reference.
        Parameters:
        value - the new value of the 'Bread Crumb Trail View' containment reference.
        See Also:
        getBreadCrumbTrailView()
      • getUserData

        UserDataType getUserData()
        Returns the value of the 'User Data' containment reference. Additional data for this catalog entry.
        Returns:
        the value of the 'User Data' containment reference.
        See Also:
        setUserData(UserDataType), CatalogPackage.getCatalogNavigationViewType_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()
      • getPreviewReport

        com.ibm.commerce.catalog.facade.datatypes.PreviewReportType getPreviewReport()
        Returns the value of the 'Preview Report' containment reference.

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

        Returns:
        the value of the 'Preview Report' containment reference.
        See Also:
        setPreviewReport(PreviewReportType), CatalogPackage.getCatalogNavigationViewType_PreviewReport()
      • setPreviewReport

        void setPreviewReport(com.ibm.commerce.catalog.facade.datatypes.PreviewReportType value)
        Sets the value of the 'Preview Report' containment reference.
        Parameters:
        value - the new value of the 'Preview Report' containment reference.
        See Also:
        getPreviewReport()
      • getSuggestionView

        java.util.List getSuggestionView()
        Returns the value of the 'Suggestion View' containment reference list. The list contents are of type SuggestionViewType.

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

        Returns:
        the value of the 'Suggestion View' containment reference list.
        See Also:
        CatalogPackage.getCatalogNavigationViewType_SuggestionView()
      • getWebContentView

        java.util.List getWebContentView()
        Returns the value of the 'Web Content View' containment reference list. The list contents are of type WebContentViewType. List of web content entries within the given catalog navigation view scope.
        Returns:
        the value of the 'Web Content View' containment reference list.
        See Also:
        CatalogPackage.getCatalogNavigationViewType_WebContentView()