com.ibm.jarm.api.core

Interface BaseEntity

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Integer getAccessAllowed()
      Returns a value representing a bit mask of access rights granted to the current user for this object.
      RMClassDescription getClassDescription()
      Returns the RMClassDescription for this entity.
      java.lang.String getClassName()
      Provides the name of the repository class from which the entity is instantiated.
      java.lang.String getClientIdentifier()
      Provides the client-specific identifying string for the entity.
      java.util.List<Container> getContainedBy()
      Provides the collection of Container instances in which this entity is filed, if any.
      DomainType getDomainType()
      Convenience method that indicates the type of RMDomain in which this BaseEntity resides.
      EntityType getEntityType()
      Provides the entity type of this entity.
      java.lang.String getName()
      Provides a Name property value for the entity, if any.
      java.lang.String getObjectIdentity()
      Provides a unique, repository-specific identifying string for the entity.
      java.util.List<RMPermission> getPermissions()
      Provides the RMPermission collection for this entity.
      RMProperties getProperties()
      Provides the collection of properties that reflects the state of the property cache of the entity.
      Repository getRepository()
      Provides the repository to which this entity belongs.
      boolean isCreationPending()
      Returns true if this instance represents a new entity that has not been saved to a repository.
      boolean isPlaceholder()
      Returns true if this instance currently represents a placeholder for an actual repository entity.
      void refresh()
      Retrieves the entity from its repository updating the values of its existing internally cached properties.
      void refresh(RMPropertyFilter filter)
      Retrieves the entity from its repository updating its internal property cached based upon the supplied RMPropertyFilter.
      void refresh(java.lang.String[] symbolicPropertyNames)
      Retrieves the entity from its repository updating the values of the specified properties.
    • Method Detail

      • getClientIdentifier

        java.lang.String getClientIdentifier()
        Provides the client-specific identifying string for the entity. This is typically the identifying string passed in during a client RMFactory.xxx.get/fetch method call. For those entities that are instantiated due to their membership in a retrieved collection, this identity value typically reflects the same value as that returned by the getObjectIdentity() method.
        Returns:
        A String value.
      • getObjectIdentity

        java.lang.String getObjectIdentity()
        Provides a unique, repository-specific identifying string for the entity. This value typically takes the form of a GUID string. This entry can be null if the entity has not been fetched from the repository.
        Returns:
        A String value.
      • getClassName

        java.lang.String getClassName()
        Provides the name of the repository class from which the entity is instantiated.
        Returns:
        A String value.
      • getName

        java.lang.String getName()
        Provides a Name property value for the entity, if any.
        Returns:
        A String value.
      • getEntityType

        EntityType getEntityType()
        Provides the entity type of this entity.
        Returns:
        An EntityType value.
      • getRepository

        Repository getRepository()
        Provides the repository to which this entity belongs.
        Returns:
        A Repository instance.
      • isPlaceholder

        boolean isPlaceholder()
        Returns true if this instance currently represents a placeholder for an actual repository entity. The actual entity has not been fetched from the repository. This is typically the case when a RMFactory.xxx.getInstance method has been used to establish the instance.
        Returns:
        true if instance represents a placeholder, false if instance has been fetched from a repository.
      • isCreationPending

        boolean isCreationPending()
        Returns true if this instance represents a new entity that has not been saved to a repository.
        Returns:
        true if this instance has not been saved, false otherwise.
      • getProperties

        RMProperties getProperties()
        Provides the collection of properties that reflects the state of the property cache of the entity.
        Returns:
        A RMProperties collection.
      • getContainedBy

        java.util.List<Container> getContainedBy()
        Provides the collection of Container instances in which this entity is filed, if any.
        Returns:
        A List of Container instances. Can be empty.
        Throws:
        RAL_RETRIEVING_PARENT_CONTAINER_FAILED - for any unexpected error.
      • refresh

        void refresh()
        Retrieves the entity from its repository updating the values of its existing internally cached properties.
      • refresh

        void refresh(java.lang.String[] symbolicPropertyNames)
        Retrieves the entity from its repository updating the values of the specified properties.
        Parameters:
        symbolicPropertyNames - An array of symbolic names of the properties to update.
      • refresh

        void refresh(RMPropertyFilter filter)
        Retrieves the entity from its repository updating its internal property cached based upon the supplied RMPropertyFilter.
        Parameters:
        filter - An optional RMPropertyFilter defining retrieved properties for the repository instance. This setting can be null.
      • getAccessAllowed

        java.lang.Integer getAccessAllowed()
        Returns a value representing a bit mask of access rights granted to the current user for this object.
        Returns:
        An Integer instance. This value can be null if this object has not been resolved from the repository.
      • getDomainType

        DomainType getDomainType()
        Convenience method that indicates the type of RMDomain in which this BaseEntity resides.
        Returns:
        A DomainType value.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.