com.ibm.commerce.context.content

Interface ContentContext

  • All Superinterfaces:
    Context, java.io.Serializable


    public interface ContentContext
    extends Context
    The content context interface that will handle the processing of resources that are content managed.
    • Field Detail

      • COPYRIGHT

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

        static final java.lang.String NAME
        The name of the context.
      • ACTIVITY_DATA_PARAM_WORKSPACENAME

        static final java.lang.String ACTIVITY_DATA_PARAM_WORKSPACENAME
        The activity data parameter that represents the workspace name of the context.
        See Also:
        Constant Field Values
    • Method Detail

      • prepareForWriting

        void prepareForWriting()
                        throws ResourceException
        Prepares the request for writing to setup any environment settings if the data is content managed.
        Throws:
        ResourceException - Any problem when preparing for write.
      • prepareForViewing

        void prepareForViewing()
                        throws ResourceException
        Prepares the request for reading to setup any environment setting if the data is content managed.
        Throws:
        ResourceException - Any problem when preparing for read.
      • restoreOriginalState

        void restoreOriginalState()
                           throws ResourceException
        Restores the environment state back to the original state if prepared for read or write were called.
        Throws:
        ResourceException - Any problem when restoring the original state.
      • setWorkspace

        void setWorkspace(java.lang.String workspace)
                   throws ResourceException
        Sets the workspace of the content context.
        Parameters:
        workspace - The workspace name.
        Throws:
        ResourceException - A problem resolving the workspace to a physical workspace.
      • getWorkspace

        java.lang.String getWorkspace()
        Returns the workspace name.
        Returns:
        The workspace name.
      • getWorkspaceData

        WorkspaceData getWorkspaceData()
        Returns the configuration information associated with the workspace of the content context. If no workspace is associated with the context then null is returned.
        Returns:
        The workspace configuration information associated with the context.