com.ibm.jarm.api.core

Class RMFactory.Location

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


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

      • fetchInstance

        public static Location fetchInstance(FilePlanRepository fpRepository,
                             java.lang.String locationId,
                             RMPropertyFilter filter)
        Retrieves a Location from a file plan repository.
        Parameters:
        fpRepository - the FilePlanRepository to retrieve from. This entry cannot be null.
        locationId - the ID String of the desired location. This entry cannot be null or blank.
        filter - an optional RMPropertyFilter defining which properties to retrieve. This entry can be null.
        Returns:
        A Location instance.
      • getInstance

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

        public static Location createInstance(FilePlanRepository fpRepository)
        Creates a Location instance that is associated with the given FilePlanRepository. 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:
        fpRepository - the FilePlanRepository to associate the new instance with and eventually save to. This entry cannot be null.
        Returns:
        A new Location instance.
      • createInstance

        public static Location createInstance(FilePlanRepository fpRepository,
                              java.lang.String idStr)
        Creates a Location instance that is associated with the given FilePlanRepository. 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:
        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 Location instance.

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