com.ibm.commerce.context.content.resources.metadata

Class PublishRequest

  • java.lang.Object
    • com.ibm.commerce.context.content.resources.metadata.PublishRequest

  • public class PublishRequest
extends java.lang.Object
    This class represents the information required to perform a publish request when the publish event is raised.

    • Constructor Summary

      Constructors 
      Constructor and Description
      PublishRequest()
      This is the default constructor for this class.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addPublishTask(PublishTask publishTask)
      This method adds a new publish task to the publish request.
      java.lang.Boolean getForceEARUpdate()
      Returns whether or not the EAR will be updated during quick publish.
      java.lang.Boolean getPostPublishEnabled()
      This method returns whether post publish is enabled for this publish request.
      PublishTask[] getPublishTasks()
      This method returns the publish tasks associated with the publish request.
      java.lang.String getStatus()
      This method gets the status.
      boolean isTransactionUnique()
      This method returns whether the publish request for this container requires a unique transaction.
      void setForceEARUpdate(boolean b)
      Sets whether or not the EAR will be updated during this quick publish step.
      void setPostPublishEnabled(boolean postPublish)
      This method sets whether the post publish is enabled for this publish request.
      void setStatus(java.lang.String string)
      This method sets the status.
      void setUniqueTransaction(boolean uniqueTransaction)
      This method sets whether the publish request requires a unique transaction.
      java.lang.String toString()
      This method returns a String representation of the object.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • PublishRequest

        public PublishRequest()
        This is the default constructor for this class. It calls the constructor from the superclass.

    • Method Detail

      • isTransactionUnique

        public boolean isTransactionUnique()
        This method returns whether the publish request for this container requires a unique transaction.
        Returns:
        Whether a unique transaction is required.

      • setUniqueTransaction

        public void setUniqueTransaction(boolean uniqueTransaction)
        This method sets whether the publish request requires a unique transaction.
        Parameters:
        uniqueTransaction - Whether the transaction should be unique.

      • getPostPublishEnabled

        public java.lang.Boolean getPostPublishEnabled()
        This method returns whether post publish is enabled for this publish request. for this container
        Returns:
        Whether post publish is enabled.

      • setPostPublishEnabled

        public void setPostPublishEnabled(boolean postPublish)
        This method sets whether the post publish is enabled for this publish request.
        Parameters:
        postPublish - Whether post publish is enabled.

      • addPublishTask

        public void addPublishTask(PublishTask publishTask)
        This method adds a new publish task to the publish request.
        Parameters:
        publishTask - A publish task.

      • getPublishTasks

        public PublishTask[] getPublishTasks()
        This method returns the publish tasks associated with the publish request.
        Returns:
        The publish tasks.

      • toString

        public java.lang.String toString()
        This method returns a String representation of the object.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A readable String version of the object.

      • getStatus

        public java.lang.String getStatus()
        This method gets the status.
        Returns:
        The status.

      • setStatus

        public void setStatus(java.lang.String string)
        This method sets the status.
        Parameters:
        string - The status.

      • getForceEARUpdate

        public java.lang.Boolean getForceEARUpdate()
        Returns whether or not the EAR will be updated during quick publish.
        Returns:
        true if the quick publish step will enforce the EAR update.

      • setForceEARUpdate

        public void setForceEARUpdate(boolean b)
        Sets whether or not the EAR will be updated during this quick publish step.
        Parameters:
        b - true to force an EAR update after this quick publish step.
Skip navigation links