com.ibm.jarm.api.core

Class RMFactory.RMLink

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


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

      • fetchInstance

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

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

        public static RMLink createInstance(FilePlanRepository fpRepository,
                            java.lang.String classIdent)
        Creates an instance of a RMLink ready for saving. This new instance can then be further defined using its RMProperties collection and saved using its save method.
        Parameters:
        fpRepository - the FilePlanRepository to associate the new instance with and eventually save to. This entry cannot be null.
        classIdent - an optional class symbolic name to base the new RMLink instance upon. If null, then defaults to the base RMClassName.RMLink class.
        Returns:
        A new RMLink instance.

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