com.ibm.jarm.api.core

Class RMFactory.RMCustomObject

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


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

      • fetchInstance

        public static RMCustomObject fetchInstance(Repository repository,
                                   java.lang.String objId,
                                   RMPropertyFilter filter)
        Retrieves a RMCustomObject from a repository.
        Parameters:
        repository - the Repository to retrieve from. This entry cannot be null.
        objId - the ID String of the desired custom object. This entry cannot be null or blank.
        filter - An optional RMPropertyFilter defining which properties to retrieve. This entry can be null.
        Returns:
        A RMCustomObject instance.
      • fetchInstance

        public static RMCustomObject fetchInstance(Repository repository,
                                   EntityType entityType,
                                   java.lang.String objId,
                                   RMPropertyFilter filter)
        Retrieves a RMCustomObject from a repository.
        Parameters:
        repository - the Repository to retrieve from. This entry cannot be null.
        entityType - the EntityType of the desired custom object. This entry cannot be null.
        objId - the ID String of the desired custom object. This entry cannot be null or blank.
        filter - An optional RMPropertyFilter defining which properties to retrieve. This entry can be null.
        Returns:
        A RMCustomObject subclass instance.
      • getInstance

        public static RMCustomObject getInstance(Repository repository,
                                 java.lang.String objId)
        Constructs a placeholder instance of the specified RMCustomObject object.
        Parameters:
        repository - the Repository that the custom object is associated with. This entry cannot be null.
        objId - the ID String of the desired custom object. This entry cannot be null or blank.
        Returns:
        A RMCustomObject instance.
      • createInstance

        public static RMCustomObject createInstance(FilePlanRepository repository)
        Creates a RMCustomObject instance that is associated with the given Repository. This new instance can then be further defined using its RMProperties collection and saved using its save method.

        For this createInstance method version, an Id value will be automatically generated for the new instance.

        Parameters:
        repository - The Repository to associate the new instance with and eventually save to.
        Returns:
        A new RMCustomObject instance.
      • createInstance

        public static RMCustomObject createInstance(FilePlanRepository repository,
                                    java.lang.String idStr)
        Creates a RMCustomObject instance that is associated with the given Repository. This new instance can then be further defined using its RMProperties collection and saved using its save method.

        This createInstance method version allows the caller to optionally specify an Id value to assign the the new instance.

        Parameters:
        repository - The Repository to associate the new instance with and eventually save to.
        idStr - a String Id value to be assigned to the new instance. This parameter can be null in which case an Id value will be automatically generated for the new instance.
        Returns:
        A new RMCustomObject instance.

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