com.ibm.commerce.context.content.events

Class WorkspaceData

  • java.lang.Object
    • com.ibm.commerce.context.content.objects.Workspace
      • com.ibm.commerce.context.content.events.WorkspaceData
  • All Implemented Interfaces:
    java.io.Serializable

    public class WorkspaceData
extends com.ibm.commerce.context.content.objects.Workspace
    This class represents the configuration data associated with the workspace on which the event will be performed.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getBaseSchema()
      This method returns the configuration information of the base schema that is associated with the workspace.
      java.lang.String getReadSchema()
      This method returns the configuration information of the read schema that is associated with the workspace.
      java.lang.Short getSynchronizeRequired()
      This method returns the numeric value that determines whether the workspace needs to be synchronized.
      java.lang.String getWorkspaceId()
      This method returns the configuration information of the identifier that is associated with the workspace.
      java.lang.String getWorkspaceName()
      This method returns the configuration information of the name that is associated with the workspace.
      java.lang.String getWriteSchema()
      This method returns the configuration information of the write schema that is associated with the workspace.
      boolean isBaseOperation()
      This method returns whether the operation is a result of a change in the base.
      boolean isWorkspaceOperation()
      This method returns whether the operation is a result of a change in the workspace.
      void setBaseSchema(java.lang.String baseSchema)
      This method sets the configuration information of the base schema that is associated with the workspace.
      void setReadSchema(java.lang.String readSchema)
      This method sets the configuration information of the read schema that is associated with the workspace.
      void setSynchronizeRequired(java.lang.Short synchRequired)
      This method sets the synchronization flag.
      void setWorkspaceId(java.lang.String workspaceId)
      This method sets the configuration information of the unique workspace identifier that is associated with the workspace.
      void setWorkspaceName(java.lang.String workspaceName)
      This method sets the configuration information of the workspace name that is associated with the workspace.
      void setWriteSchema(java.lang.String writeSchema)
      This method sets the configuration information of the write schema that is associated with the workspace.

      • Methods inherited from class com.ibm.commerce.context.content.objects.Workspace

        getLockingPolicy, setLockingPolicy, toString

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • WorkspaceData

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

    • Method Detail

      • getBaseSchema

        public java.lang.String getBaseSchema()
        This method returns the configuration information of the base schema that is associated with the workspace.
        Overrides:
        getBaseSchema in class com.ibm.commerce.context.content.objects.Workspace
        Returns:
        The base schema of the workspace.

      • getReadSchema

        public java.lang.String getReadSchema()
        This method returns the configuration information of the read schema that is associated with the workspace.
        Overrides:
        getReadSchema in class com.ibm.commerce.context.content.objects.Workspace
        Returns:
        The read schema of the workspace.

      • getSynchronizeRequired

        public java.lang.Short getSynchronizeRequired()
        This method returns the numeric value that determines whether the workspace needs to be synchronized. A value of 0 means that no synchronization is required. A bit pattern is used to represent the synchronization required. For example, 01 (1) means the workspace operation that was performed caused the workspace to be out-of-synchronization. 10 (2) means an operation on the base caused the workspace to be out-of-synchronization. A value of 11 (3) means that both a workspace and base change has been made.
        Overrides:
        getSynchronizeRequired in class com.ibm.commerce.context.content.objects.Workspace
        Returns:
        The synchronization required flag.

      • getWorkspaceId

        public java.lang.String getWorkspaceId()
        This method returns the configuration information of the identifier that is associated with the workspace.
        Overrides:
        getWorkspaceId in class com.ibm.commerce.context.content.objects.Workspace
        Returns:
        The workspace identifier of the workspace.

      • getWorkspaceName

        public java.lang.String getWorkspaceName()
        This method returns the configuration information of the name that is associated with the workspace.
        Overrides:
        getWorkspaceName in class com.ibm.commerce.context.content.objects.Workspace
        Returns:
        The workspace name of the workspace.

      • getWriteSchema

        public java.lang.String getWriteSchema()
        This method returns the configuration information of the write schema that is associated with the workspace.
        Overrides:
        getWriteSchema in class com.ibm.commerce.context.content.objects.Workspace
        Returns:
        The write schema of the workspace.

      • setBaseSchema

        public void setBaseSchema(java.lang.String baseSchema)
        This method sets the configuration information of the base schema that is associated with the workspace.
        Overrides:
        setBaseSchema in class com.ibm.commerce.context.content.objects.Workspace
        Parameters:
        baseSchema - The base schema of the workspace.

      • setReadSchema

        public void setReadSchema(java.lang.String readSchema)
        This method sets the configuration information of the read schema that is associated with the workspace.
        Overrides:
        setReadSchema in class com.ibm.commerce.context.content.objects.Workspace
        Parameters:
        readSchema - The read schema of the workspace.

      • setSynchronizeRequired

        public void setSynchronizeRequired(java.lang.Short synchRequired)
        This method sets the synchronization flag. A value of 0 means that no synchronization is required. A bit pattern is used to represent the synchronization required. For example, 01 (1) means the workspace operation that was performed caused the workspace to be out-of-synchronization. 10 (2) means an operation on the base caused the workspace to be out-of-synchronization. A value of 11 (3) means that both a workspace and base change has been made.
        Overrides:
        setSynchronizeRequired in class com.ibm.commerce.context.content.objects.Workspace
        Parameters:
        synchRequired - The synchronization required flag.

      • setWorkspaceId

        public void setWorkspaceId(java.lang.String workspaceId)
        This method sets the configuration information of the unique workspace identifier that is associated with the workspace.
        Overrides:
        setWorkspaceId in class com.ibm.commerce.context.content.objects.Workspace
        Parameters:
        workspaceId - The unique workspace identifier of the workspace.

      • setWorkspaceName

        public void setWorkspaceName(java.lang.String workspaceName)
        This method sets the configuration information of the workspace name that is associated with the workspace.
        Overrides:
        setWorkspaceName in class com.ibm.commerce.context.content.objects.Workspace
        Parameters:
        workspaceName - The workspace name of the workspace.

      • setWriteSchema

        public void setWriteSchema(java.lang.String writeSchema)
        This method sets the configuration information of the write schema that is associated with the workspace.
        Overrides:
        setWriteSchema in class com.ibm.commerce.context.content.objects.Workspace
        Parameters:
        writeSchema - The write schema of the workspace.

      • isBaseOperation

        public boolean isBaseOperation()
        This method returns whether the operation is a result of a change in the base. This is based on the synchronization required field.
        Returns:
        This method returns true if the operation is a result of a change in the base and false otherwise.

      • isWorkspaceOperation

        public boolean isWorkspaceOperation()
        This method returns whether the operation is a result of a change in the workspace. This is based on the synchronization required field.
        Returns:
        This method returns true if the operation is a result of a change in the workspace and false otherwise.
Skip navigation links