com.ibm.jarm.api.core

Class RMFactory.Hold

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


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

      • fetchInstance

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

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

        public static Hold createInstance(FilePlanRepository fpRepository)
        Creates a Hold 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.
        Returns:
        A new Hold instance.
      • createInstance

        public static Hold createInstance(FilePlanRepository fpRepository,
                          java.lang.String idStr)
        Creates a Hold 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.
        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 Hold instance.

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