Enum PreplannedPackagingStatus

  • All Implemented Interfaces:
    Serializable, Comparable<PreplannedPackagingStatus>

    public enum PreplannedPackagingStatus
    extends Enum<PreplannedPackagingStatus>
    Enumerates the different packaging states that an online PreplannedMapArea can be in. A PreplannedMapArea is made up of a set of data packages for each of the layers in the map. When a web map author first creates a map area these packages must be prepared by the relevant online services before the area is ready to be downloaded as an offline map.

    PreplannedPackagingStatus lists the possible packaging states for an online map area. The area cannot be downloaded until the value is COMPLETE.

    Since:
    100.9.0
    • Enum Constant Detail

      • UNKNOWN

        public static final PreplannedPackagingStatus UNKNOWN
        Indicates that the packaging status of the PreplannedMapArea is unknown. This status is returned when your app does not yet know the status of the online area. For example, this would be the case when the PreplannedMapArea has a load status of LoadStatus.NOT_LOADED.
        Since:
        100.9.0
      • PROCESSING

        public static final PreplannedPackagingStatus PROCESSING
        Indicates that the PreplannedMapArea is not yet ready for download. This is the initial status for a PreplannedMapArea that has been created on the web map, but is not yet ready for download.
        Since:
        100.9.0
      • FAILED

        public static final PreplannedPackagingStatus FAILED
        Indicates that a failure occurred when creating the packages for the PreplannedMapArea. This status means that the PreplannedMapArea cannot be downloaded. Failures encountered while creating packages need to be addressed by the web map author.
        Since:
        100.9.0
      • COMPLETE

        public static final PreplannedPackagingStatus COMPLETE
        Indicates that packaging is complete and the PreplannedMapArea is ready to be downloaded. This status means that all packages required to download the PreplannedMapArea have been successfully prepared.
        Since:
        100.9.0
    • Method Detail

      • values

        public static PreplannedPackagingStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (PreplannedPackagingStatus c : PreplannedPackagingStatus.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static PreplannedPackagingStatus valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null