com.ibm.jarm.api.core

Class RMFactory.RecordType

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


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

      • fetchInstance

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

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

        public static RecordType createInstance(FilePlanRepository fpRepository)
        Creates a RecordType 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 RecordType instance.
      • createInstance

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

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