kd.bos.form

## 类 FormShowParameter

- java.lang.Object
- - kd.bos.form.FormShowParameter

- 所有已实现的接口:
    java.io.Serializable
  直接已知子类:
    BillShowParameter, FilterShowParameter, ListShowParameter, MobileFormShowParameter, ParameterShowParameter, ReportFilterShowParameter, ReportShowParameter

      @KSObject
      public class FormShowParameter
      extends java.lang.Object
      implements java.io.Serializable

  请求加载表单维护界面时，需要设置的参数； 利用对象化参数的形式，提示使用者应该设置那些内容；
  另请参阅:
    序列化表格

- - ### 构造器概要

    构造器
    构造器和说明
    `FormShowParameter()` 构造函数

  - ### 方法概要

    所有方法 静态方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `void` | `addCustPlugin(java.lang.String pluginClassName)` 显示界面前，向界面动态添加插件
    `void` | `beginInit()`
    `java.util.Map<java.lang.String,java.lang.Object>` | `createClientConfig(java.util.Map<java.lang.String,java.lang.Object> settting)`
    `static FormShowParameter` | `createFormShowParameter(java.util.Map<java.lang.String,java.lang.Object> openParameter)`
    `java.util.List<IFormPlugin>` | `createPlugin()`
    `QingCachedFormParameter` | `createQingCachedFormParameter()` 创建轻分析参数
    `IFormView` | `createView()`
    `IFormView` | `createViewForWebApi()`
    `void` | `endInit()`
    `static FormShowParameter` | `fromJsonString(java.lang.String str)`
    `AnimationType` | `getAnimationType()`
    `java.lang.String` | `getAppId()` 打开这个表单在那个应用打开，用于页面挂在哪个应用主页上
    `long` | `getCacheExpireTime()` 获取字段cacheExpireTime的值
    `java.lang.String` | `getCaption()` 取发布到主控台那边的信息作为标题； 比如：同一个实体发票，发布到主控台后，有可能扮演普通发票与增值税发票的角色；
    `CloseCallBack` | `getCloseCallBack()`
    `<T> T` | `getCustomParam(java.lang.String name)`
    `java.util.Map<java.lang.String,java.lang.Object>` | `getCustomParams()` 其他非标准参数，可以任意添加
    `FormConfig` | `getFormConfig()` 注意：formConfig.getAppId()的appid指这个表单设计态属于那个应用，用于微服务节点路由
    `java.lang.String` | `getFormId()` 动态表单内码，必选参数
    `java.lang.String` | `getFormName()`
    `OpenStyle` | `getOpenStyle()` 打开风格
    `java.lang.String` | `getPageId()` 页面PageId, 可选参数
    `java.lang.String` | `getParentFormId()`
    `java.lang.String` | `getParentPageId()` 父页面PageId，据此检索、通知父页面；可选参数
    `java.lang.String` | `getPermissionItemId()` 动态表单打开，检查查看权限 "47150e89000000ac" view权限项
    `java.lang.String` | `getRootPageId()`
    `java.lang.String` | `getServiceAppId()`
    `java.lang.String` | `getSettingKey()`
    `FormShowParameter` | `getShowParameter()`
    `OperationStatus` | `getStatus()`
    `int` | `getStatusValue()`
    `java.lang.String` | `getSubSystemId()` 子系统id
    `boolean` | `isDebugModel()`
    `boolean` | `isHasRight()` 需要打开的单据是否已经验权
    `boolean` | `isInitialized()`
    `boolean` | `isListentimerElapsed()`
    `boolean` | `isMeetExpireThreshold()`
    `boolean` | `isShowTitle()`
    `void` | `setAnimationType(AnimationType animationType)`
    `void` | `setAppId(java.lang.String appId)`
    `void` | `setCacheExpireTime(long cacheExpireTime)` 将参数cacheExpireTime的值赋给字段cacheExpireTime
    `void` | `setCaption(java.lang.String value)`
    `void` | `setClientParam(java.lang.String name, java.lang.Object value)` 设计客户端参数，可以传递到自定义控件
    `void` | `setCloseCallBack(CloseCallBack closeCallBack)`
    `void` | `setCustomParam(java.lang.String name, java.lang.Object value)`
    `void` | `setCustomParams(java.util.Map<java.lang.String,java.lang.Object> value)`
    `void` | `setDebugModel(boolean debugModel)`
    `void` | `setFormConfig(FormConfig config)`
    `void` | `setFormId(java.lang.String value)`
    `void` | `setHasRight(boolean hasRight)` 设置单开的单据是否已经验权
    `void` | `setListentimerElapsed(boolean isListentimerElapsed)`
    `void` | `setOpenStyle(OpenStyle value)`
    `void` | `setPageId(java.lang.String value)`
    `void` | `setParentFormId(java.lang.String parentFormId)`
    `void` | `setParentPageId(java.lang.String value)`
    `void` | `setPermissionItemId(java.lang.String permissionItemId)`
    `void` | `setRootPageId(java.lang.String rootPageId)`
    `void` | `setShowTitle(boolean isShowTitle)`
    `void` | `setStatus(OperationStatus value)`
    `void` | `setStatusValue(int statusValue)`
    `void` | `setSubSystemId(java.lang.String value)`
    `static java.lang.String` | `toJsonString(FormShowParameter type)`
    `java.lang.String` | `toString()`

    - ### 从类继承的方法 java.lang.Object

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

