Package com.saperion.ngc.scripthelper.internal

Class FormPopupHelperContext

java.lang.Object
com.saperion.ngc.scripthelper.internal.FormPopupHelperContext
public class FormPopupHelperContext extends Object
Context for FormPopupHelper, holds all information needed for opening the form popup window.
Since:
7.5
Author:
art

  • Constructor Details

    • FormPopupHelperContext

      public FormPopupHelperContext(String formName, FormPopupType formType)
      Creates the context with minimum of needed information.
      Parameters:
      formName - name of the form, which should be opened
      formType - type of the form popup window

  • Method Details

    • getForm

      public String getForm()
      Gets the name of the form, which should be opened.
      Returns:
      name of the form

    • getType

      public FormPopupType getType()
      Gets the type of form popup window.
      Returns:
      type of form popup window

    • isReadOnly

      public boolean isReadOnly()
      Gets the read only parameter value (default is false).
      Returns:
      read only parameter value or default (false)

    • setReadOnly

      public void setReadOnly(boolean readOnly)
      Sets the read only parameter value.
      Parameters:
      readOnly - value for read only parameter

    • getTitle

      public String getTitle()
      Gets the title for the form popup window (default is 'Edit index [FORM_NAME]').
      Returns:
      title or default ('Edit index [FORM_NAME]')

    • setTitle

      public void setTitle(String title)
      Sets the title for the form popup window.
      Parameters:
      title - titel for the form popup window

    • getDDC

      public String getDDC()
      Gets the name of the definition (for new documents).
      Returns:
      name of the definition or null

    • setDDC

      public void setDDC(String ddc)
      Sets the name of the definition.
      Parameters:
      ddc - name of the definition

    • getDocumentId

      public DocumentId getDocumentId()
      Gets the document id (of the document to edit).
      Returns:
      document id

    • setDocumentId

      public void setDocumentId(DocumentId id)
      Sets the document id.
      Parameters:
      id - document id