Class YFormDefinitionModel

  • All Implemented Interfaces:
    java.io.Serializable

    public class YFormDefinitionModel
    extends ItemModel
    Generated model class for type YFormDefinition first defined at extension xyformsservices.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String _CATEGORY2YFORMDEFINITIONRELATION
      Generated relation code constant for relation Category2YFormDefinitionRelation defining source attribute categories in extension xyformsservices.
      static java.lang.String _TYPECODE
      Generated model type code constant.
      static java.lang.String APPLICATIONID
      Generated constant - Attribute key of YFormDefinition.applicationId attribute defined at extension xyformsservices.
      static java.lang.String CATEGORIES
      Generated constant - Attribute key of YFormDefinition.categories attribute defined at extension xyformsservices.
      static java.lang.String CONTENT
      Generated constant - Attribute key of YFormDefinition.content attribute defined at extension xyformsservices.
      static java.lang.String DATA
      Generated constant - Attribute key of YFormDefinition.data attribute defined at extension xyformsservices.
      static java.lang.String DESCRIPTION
      Generated constant - Attribute key of YFormDefinition.description attribute defined at extension xyformsservices.
      static java.lang.String DOCUMENTID
      Generated constant - Attribute key of YFormDefinition.documentId attribute defined at extension xyformsservices.
      static java.lang.String FORMID
      Generated constant - Attribute key of YFormDefinition.formId attribute defined at extension xyformsservices.
      static java.lang.String LATEST
      Generated constant - Attribute key of YFormDefinition.latest attribute defined at extension xyformsservices.
      static java.lang.String STATUS
      Generated constant - Attribute key of YFormDefinition.status attribute defined at extension xyformsservices.
      static java.lang.String SYSTEM
      Generated constant - Attribute key of YFormDefinition.system attribute defined at extension xyformsservices.
      static java.lang.String TITLE
      Generated constant - Attribute key of YFormDefinition.title attribute defined at extension xyformsservices.
      static java.lang.String VERSION
      Generated constant - Attribute key of YFormDefinition.version attribute defined at extension xyformsservices.
    • Constructor Summary

      Constructors 
      Constructor Description
      YFormDefinitionModel()
      Generated constructor - Default constructor for generic creation.
      YFormDefinitionModel​(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      YFormDefinitionModel​(java.lang.String _applicationId, java.lang.String _formId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      YFormDefinitionModel​(java.lang.String _applicationId, java.lang.String _formId, ItemModel _owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getApplicationId()
      Generated method - Getter of the YFormDefinition.applicationId attribute defined at extension xyformsservices.
      java.util.Collection<CategoryModel> getCategories()
      Generated method - Getter of the YFormDefinition.categories attribute defined at extension xyformsservices.
      java.lang.String getContent()
      Generated method - Getter of the YFormDefinition.content attribute defined at extension xyformsservices.
      java.util.Collection<YFormDataModel> getData()
      Generated method - Getter of the YFormDefinition.data attribute defined at extension xyformsservices.
      java.lang.String getDescription()
      Generated method - Getter of the YFormDefinition.description attribute defined at extension xyformsservices.
      java.lang.String getDocumentId()
      Generated method - Getter of the YFormDefinition.documentId attribute defined at extension xyformsservices.
      java.lang.String getFormId()
      Generated method - Getter of the YFormDefinition.formId attribute defined at extension xyformsservices.
      java.lang.Boolean getLatest()
      Generated method - Getter of the YFormDefinition.latest attribute defined at extension xyformsservices.
      YFormDefinitionStatusEnum getStatus()
      Generated method - Getter of the YFormDefinition.status attribute defined at extension xyformsservices.
      java.lang.Boolean getSystem()
      Generated method - Getter of the YFormDefinition.system attribute defined at extension xyformsservices.
      java.lang.String getTitle()
      Generated method - Getter of the YFormDefinition.title attribute defined at extension xyformsservices.
      int getVersion()
      Generated method - Getter of the YFormDefinition.version attribute defined at extension xyformsservices.
      void setApplicationId​(java.lang.String value)
      Generated method - Setter of YFormDefinition.applicationId attribute defined at extension xyformsservices.
      void setCategories​(java.util.Collection<CategoryModel> value)
      Generated method - Setter of YFormDefinition.categories attribute defined at extension xyformsservices.
      void setContent​(java.lang.String value)
      Generated method - Setter of YFormDefinition.content attribute defined at extension xyformsservices.
      void setData​(java.util.Collection<YFormDataModel> value)
      Generated method - Setter of YFormDefinition.data attribute defined at extension xyformsservices.
      void setDescription​(java.lang.String value)
      Generated method - Setter of YFormDefinition.description attribute defined at extension xyformsservices.
      void setDocumentId​(java.lang.String value)
      Generated method - Setter of YFormDefinition.documentId attribute defined at extension xyformsservices.
      void setFormId​(java.lang.String value)
      Generated method - Setter of YFormDefinition.formId attribute defined at extension xyformsservices.
      void setLatest​(java.lang.Boolean value)
      Generated method - Setter of YFormDefinition.latest attribute defined at extension xyformsservices.
      void setStatus​(YFormDefinitionStatusEnum value)
      Generated method - Setter of YFormDefinition.status attribute defined at extension xyformsservices.
      void setSystem​(java.lang.Boolean value)
      Generated method - Setter of YFormDefinition.system attribute defined at extension xyformsservices.
      void setTitle​(java.lang.String value)
      Generated method - Setter of YFormDefinition.title attribute defined at extension xyformsservices.
      void setVersion​(int value)
      Generated method - Setter of YFormDefinition.version attribute defined at extension xyformsservices.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • _TYPECODE

        public static final java.lang.String _TYPECODE
        Generated model type code constant.
        See Also:
        Constant Field Values
      • _CATEGORY2YFORMDEFINITIONRELATION

        public static final java.lang.String _CATEGORY2YFORMDEFINITIONRELATION
        Generated relation code constant for relation Category2YFormDefinitionRelation defining source attribute categories in extension xyformsservices.
        See Also:
        Constant Field Values
      • APPLICATIONID

        public static final java.lang.String APPLICATIONID
        Generated constant - Attribute key of YFormDefinition.applicationId attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • FORMID

        public static final java.lang.String FORMID
        Generated constant - Attribute key of YFormDefinition.formId attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • VERSION

        public static final java.lang.String VERSION
        Generated constant - Attribute key of YFormDefinition.version attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • TITLE

        public static final java.lang.String TITLE
        Generated constant - Attribute key of YFormDefinition.title attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • DESCRIPTION

        public static final java.lang.String DESCRIPTION
        Generated constant - Attribute key of YFormDefinition.description attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • DOCUMENTID

        public static final java.lang.String DOCUMENTID
        Generated constant - Attribute key of YFormDefinition.documentId attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • SYSTEM

        public static final java.lang.String SYSTEM
        Generated constant - Attribute key of YFormDefinition.system attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • LATEST

        public static final java.lang.String LATEST
        Generated constant - Attribute key of YFormDefinition.latest attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • STATUS

        public static final java.lang.String STATUS
        Generated constant - Attribute key of YFormDefinition.status attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • CONTENT

        public static final java.lang.String CONTENT
        Generated constant - Attribute key of YFormDefinition.content attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • DATA

        public static final java.lang.String DATA
        Generated constant - Attribute key of YFormDefinition.data attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
      • CATEGORIES

        public static final java.lang.String CATEGORIES
        Generated constant - Attribute key of YFormDefinition.categories attribute defined at extension xyformsservices.
        See Also:
        Constant Field Values
    • Constructor Detail

      • YFormDefinitionModel

        public YFormDefinitionModel()
        Generated constructor - Default constructor for generic creation.
      • YFormDefinitionModel

        public YFormDefinitionModel​(ItemModelContext ctx)
        Generated constructor - Default constructor for creation with existing context
        Parameters:
        ctx - the model context to be injected, must not be null
      • YFormDefinitionModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public YFormDefinitionModel​(java.lang.String _applicationId,
                                    java.lang.String _formId)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - Constructor with all mandatory attributes.
        Parameters:
        _applicationId - initial attribute declared by type YFormDefinition at extension xyformsservices
        _formId - initial attribute declared by type YFormDefinition at extension xyformsservices
      • YFormDefinitionModel

        @Deprecated(since="4.1.1",
                    forRemoval=true)
        public YFormDefinitionModel​(java.lang.String _applicationId,
                                    java.lang.String _formId,
                                    ItemModel _owner)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 4.1.1 Please use the default constructor without parameters
        Generated constructor - for all mandatory and initial attributes.
        Parameters:
        _applicationId - initial attribute declared by type YFormDefinition at extension xyformsservices
        _formId - initial attribute declared by type YFormDefinition at extension xyformsservices
        _owner - initial attribute declared by type Item at extension core
    • Method Detail

      • getApplicationId

        @Accessor(qualifier="applicationId",
                  type=GETTER)
        public java.lang.String getApplicationId()
        Generated method - Getter of the YFormDefinition.applicationId attribute defined at extension xyformsservices.
        Returns:
        the applicationId
      • getCategories

        @Accessor(qualifier="categories",
                  type=GETTER)
        public java.util.Collection<CategoryModel> getCategories()
        Generated method - Getter of the YFormDefinition.categories attribute defined at extension xyformsservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the categories - Categories
      • getContent

        @Accessor(qualifier="content",
                  type=GETTER)
        public java.lang.String getContent()
        Generated method - Getter of the YFormDefinition.content attribute defined at extension xyformsservices.
        Returns:
        the content
      • getData

        @Accessor(qualifier="data",
                  type=GETTER)
        public java.util.Collection<YFormDataModel> getData()
        Generated method - Getter of the YFormDefinition.data attribute defined at extension xyformsservices. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
        Returns:
        the data
      • getDescription

        @Accessor(qualifier="description",
                  type=GETTER)
        public java.lang.String getDescription()
        Generated method - Getter of the YFormDefinition.description attribute defined at extension xyformsservices.
        Returns:
        the description
      • getDocumentId

        @Accessor(qualifier="documentId",
                  type=GETTER)
        public java.lang.String getDocumentId()
        Generated method - Getter of the YFormDefinition.documentId attribute defined at extension xyformsservices.
        Returns:
        the documentId
      • getFormId

        @Accessor(qualifier="formId",
                  type=GETTER)
        public java.lang.String getFormId()
        Generated method - Getter of the YFormDefinition.formId attribute defined at extension xyformsservices.
        Returns:
        the formId
      • getLatest

        @Accessor(qualifier="latest",
                  type=GETTER)
        public java.lang.Boolean getLatest()
        Generated method - Getter of the YFormDefinition.latest attribute defined at extension xyformsservices.
        Returns:
        the latest
      • getSystem

        @Accessor(qualifier="system",
                  type=GETTER)
        public java.lang.Boolean getSystem()
        Generated method - Getter of the YFormDefinition.system attribute defined at extension xyformsservices.
        Returns:
        the system
      • getTitle

        @Accessor(qualifier="title",
                  type=GETTER)
        public java.lang.String getTitle()
        Generated method - Getter of the YFormDefinition.title attribute defined at extension xyformsservices.
        Returns:
        the title
      • getVersion

        @Accessor(qualifier="version",
                  type=GETTER)
        public int getVersion()
        Generated method - Getter of the YFormDefinition.version attribute defined at extension xyformsservices.
        Returns:
        the version
      • setApplicationId

        @Accessor(qualifier="applicationId",
                  type=SETTER)
        public void setApplicationId​(java.lang.String value)
        Generated method - Setter of YFormDefinition.applicationId attribute defined at extension xyformsservices.
        Parameters:
        value - the applicationId
      • setCategories

        @Accessor(qualifier="categories",
                  type=SETTER)
        public void setCategories​(java.util.Collection<CategoryModel> value)
        Generated method - Setter of YFormDefinition.categories attribute defined at extension xyformsservices.
        Parameters:
        value - the categories - Categories
      • setContent

        @Accessor(qualifier="content",
                  type=SETTER)
        public void setContent​(java.lang.String value)
        Generated method - Setter of YFormDefinition.content attribute defined at extension xyformsservices.
        Parameters:
        value - the content
      • setData

        @Accessor(qualifier="data",
                  type=SETTER)
        public void setData​(java.util.Collection<YFormDataModel> value)
        Generated method - Setter of YFormDefinition.data attribute defined at extension xyformsservices.
        Parameters:
        value - the data
      • setDescription

        @Accessor(qualifier="description",
                  type=SETTER)
        public void setDescription​(java.lang.String value)
        Generated method - Setter of YFormDefinition.description attribute defined at extension xyformsservices.
        Parameters:
        value - the description
      • setDocumentId

        @Accessor(qualifier="documentId",
                  type=SETTER)
        public void setDocumentId​(java.lang.String value)
        Generated method - Setter of YFormDefinition.documentId attribute defined at extension xyformsservices.
        Parameters:
        value - the documentId
      • setFormId

        @Accessor(qualifier="formId",
                  type=SETTER)
        public void setFormId​(java.lang.String value)
        Generated method - Setter of YFormDefinition.formId attribute defined at extension xyformsservices.
        Parameters:
        value - the formId
      • setLatest

        @Accessor(qualifier="latest",
                  type=SETTER)
        public void setLatest​(java.lang.Boolean value)
        Generated method - Setter of YFormDefinition.latest attribute defined at extension xyformsservices.
        Parameters:
        value - the latest
      • setSystem

        @Accessor(qualifier="system",
                  type=SETTER)
        public void setSystem​(java.lang.Boolean value)
        Generated method - Setter of YFormDefinition.system attribute defined at extension xyformsservices.
        Parameters:
        value - the system
      • setTitle

        @Accessor(qualifier="title",
                  type=SETTER)
        public void setTitle​(java.lang.String value)
        Generated method - Setter of YFormDefinition.title attribute defined at extension xyformsservices.
        Parameters:
        value - the title
      • setVersion

        @Accessor(qualifier="version",
                  type=SETTER)
        public void setVersion​(int value)
        Generated method - Setter of YFormDefinition.version attribute defined at extension xyformsservices.
        Parameters:
        value - the version