com.ibm.jarm.api.core

Class RMFactory.NamingPattern

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


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

      • fetchInstance

        public static NamingPattern fetchInstance(FilePlanRepository fpRepository,
                                  java.lang.String namingPatternId,
                                  RMPropertyFilter filter)
        Retrieves a specific NamingPattern from the specified domain.
        Parameters:
        fpRepository - the FilePlanRepository to retrieve from. This entry cannot be null.
        namingPatternId - the ID String of the desired naming pattern. This entry cannot be null or blank.
        filter - an optional RMPropertyFilter defining which properties to retrieve. This entry can be null.
        Returns:
        A NamingPattern instance.
      • getInstance

        public static NamingPattern getInstance(FilePlanRepository fpRepository,
                                java.lang.String namingPatternId)
        Constructs a placeholder instance of the specified NamingPattern object.
        Parameters:
        fpRepository - the FilePlanRepository that the naming pattern is associated with. This entry cannot be null.
        namingPatternId - the ID String of the desired naming pattern. This entry cannot be null or blank.
        Returns:
        A NamingPattern instance.
      • createInstance

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

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

        Parameters:
        fpRepository - the FilePlanRepository to associate the new instance with and eventually save to. This entry cannot be null.
        Returns:
        A new NamingPattern instance.
      • createInstance

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

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

        Parameters:
        fpRepository - the FilePlanRepository to associate the new instance with and eventually save to. This entry cannot be null.
        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 NamingPattern instance.

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