Package org.silverpeas.core.admin.component.model

Class ComponentInst

    • Constructor Detail

      • ComponentInst

        public ComponentInst()
        Creates new ComponentInst

      • ComponentInst

        public ComponentInst​(ComponentInst ci)
        Creates a new Component instance as a copy of the specified one. Only the identifier isn't copied as it should be unique.
        Parameters:
        ci - a component instance to copy.

    • Method Detail

      • getComponentName

        public static String getComponentName​(String componentInstanceId)
        Gets the name of the multi-user component from which the specified instance was spawn. By convention, the identifiers of the component instances are made up of the name of the component followed by a number. This method is a way to get directly the component name from an instance identifier.
        Parameters:
        componentInstanceId - the unique identifier of a component instance.
        Returns:
        the name of the multi-user component or null if the specified identifier doesn't match the rule of a shared component instance identifier.

      • getComponentLocalId

        public static int getComponentLocalId​(String componentInstanceId)
        Gets the local identifier of the multi-user component from which the specified instance was spawn. By convention, the identifiers of the component instances are made up of the name of the component followed by a number, the local identifier. This method is a way to get directly the component local identifier from an instance identifier.
        Parameters:
        componentInstanceId - the unique identifier of a component instance.
        Returns:
        the local identifier of the multi-user component or -1 if the specified identifier doesn't match the rule of a shared component instance identifier.

      • getId

        public String getId()
        Description copied from interface: Identifiable
        Gets the unique identifier of the object in Silverpeas. If he's also identified by a local identifier, then this method should return the one global to Silverpeas.
        Specified by:
        getId in interface Identifiable
        Returns:
        the identifier encoded as a String. If the identifier is a complex one, that is made up of several identification parts, then the returned representation should take care of such a structure.

      • setLocalId

        public void setLocalId​(int id)

      • getLocalId

        public int getLocalId()

      • getLocalIdAsString

        public String getLocalIdAsString()

      • setLabel

        public void setLabel​(String sLabel)

      • setDomainFatherId

        public void setDomainFatherId​(String sDomainFatherId)

      • getDomainFatherId

        public String getDomainFatherId()

      • setOrderNum

        public void setOrderNum​(int iOrderNum)

      • getOrderNum

        public int getOrderNum()

      • setCreationDate

        public void setCreationDate​(Date createDate)

      • getRemovalDate

        public Date getRemovalDate()

      • setRemovalDate

        public void setRemovalDate​(Date removeDate)

      • getStatus

        public String getStatus()

      • setStatus

        public void setStatus​(String status)

      • getLastUpdateDate

        public Date getLastUpdateDate()
        Description copied from interface: SilverpeasResource
        Gets the date at which the resource has been lastly updated. If the resource doesn't have such an information, then this method should return the date of the resource creation.
        Specified by:
        getLastUpdateDate in interface SilverpeasResource
        Returns:
        the date of the last update of the resource.

      • setLastUpdateDate

        public void setLastUpdateDate​(Date updateDate)

      • getRemoverUserId

        public String getRemoverUserId()

      • setRemoverUserId

        public void setRemoverUserId​(String removerUserId)

      • getUpdaterUserId

        public String getUpdaterUserId()

      • setUpdaterUserId

        public void setUpdaterUserId​(String updaterUserId)

      • getNumProfileInst

        public int getNumProfileInst()

      • addProfileInst

        public void addProfileInst​(ProfileInst profileInst)

      • deleteProfileInst

        public void deleteProfileInst​(ProfileInst profileInst)

      • getProfiles

        public List<ProfileInst> getProfiles()
        Gets the specific right profiles of this component instance (that is to say all the non inherited profiles)
        Returns:
        the specific right profiles of this component instance;

      • removeAllProfilesInst

        public void removeAllProfilesInst()

      • getInheritedProfileInst

        public ProfileInst getInheritedProfileInst​(String profileName)

      • getProfileInst

        public ProfileInst getProfileInst​(int nIndex)

      • setParameters

        public void setParameters​(List<Parameter> parameters)

      • setHidden

        public void setHidden​(boolean isHidden)

      • setPublic

        public void setPublic​(boolean isPublic)

      • isInheritanceBlocked

        public boolean isInheritanceBlocked()

      • setInheritanceBlocked

        public void setInheritanceBlocked​(boolean isInheritanceBlocked)

      • getCreatorUserId

        public String getCreatorUserId()

      • setCreatorUserId

        public void setCreatorUserId​(String creatorUserId)

      • getLastUpdater

        public User getLastUpdater()
        Description copied from interface: SilverpeasResource
        Gets the user that has lastly updated the resource. If the resource doesn't have such an information, then this method should return the user that has created the resource.
        Specified by:
        getLastUpdater in interface SilverpeasResource
        Returns:
        a User in Silverpeas.

      • getRemover

        public User getRemover()

      • removeInheritedProfiles

        public void removeInheritedProfiles()

      • getInternalLink

        public String getInternalLink()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object