Package org.springframework.extensions.webscripts

Class PreviewContext

  • public class PreviewContext
extends java.lang.Object
    Provides information about the WCM sandbox which is currently being previewed. A sandbox context provider may be registered with any of the Alfresco Store types. LocalFileSystemStore RemoteStore
    Author:
    muzquiano

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String DEFAULT_STORE_ID  

    • Constructor Summary

      Constructors 
      Constructor Description
      PreviewContext()  
      PreviewContext​(java.lang.String storeId)
      Constructs a new preview context instance
      PreviewContext​(java.lang.String storeId, java.lang.String webappId)
      Constructs a new preview context instance
      PreviewContext​(java.lang.String storeId, java.lang.String webappId, java.lang.String userId)
      Constructs a new preview context instance

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getStoreId()
      Gets the id of the store
      java.lang.String getUserId()
      Gets the user id
      java.lang.String getWebappId()
      Gets the WCM web application id This applies for the case where the store is an AVM store which was built by Alfresco WCM.
      void setStoreId​(java.lang.String storeId)
      Sets the id of the store
      void setUserId​(java.lang.String userId)
      Sets the user id
      void setWebappId​(java.lang.String webappId)
      Sets the WCM web application id This applies for the case where the store is an AVM store which was built by Alfresco WCM.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DEFAULT_STORE_ID

        public static final java.lang.String DEFAULT_STORE_ID
        See Also:
        Constant Field Values

    • Constructor Detail

      • PreviewContext

        public PreviewContext()

      • PreviewContext

        public PreviewContext​(java.lang.String storeId)
        Constructs a new preview context instance
        Parameters:
        storeId - the store id

      • PreviewContext

        public PreviewContext​(java.lang.String storeId,
                      java.lang.String webappId)
        Constructs a new preview context instance
        Parameters:
        storeId - the store id
        webappId - the WCM web application id

      • PreviewContext

        public PreviewContext​(java.lang.String storeId,
                      java.lang.String webappId,
                      java.lang.String userId)
        Constructs a new preview context instance
        Parameters:
        storeId - the store id
        webappId - the WCM web application id
        userId - the user id

    • Method Detail

      • getStoreId

        public java.lang.String getStoreId()
        Gets the id of the store
        Returns:
        the store id

      • setStoreId

        public void setStoreId​(java.lang.String storeId)
        Sets the id of the store
        Parameters:
        storeId - the store id

      • getWebappId

        public java.lang.String getWebappId()
        Gets the WCM web application id This applies for the case where the store is an AVM store which was built by Alfresco WCM.
        Returns:
        the WCM web application id

      • setWebappId

        public void setWebappId​(java.lang.String webappId)
        Sets the WCM web application id This applies for the case where the store is an AVM store which was built by Alfresco WCM.
        Parameters:
        webappId - the WCM web application id

      • getUserId

        public java.lang.String getUserId()
        Gets the user id
        Returns:
        user id

      • setUserId

        public void setUserId​(java.lang.String userId)
        Sets the user id
        Parameters:
        userId - user id