- - ### 构造器详细资料

    - #### FormShowParameter

          public FormShowParameter()

      构造函数

  - ### 方法详细资料

    - #### toString

          public java.lang.String toString()

      覆盖:
        `toString` 在类中 `java.lang.Object`

    - #### toJsonString

          public static java.lang.String toJsonString(FormShowParameter type)

    - #### fromJsonString

          public static FormShowParameter fromJsonString(java.lang.String str)

    - #### addCustPlugin

          public void addCustPlugin(java.lang.String pluginClassName)

      显示界面前，向界面动态添加插件
      参数:
        `pluginClassName` -

    - #### createPlugin

          public java.util.List<IFormPlugin> createPlugin()

    - #### createFormShowParameter

          public static FormShowParameter createFormShowParameter(java.util.Map<java.lang.String,java.lang.Object> openParameter)

    - #### getFormId

          @KSMethod
          public java.lang.String getFormId()

      动态表单内码，必选参数

    - #### setFormId

          @KSMethod
          public void setFormId(java.lang.String value)

    - #### getParentFormId

          @KSMethod
          public java.lang.String getParentFormId()

    - #### setParentFormId

          @KSMethod
          public void setParentFormId(java.lang.String parentFormId)

    - #### getParentPageId

          @KSMethod
          public final java.lang.String getParentPageId()

      父页面PageId，据此检索、通知父页面；可选参数

    - #### setParentPageId

          @KSMethod
          public final void setParentPageId(java.lang.String value)

    - #### getAppId

          @KSMethod
          public java.lang.String getAppId()

      打开这个表单在那个应用打开，用于页面挂在哪个应用主页上
      返回:

    - #### setAppId

          public void setAppId(java.lang.String appId)

    - #### getServiceAppId

          public java.lang.String getServiceAppId()

    - #### getPageId

          @KSMethod
          public final java.lang.String getPageId()

      页面PageId, 可选参数

    - #### setPageId

          @KSMethod
          public final void setPageId(java.lang.String value)

    - #### getCustomParams

          @KSMethod
          public final java.util.Map<java.lang.String,java.lang.Object> getCustomParams()

      其他非标准参数，可以任意添加

    - #### setCustomParams

          @KSMethod
          public void setCustomParams(java.util.Map<java.lang.String,java.lang.Object> value)

    - #### getCaption

          @KSMethod
          public final java.lang.String getCaption()

      取发布到主控台那边的信息作为标题； 比如：同一个实体发票，发布到主控台后，有可能扮演普通发票与增值税发票的角色；

    - #### setCaption

          @KSMethod
          public final void setCaption(java.lang.String value)

    - #### getFormName

          @KSMethod
          public java.lang.String getFormName()

    - #### getSubSystemId

          public final java.lang.String getSubSystemId()

      子系统id

    - #### setSubSystemId

          public final void setSubSystemId(java.lang.String value)

    - #### getOpenStyle

          @KSMethod
          public OpenStyle getOpenStyle()

      打开风格

    - #### setOpenStyle

          public void setOpenStyle(OpenStyle value)

    - #### getFormConfig

          @KSMethod
          public FormConfig getFormConfig()

      注意：formConfig.getAppId()的appid指这个表单设计态属于那个应用，用于微服务节点路由
      返回:

    - #### getShowParameter

          public FormShowParameter getShowParameter()

    - #### setFormConfig

          public void setFormConfig(FormConfig config)

    - #### isShowTitle

          @KSMethod
          public boolean isShowTitle()

    - #### setShowTitle

          @KSMethod
          public void setShowTitle(boolean isShowTitle)

    - #### createClientConfig

          public java.util.Map<java.lang.String,java.lang.Object> createClientConfig(java.util.Map<java.lang.String,java.lang.Object> settting)

    - #### createView

          public IFormView createView()

    - #### createViewForWebApi

          public IFormView createViewForWebApi()

    - #### getCloseCallBack

          @KSMethod
          public CloseCallBack getCloseCallBack()

    - #### setCloseCallBack

          @KSMethod
          public void setCloseCallBack(CloseCallBack closeCallBack)

    - #### getCustomParam

          @KSMethod
          public <T> T getCustomParam(java.lang.String name)

    - #### setCustomParam

          @KSMethod
          public void setCustomParam(java.lang.String name,
                                                java.lang.Object value)

    - #### setClientParam

          @KSMethod
          public void setClientParam(java.lang.String name,
                                                java.lang.Object value)

      设计客户端参数，可以传递到自定义控件
      参数:
        `name` -
        `value` -

    - #### getRootPageId

          @KSMethod
          public java.lang.String getRootPageId()

    - #### setRootPageId

          public void setRootPageId(java.lang.String rootPageId)

    - #### getStatus

          @KSMethod
          public OperationStatus getStatus()

    - #### setStatus

          @KSMethod
          public void setStatus(OperationStatus value)

    - #### getStatusValue

          public int getStatusValue()

    - #### setStatusValue

          public void setStatusValue(int statusValue)

    - #### getSettingKey

          public java.lang.String getSettingKey()

    - #### beginInit

          public void beginInit()

    - #### endInit

          public void endInit()

    - #### isInitialized

          public boolean isInitialized()

    - #### isListentimerElapsed

          public boolean isListentimerElapsed()

    - #### setListentimerElapsed

          public void setListentimerElapsed(boolean isListentimerElapsed)

    - #### isDebugModel

          public boolean isDebugModel()

    - #### setDebugModel

          public void setDebugModel(boolean debugModel)

    - #### getAnimationType

          public AnimationType getAnimationType()

    - #### setAnimationType

          public void setAnimationType(AnimationType animationType)

    - #### isHasRight

          public boolean isHasRight()

      需要打开的单据是否已经验权
      返回:

    - #### setHasRight

          public void setHasRight(boolean hasRight)

      设置单开的单据是否已经验权
      参数:
        `passPerm` -

    - #### getPermissionItemId

          public java.lang.String getPermissionItemId()

      动态表单打开，检查查看权限 "47150e89000000ac" view权限项
      返回:

    - #### setPermissionItemId

          public void setPermissionItemId(java.lang.String permissionItemId)

    - #### getCacheExpireTime

          public long getCacheExpireTime()

      获取字段cacheExpireTime的值
      返回:
        cacheExpireTime的值

    - #### setCacheExpireTime

          public void setCacheExpireTime(long cacheExpireTime)

      将参数cacheExpireTime的值赋给字段cacheExpireTime
      参数:
        `参数cacheExpireTime` -

    - #### isMeetExpireThreshold

          public boolean isMeetExpireThreshold()

    - #### createQingCachedFormParameter

          public QingCachedFormParameter createQingCachedFormParameter()

      创建轻分析参数
      返回:
        轻分析参数