Class PublicationDetail

    • Constructor Detail

      • PublicationDetail

        protected PublicationDetail()
        Default contructor, required for JAXB mapping in importExport.
    • Method Detail

      • getInfoId

        public String getInfoId()
      • setInfoId

        public void setInfoId​(String infoId)
      • setCreationDate

        public void setCreationDate​(Date creationDate)
      • setBeginDate

        public void setBeginDate​(Date beginDate)
      • setEndDate

        public void setEndDate​(Date endDate)
      • setVisibilityPeriod

        public void setVisibilityPeriod​(Period period)
      • setCreatorId

        public void setCreatorId​(String creatorId)
      • setContentPagePath

        public void setContentPagePath​(String content)
      • setStatus

        public void setStatus​(String status)
      • setUpdateDate

        public void setUpdateDate​(Date updateDate)
      • setUpdaterId

        public void setUpdaterId​(String updaterId)
      • setAuthor

        public void setAuthor​(String author)
      • getBeginDate

        public Date getBeginDate()
      • getEndDate

        public Date getEndDate()
      • getImportance

        public int getImportance()
      • getVersion

        public String getVersion()
      • getKeywords

        public String getKeywords()
      • getContentPagePath

        public String getContentPagePath()
      • getStatus

        public String getStatus()
      • getImage

        public String getImage()
      • getImageMimeType

        public String getImageMimeType()
      • getUpdaterId

        public String getUpdaterId()
      • getAuthor

        public String getAuthor()
      • getValidateDate

        public Date getValidateDate()
      • getValidatorId

        public String getValidatorId()
      • setValidateDate

        public void setValidateDate​(Date validateDate)
      • setValidatorId

        public void setValidatorId​(String validatorId)
      • setBeginHour

        public void setBeginHour​(String hour)
      • getBeginHour

        public String getBeginHour()
      • setEndHour

        public void setEndHour​(String hour)
      • getEndHour

        public String getEndHour()
      • setSilverObjectId

        public void setSilverObjectId​(String silverObjectId)
      • setSilverObjectId

        public void setSilverObjectId​(int silverObjectId)
      • getSilverObjectId

        public String getSilverObjectId()
      • getId

        public String getId()
        Description copied from interface: SilverpeasContent
        Gets the identifier of this content in the Silverpeas component providing it. This identifier is only unique among all the contents managed by the same component (whatever its different instances). As each type of contents in Silverpeas is provided by a single Silverpeas component, the identifier of a content is then specific to the component it belongs to. It is a way for an instance of a such component to identify uniquely the different contents it manages. So, each component can have their own policy to identify their content, whatever the way they are identified in Silverpeas.
        Specified by:
        getId in interface Identifiable
        Specified by:
        getId in interface SilverpeasContent
        Returns:
        the identifier of this content.
      • getTitle

        public String getTitle()
        Description copied from interface: Contribution
        Gets the title of this contribution if any. By default returns an empty String.
        Specified by:
        getTitle in interface Contribution
        Returns:
        the contribution's title in the specified language. Can be empty if no title was set or no title is defined for a such contribution.
      • setIconUrl

        public void setIconUrl​(String iconUrl)
      • getFieldValue

        public String getFieldValue​(String fieldNameAndLanguage)
      • setImportance

        public void setImportance​(int importance)
      • setKeywords

        public void setKeywords​(String keywords)
      • setVersion

        public void setVersion​(String version)
      • getCreatorName

        public String getCreatorName()
      • setCreatorName

        public void setCreatorName​(String creatorName)
      • getIndexOperation

        public int getIndexOperation()
      • setIndexOperation

        public void setIndexOperation​(int i)
      • getDefaultUrl

        public String getDefaultUrl​(String componentName)
      • isStatusMustBeChecked

        public boolean isStatusMustBeChecked()
      • setStatusMustBeChecked

        public void setStatusMustBeChecked​(boolean statusMustBeChecked)
      • getTargetValidatorId

        public String getTargetValidatorId()
      • setTargetValidatorId

        public void setTargetValidatorId​(String targetValidatorId)
      • getTargetValidatorNames

        public String getTargetValidatorNames()
      • getTargetValidatorIds

        public String[] getTargetValidatorIds()
      • getCloneId

        public String getCloneId()
      • setCloneId

        public void setCloneId​(String tempPubId)
      • haveGotClone

        public boolean haveGotClone()
      • isClone

        public boolean isClone()
      • isValid

        public boolean isValid()
      • isValidationRequired

        public boolean isValidationRequired()
      • isRefused

        public boolean isRefused()
      • isDraft

        public boolean isDraft()
      • getCloneStatus

        public String getCloneStatus()
      • setCloneStatus

        public void setCloneStatus​(String cloneStatus)
      • isUpdateDataMustBeSet

        public boolean isUpdateDataMustBeSet()
        Indicates if the update data MUST be set.

        The update data are:

        • the last update date
        • the last updater

        Returns:
        true if update data MUST be set, false otherwise.
      • setUpdateDataMustBeSet

        public void setUpdateDataMustBeSet​(boolean updateDataMustBeSet)
      • getNbAccess

        public int getNbAccess()
      • setNbAccess

        public void setNbAccess​(int nbAccess)
      • isVisible

        public boolean isVisible()
      • isNoMoreVisible

        public boolean isNoMoreVisible()
      • isNotYetVisible

        public boolean isNotYetVisible()
      • getBeginDateAndHour

        public Date getBeginDateAndHour()
      • getEndDateAndHour

        public Date getEndDateAndHour()
      • isIndexable

        public boolean isIndexable()
        Description copied from interface: Contribution
        Is this contribution indexable? By default true.
        Specified by:
        isIndexable in interface Contribution
        Returns:
        a boolean indicating if this contribution can be taken in charge by the Indexation Engine. By default, any contribution in Silverpeas are indexable unless specified otherwise.
      • isPublicationEditor

        public boolean isPublicationEditor​(String userId)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getContributionType

        public String getContributionType()
        Description copied from interface: Contribution
        Gets the type of this contribution. The type is a label that identifies uniquely a kind of contribution handled by a Silverpeas application. By default, this method returns the simple name of the class implementing this interface.
        Specified by:
        getContributionType in interface Contribution
        Returns:
        the label of the type of this contribution.
      • canBeAccessedBy

        public boolean canBeAccessedBy​(User user)
        Is the specified user can access this publication?

        A user can access a publication if he has enough rights to access both the application instance in which is managed this publication and one of the nodes to which this publication belongs to.

        Specified by:
        canBeAccessedBy in interface Contribution
        Specified by:
        canBeAccessedBy in interface Securable
        Parameters:
        user - a user in Silverpeas.
        Returns:
        true if the user can access this publication, false otherwise.
      • canBeModifiedBy

        public boolean canBeModifiedBy​(User user)
        Is the specified user can modify this publication?

        A user can access a publication on persist context if he has enough rights to access both the application instance in which is managed this publication and one of the nodes to which this publication belongs to.

        Specified by:
        canBeModifiedBy in interface Securable
        Parameters:
        user - a user in Silverpeas.
        Returns:
        true if the user can access this publication, false otherwise.
      • canBeFiledInBy

        public boolean canBeFiledInBy​(User user)
        Is the specified user can file in this publication attachments?
        Specified by:
        canBeFiledInBy in interface Securable
        Parameters:
        user - a user in Silverpeas.
        Returns:
        true if the user has modification rights on this publication. In this case, he can attach documents to this publication. False otherwise.
      • getResourceType

        public static String getResourceType()
        The type of this resource
        Returns:
        the same value returned by getContributionType()
      • getSilverpeasContentId

        public String getSilverpeasContentId()
        Description copied from interface: SilverpeasContent
        Gets the unique identifier of this content among all the contents managed in the Silverpeas collaborative portal. It is the alone unique identifier of a content in the whole Silverpeas portal; it is referred as the Silverpeas content identifier or the silver content identifier. For each content put into the Silverpeas collaborative portal, an entry is uniquely created in the whole system so that is can be referred by transversal services and by component instances others the one that manages it. For compatibility reason, the Silverpeas content identifier of contents that are no yet taken into account in the whole system isn't defined, so an empty string is then returned.
        Specified by:
        getSilverpeasContentId in interface SilverpeasContent
        Returns:
        the unique identifier of this content in the whole Silverpeas collaborative portal. Can be empty if no such identifier is defined for the type of this content (default).
      • setExplicitRank

        public void setExplicitRank​(int explicitRank)
      • getExplicitRank

        public int getExplicitRank()
      • setAuthorizedLocation

        public void setAuthorizedLocation​(Location location)
        Sets an authorized location to the current instance.

        A publication is linked or not to a node, depending the application functional context. This method should be used into the case of a publication linked to a node, located at a location in other words. Sometimes, a publication can be located at several locations (so linked to several nodes), in that case there is a main location and the others which are called "aliases". The caller of this method has verified which locations of a publication is authorized according to a context, that the publication detail instance does not know about, and set one of these authorized ones to the current instance. If the authorized location set defines an alias then some methods will take into account this information, like getPermalink() for example.

        Giving a null location means that alias data MUST be cleared.

        Parameters:
        location - a Location instance.
      • setAlias

        public void setAlias​(boolean alias)
      • isAlias

        public boolean isAlias()
      • isSharingAllowedForRolesFrom

        public boolean isSharingAllowedForRolesFrom​(UserDetail user)
      • getMostRecentUpdater

        public String getMostRecentUpdater()
      • isNew

        public boolean isNew()
        Is this publication a new one? A publication is considered as a new one when it was created or updated before a given amount of day. This amount is a parameter that is set in the publicationSettings.properties properties file.
        Returns:
        true of this publication was created or updated recently. False otherwise