Package org.opencms.ade.sitemap.client.alias

Class CmsClientAliasImportResult

  • public class CmsClientAliasImportResult
extends java.lang.Object
    A client-side bean for representing the results of an alias import.

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsClientAliasImportResult​(java.lang.String line, org.opencms.gwt.shared.alias.CmsAliasImportStatus status, java.lang.String message)
      Creates a new instance.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getLine()
      Gets the CSV line containing the alias.
      java.lang.String getMessage()
      Gets the import message.
      org.opencms.gwt.shared.alias.CmsAliasImportStatus getStatus()
      Gets the import status.
      protected static java.lang.String getString​(com.google.gwt.json.client.JSONObject json, java.lang.String key)
      Helper method to get a string value from a JSON object.
      static CmsClientAliasImportResult parse​(com.google.gwt.json.client.JSONObject json)
      Parses an alias import result from a JSON object.
      static java.util.List<CmsClientAliasImportResult> parseArray​(com.google.gwt.json.client.JSONArray array)
      Extracts alias import results from a JSON array.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CmsClientAliasImportResult

        public CmsClientAliasImportResult​(java.lang.String line,
                                  org.opencms.gwt.shared.alias.CmsAliasImportStatus status,
                                  java.lang.String message)
        Creates a new instance.

        Parameters:
        line - the CSV line containing the alias
        status - the import status
        message - the import message

    • Method Detail

      • parse

        public static CmsClientAliasImportResult parse​(com.google.gwt.json.client.JSONObject json)
        Parses an alias import result from a JSON object.

        Parameters:
        json - the JSON object containing the alias import result data
        Returns:
        the alias import result bean

      • parseArray

        public static java.util.List<CmsClientAliasImportResult> parseArray​(com.google.gwt.json.client.JSONArray array)
        Extracts alias import results from a JSON array.

        Parameters:
        array - the JSON array
        Returns:
        the alias import results from the array

      • getString

        protected static java.lang.String getString​(com.google.gwt.json.client.JSONObject json,
                                            java.lang.String key)
        Helper method to get a string value from a JSON object.

        Parameters:
        json - the JSON object
        key - the key whose value should be extracted as a string
        Returns:
        the string value for the given key

      • getLine

        public java.lang.String getLine()
        Gets the CSV line containing the alias.

        Returns:
        the CSV line

      • getMessage

        public java.lang.String getMessage()
        Gets the import message.

        Returns:
        the import message

      • getStatus

        public org.opencms.gwt.shared.alias.CmsAliasImportStatus getStatus()
        Gets the import status.

        Returns:
        the import status