com.ibm.jarm.api.core

Class RMFactory.BaseEntity

  • java.lang.Object
    • com.ibm.jarm.api.core.RMFactory.BaseEntity
  • Enclosing class:
    RMFactory


    public static class RMFactory.BaseEntity
    extends java.lang.Object
    Factory for generalized BaseEntity instances.
    • Method Detail

      • fetchInstance

        public static BaseEntity fetchInstance(Repository repository,
                               EntityType entityType,
                               java.lang.String ident,
                               RMPropertyFilter filter)
        Retrieves a generalized BaseEntity from a repository.
        Parameters:
        repository - the Repository to retrieve from. This entry cannot be null.
        entityType - the expected EntityType of the desired entity. This entry cannot be null.
        ident - an ID String or full path name String of the desired entity. This entry cannot be null or blank.
        filter - an optional RMPropertyFilter defining which properties to retrieve. This entry can be null.
        Returns:
        A BaseEntity instance.
      • fetchInstance

        public static BaseEntity fetchInstance(Repository repository,
                               java.lang.String classIdent,
                               java.lang.String ident,
                               RMPropertyFilter filter)
        Retrieves a generalized BaseEntity from a repository.
        Parameters:
        repository - the Repository to retrieve from. This entry cannot be null.
        classIdent - an ID String or symbolic name String of desired object's class. This entry cannot be null.
        ident - an ID String or full path name String of the desired entity. This entry cannot be null or blank.
        filter - an optional RMPropertyFilter defining which properties to retrieve. This entry can be null.
        Returns:
        A BaseEntity instance.
      • getInstance

        public static BaseEntity getInstance(FilePlanRepository fpRepository,
                             EntityType entityType,
                             java.lang.String baseEntityIdent)
        Constructs a placeholder instance of a specific BaseEntity. A placeholder instance can be used for performing updates or as a reference for an object-type property value.
        Parameters:
        fpRepository - the FilePlanRepository that the base entity is associated with. This entry cannot be null.
        entityType - the EntityType of desired base entity. This entry cannot be null.
        baseEntityIdent - an Id String or full path name String of the desired entity. This entry cannot be null or blank.
        Returns:
        A subclass of BaseEntity.
      • getInstance

        public static BaseEntity getInstance(FilePlanRepository fpRepository,
                             java.lang.String classIdent,
                             java.lang.String baseEntityIdent)
        Constructs a placeholder instance of a specific BaseEntity. A placeholder instance can be used for performing updates and as a reference for an object-type property value.
        Parameters:
        fpRepository - the FilePlanRepository that the base entity is associated with. This entry cannot be null.
        classIdent - an ID String or symbolic name String of the desired entity's class. This entry cannot be null.
        baseEntityIdent - an ID String or full path String of desired base entity. This entry cannot be null or blank.
        Returns:
        An instance of BaseEntity.

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