Package com.fluig.sdk.api.document

Class DocumentVO

    • Field Detail

      • EXTATTR_additionalComments

        protected static final String EXTATTR_additionalComments
        Chave para informar se documento possui comentário adicional extra
        See Also:
        Constant Field Values

      • EXTATTR_versionOption

        protected static final String EXTATTR_versionOption
        Chave para informar se documento possui versão opcional extra
        See Also:
        Constant Field Values

      • EXTATTR_iconPath

        protected static final String EXTATTR_iconPath
        Chave para informar se documento possui caminho de icone extra
        See Also:
        Constant Field Values

      • EXTATTR_colleagueName

        protected static final String EXTATTR_colleagueName
        Chave para informar se documento possui nome de colega extra
        See Also:
        Constant Field Values

      • EXTATTR_rowId

        protected static final String EXTATTR_rowId
        Chave para informar se documento possui row id extra
        See Also:
        Constant Field Values

      • EXTATTR_publisherName

        protected static final String EXTATTR_publisherName
        Chave para informar se documento possui nome de publicador extra
        See Also:
        Constant Field Values

      • EXTATTR_metaListId

        protected static final String EXTATTR_metaListId
        Chave para informar se documento possui meta lista id extra
        See Also:
        Constant Field Values

      • EXTATTR_metaListRecordId

        protected static final String EXTATTR_metaListRecordId
        Chave para informar se documento possui registro extra de meta list
        See Also:
        Constant Field Values

    • Constructor Detail

      • DocumentVO

        public DocumentVO()
        Nova instância de documento

      • DocumentVO

        public DocumentVO​(Long tenantId,
                  Integer documentId,
                  Integer version)
        Nova instância de documento utilizando a versão, id do tenant e id do documento
        Parameters:
        tenantId -
        documentId -
        version -

    • Method Detail

      • getExtData

        protected HashMap<String,​Object> getExtData()
        Recupera os dados extras
        Returns:
        HashMap

      • setExtraData

        public void setExtraData​(String key,
                         Object value)
        Atribui valores para os dados extras
        Parameters:
        key -
        value -

      • getExtraData

        public Object getExtraData​(String key)
        Recupera os dados extras
        Parameters:
        key -
        Returns:
        Object

      • getTenantId

        public Long getTenantId()
        Recupera id do tenant
        Returns:
        Long

      • setTenantId

        public void setTenantId​(Long tenantId)
        Atribui valor para id do tenant
        Parameters:
        tenantId -

      • getDocumentId

        public Integer getDocumentId()
        Recupera valor do document Id
        Returns:
        Integer

      • setDocumentId

        public void setDocumentId​(Integer documentId)
        Atribui valor para id do documento
        Parameters:
        documentId -

      • getVersion

        public Integer getVersion()
        Recupera valor da versão
        Returns:
        Integer

      • setVersion

        public void setVersion​(Integer version)
        Atribui valor para versão
        Parameters:
        version -

      • getDocumentTypeId

        public String getDocumentTypeId()
        Recupera valor do id do tipo de documento
        Returns:
        String

      • setDocumentTypeId

        public void setDocumentTypeId​(String documentTypeId)
        Atribui valor para id do tipo de documento
        Parameters:
        documentTypeId -

      • getLanguageId

        public String getLanguageId()
        Recupera id da linguagem
        Returns:
        String

      • setLanguageId

        public void setLanguageId​(String languageId)
        Atribui valor para id da linguagem
        Parameters:
        languageId -

      • getIconId

        public Integer getIconId()
        Recupera id do icone
        Returns:
        Integer

      • setIconId

        public void setIconId​(Integer iconId)
        Atribui valor para id do icone
        Parameters:
        iconId -

      • getTopicId

        public Integer getTopicId()
        Recupera valor do id do topico
        Returns:
        Integer

      • setTopicId

        public void setTopicId​(Integer topicId)
        Atribui valor para id do topico
        Parameters:
        topicId -

      • getColleagueId

        public String getColleagueId()
        Recupera id do colega
        Returns:
        String

      • setColleagueId

        public void setColleagueId​(String colleagueId)
        Atribui valor para id do colega
        Parameters:
        colleagueId -

      • getDocumentDescription

        public String getDocumentDescription()
        Recupera descrição do documento
        Returns:
        String

      • setDocumentDescription

        public void setDocumentDescription​(String documentDescription)
        Atribui valor para descrição do documento
        Parameters:
        documentDescription -

      • getPhisicalFile

        public String getPhisicalFile()
        Recupera arquivo fisico
        Returns:
        String

      • setPhisicalFile

        public void setPhisicalFile​(String phisicalFile)
        Atribui valor para arquivo fisico
        Parameters:
        phisicalFile -

      • getKeyWord

        public String getKeyWord()
        Recupera valor de palavra chave
        Returns:
        String

      • setKeyWord

        public void setKeyWord​(String keyWord)
        Atribui valor para palavra chave
        Parameters:
        keyWord -

      • getCreateDate

        public Date getCreateDate()
        Recupera valor para data de criação
        Returns:
        Date

      • setCreateDate

        public void setCreateDate​(Date createDate)
        Atribui valor para data de criação
        Parameters:
        createDate -

      • getApprovedDate

        public Date getApprovedDate()
        Recupera valor da data de aprovação
        Returns:
        Date

      • setApprovedDate

        public void setApprovedDate​(Date approvedDate)
        Atribui valor para data de aprovação
        Parameters:
        approvedDate -

      • getLastModifiedDate

        public Date getLastModifiedDate()
        Recupera valor da última data de moficação
        Returns:
        Date

      • setLastModifiedDate

        public void setLastModifiedDate​(Date lastModifiedDate)
        Atribui valor para última data de modificação
        Parameters:
        lastModifiedDate -

      • getDocumentType

        public String getDocumentType()
        Recupera valor do tipo de documento
        Returns:
        String

      • setDocumentType

        public void setDocumentType​(String documentType)
        Atribui valor para tipo de documento
        Parameters:
        documentType -

      • getExpirationDate

        public Date getExpirationDate()
        Recupera data de expiração
        Returns:
        Date

      • setExpirationDate

        public void setExpirationDate​(Date expirationDate)
        Atribui valor para data de expiração
        Parameters:
        expirationDate -

      • getAccessCount

        public Integer getAccessCount()
        Recupera número de acessso
        Returns:
        Integer

      • setAccessCount

        public void setAccessCount​(Integer accessCount)
        Atribui valor para número de acessos
        Parameters:
        accessCount -

      • getAtualizationId

        public Integer getAtualizationId()
        Recupera id de atualização
        Returns:
        Integer

      • setAtualizationId

        public void setAtualizationId​(Integer atualizationId)
        Atribui valor para id de atualização
        Parameters:
        atualizationId -

      • getParentDocumentId

        public Integer getParentDocumentId()
        Recupera id do pai do documento
        Returns:
        Integer

      • setParentDocumentId

        public void setParentDocumentId​(Integer parentDocumentId)
        Atribui valor para id do documento pai
        Parameters:
        parentDocumentId -

      • getVisualization

        public String getVisualization()
        Recupera visualização
        Returns:
        String

      • setVisualization

        public void setVisualization​(String visualization)
        Atribui valor para visualização
        Parameters:
        visualization -

      • getRelatedFiles

        public String getRelatedFiles()
        Recuprea arquivos relacionados
        Returns:
        String

      • setRelatedFiles

        public void setRelatedFiles​(String relatedFiles)
        Atribui valor para arquivos relacionados
        Parameters:
        relatedFiles -

      • getActiveVersion

        public Boolean getActiveVersion()
        Recupera versão ativa
        Returns:
        Boolean

      • setActiveVersion

        public void setActiveVersion​(Boolean activeVersion)
        Atribui valor para versão ativa
        Parameters:
        activeVersion -

      • getVersionDescription

        public String getVersionDescription()
        Recupera descrição da versão
        Returns:
        String

      • setVersionDescription

        public void setVersionDescription​(String versionDescription)
        Atribui valor para descrição da versão
        Parameters:
        versionDescription -

      • getApprovalAndOr

        public Boolean getApprovalAndOr()
        Recupera condição aprovalAndOr
        Returns:
        Boolean

      • setApprovalAndOr

        public void setApprovalAndOr​(Boolean approvalAndOr)
        Atribui valor para approvalAndOr
        Parameters:
        approvalAndOr -

      • getExternalDocumentId

        public String getExternalDocumentId()
        Recupera id documento externo
        Returns:
        String

      • setExternalDocumentId

        public void setExternalDocumentId​(String externalDocumentId)
        Atribui valor para id documento externo
        Parameters:
        externalDocumentId -

      • getDownloadEnabled

        public Boolean getDownloadEnabled()
        Recupera valor, se download é habilitado
        Returns:
        Boolean

      • setDownloadEnabled

        public void setDownloadEnabled​(Boolean downloadEnabled)
        Atribui valor, se download é habilitado
        Parameters:
        downloadEnabled -

      • getApproved

        public Boolean getApproved()
        Recupera valor, se documento está aprovado
        Returns:
        Boolean

      • setApproved

        public void setApproved​(Boolean approved)
        Atribui valor, se documento está aprovado
        Parameters:
        approved -

      • getValidationStartDate

        public Date getValidationStartDate()
        Recupera data de inicio de validação
        Returns:
        Date

      • setValidationStartDate

        public void setValidationStartDate​(Date validationStartDate)
        Atribui valor para data de início de validação
        Parameters:
        validationStartDate -

      • getPublisherId

        public String getPublisherId()
        Recupera id do publicador
        Returns:
        String

      • setPublisherId

        public void setPublisherId​(String publisherId)
        Atribui valor para id do publicador
        Parameters:
        publisherId -

      • getCardDescription

        public String getCardDescription()
        Recupera descrição do card
        Returns:
        String

      • setCardDescription

        public void setCardDescription​(String cardDescription)
        Atribui valor para descrição do card
        Parameters:
        cardDescription -

      • getAllowMuiltiCardsPerUser

        public Boolean getAllowMuiltiCardsPerUser()
        Recupera valor, se documento permite mult card por usuário
        Returns:
        Boolean

      • setAllowMuiltiCardsPerUser

        public void setAllowMuiltiCardsPerUser​(Boolean allowMuiltiCardsPerUser)
        Atribui valor para allowMuiltiCardsPerUser
        Parameters:
        allowMuiltiCardsPerUser -

      • getDocumentPropertyNumber

        public Integer getDocumentPropertyNumber()
        Recupera número de propriedade do documento
        Returns:
        Integer

      • setDocumentPropertyNumber

        public void setDocumentPropertyNumber​(Integer documentPropertyNumber)
        Atribui valor para número de propriedade do documento
        Parameters:
        documentPropertyNumber -

      • getDocumentPropertyVersion

        public Integer getDocumentPropertyVersion()
        Recupera versão do documento
        Returns:
        Integer

      • setDocumentPropertyVersion

        public void setDocumentPropertyVersion​(Integer documentPropertyVersion)
        Atribui versão de documento
        Parameters:
        documentPropertyVersion -

      • getPrivateDocument

        public Boolean getPrivateDocument()
        Recupera valor, se documento é privado
        Returns:
        is Private

      • setPrivateDocument

        public void setPrivateDocument​(Boolean privateDocument)
        Atribui valor, se documento é privado
        Parameters:
        privateDocument -

      • getPrivateColleagueId

        public String getPrivateColleagueId()
        Recupera valor id privado do colega
        Returns:
        String

      • setPrivateColleagueId

        public void setPrivateColleagueId​(String privateColleagueId)
        Atribui valor id privado do colega
        Parameters:
        privateColleagueId -

      • getIndexed

        public Boolean getIndexed()
        Recupera valor, se documento é indexado
        Returns:
        Boolean

      • setIndexed

        public void setIndexed​(Boolean indexed)
        Atribui valor, se documento é indexado
        Parameters:
        indexed -

      • getPriority

        public Integer getPriority()
        Recupera prioridade
        Returns:
        Integer

      • setPriority

        public void setPriority​(Integer priority)
        Atribui valor prioridade
        Parameters:
        priority -

      • getTranslated

        public Boolean getTranslated()
        Recupera valor, se documento é traduzido
        Returns:
        Boolean

      • setTranslated

        public void setTranslated​(Boolean translated)
        Atribui valor, se documento é traduzido
        Parameters:
        translated -

      • getUserNotify

        public Boolean getUserNotify()
        Recupera valor, se usuário será notificado
        Returns:
        Boolean

      • setUserNotify

        public void setUserNotify​(Boolean userNotify)
        Atribui valor se usuário será notificado
        Parameters:
        userNotify -

      • getExpires

        public Boolean getExpires()
        Recupera valor, se documento expira
        Returns:
        Boolean

      • setExpires

        public void setExpires​(Boolean expires)
        Atribui valor, se documento expira
        Parameters:
        expires -

      • getVolumeId

        public String getVolumeId()
        Recupera id do volume
        Returns:
        String

      • setVolumeId

        public void setVolumeId​(String volumeId)
        Atribui valor ao id do volume
        Parameters:
        volumeId -

      • getUpdateIsoProperties

        public Boolean getUpdateIsoProperties()
        Recupera updateIsoProperties
        Returns:
        Boolean

      • setUpdateIsoProperties

        public void setUpdateIsoProperties​(Boolean updateIsoProperties)
        Atribui valor para updateIsoProperties
        Parameters:
        updateIsoProperties -

      • getLastModifiedTime

        public String getLastModifiedTime()
        Recupera última data de modificação
        Returns:
        String

      • setLastModifiedTime

        public void setLastModifiedTime​(String lastModifiedTime)
        Atribui valor a última data de modificação
        Parameters:
        lastModifiedTime -

      • getDeleted

        public Boolean getDeleted()
        Recupera valor, se documento foi deletado
        Returns:
        Boolean

      • setDeleted

        public void setDeleted​(Boolean deleted)
        Atribui valor, se documento foi deletado
        Parameters:
        deleted -

      • getImutable

        public Boolean getImutable()
        Recupera valor, se documento é imultavel
        Returns:
        Boolean

      • setImutable

        public void setImutable​(Boolean imutable)
        Atribui valor, se documento é imutavel
        Parameters:
        imutable -

      • getInternalVisualizer

        public Boolean getInternalVisualizer()
        Recupera valor, se documento pode ser visualizado internamente.
        Returns:
        Boolean

      • setInternalVisualizer

        public void setInternalVisualizer​(Boolean internalVisualizer)
        Atribui valor, se documento pode ser visualizado internamente
        Parameters:
        internalVisualizer -

      • getWatermarkId

        public Integer getWatermarkId()
        Recupera valor, se documento tem marca d'água
        Returns:
        Integer

      • setWatermarkId

        public void setWatermarkId​(Integer watermarkId)
        Atribui valor, se documento tem marca d'água
        Parameters:
        watermarkId -

      • getCrc

        public Long getCrc()
        Recupera valor do crc
        Returns:
        Long

      • setCrc

        public void setCrc​(Long crc)
        Atribui valor para crc
        Parameters:
        crc -

      • getUUID

        public String getUUID()
        Recupera valor do UUID
        Returns:
        String

      • setUUID

        public void setUUID​(String uUID)
        Atribui valor para UUID
        Parameters:
        uUID -

      • getPhisicalFileSize

        public Float getPhisicalFileSize()
        Recupera valor do tamanho do arquivo fisico
        Returns:
        phisicalFileSize

      • setPhisicalFileSize

        public void setPhisicalFileSize​(Float phisicalFileSize)
        Atribui valor para o tamanho do arquivo fisico
        Parameters:
        phisicalFileSize -

      • getPermissionType

        public Integer getPermissionType()
        Recupera o tipo de permissão
        Returns:
        Integer

      • setPermissionType

        public void setPermissionType​(Integer permissionType)
        Atribui valor para tipo de permissão
        Parameters:
        permissionType -

      • getRestrictionType

        public Integer getRestrictionType()
        Recupera tipo de restrição
        Returns:
        restrictionType

      • setRestrictionType

        public void setRestrictionType​(Integer restrictionType)
        Atribui valor para tipo de restrição
        Parameters:
        restrictionType -

      • getSiteCode

        public String getSiteCode()
        Recupera valor do código do site
        Returns:
        String

      • setSiteCode

        public void setSiteCode​(String siteCode)
        Atribui valor para código de site
        Parameters:
        siteCode -

      • getDraft

        public Boolean getDraft()
        Recupera valor de draft
        Returns:
        Boolean

      • setDraft

        public void setDraft​(Boolean draft)
        Atribui valor para draft
        Parameters:
        draft -

      • getOnCheckout

        public Boolean getOnCheckout()
        Recupera valor, se documento está em checkout
        Returns:
        Boolean

      • setOnCheckout

        public void setOnCheckout​(Boolean onCheckout)
        Atribui valor, se documento está em checkout
        Parameters:
        onCheckout -

      • getIconPath

        public String getIconPath()
        Recupera valor do path do icon
        Returns:
        String

      • setIconPath

        public void setIconPath​(String iconPath)
        Atribui valor do iconPath do arquivo
        Parameters:
        iconPath -

      • getVersionAction

        public String getVersionAction()
        Recupera a ação que serão realizada em relaão a versão documento
        Returns:
        String

      • setVersionAction

        public void setVersionAction​(String versionAction)
        Atribue a ação que serão realizada em relaão a versão documento
        Parameters:
        versionAction -

      • getUploadId

        public String getUploadId()
        Recupera o identificador do upload
        Returns:
        String uploadId

      • setUploadId

        public void setUploadId​(String uploadId)
        Atribue o identificador do uplaod
        Parameters:
        uploadId -

      • getAdditionalComments

        public String getAdditionalComments()
        Recupera o valor do comentário nas informações extras
        Returns:
        String comments

      • setAdditionalComments

        public void setAdditionalComments​(String comments)
        Atribui o valor do comentário nas informações extras
        Parameters:
        comments -

      • getInheritSecurity

        public Boolean getInheritSecurity()
        Retorna se o documento herda as propriedades do parent
        Returns:
        Boolean inheritSecurity

      • setInheritSecurity

        public void setInheritSecurity​(Boolean inheritSecurity)
        Atribui se herda as propriedades de segurança do parent
        Parameters:
        inheritSecurity -