Package org.craftercms.studio.model.rest

Class ApiResponse

  • public class ApiResponse
extends Object
    Represents the response of an API operation.
    Author:
    Dejan Brkic, avasquez

    • Field Detail

      • COMPLETED_WITH_ERRORS

        public static final ApiResponse COMPLETED_WITH_ERRORS

      • INTERNAL_SYSTEM_FAILURE

        public static final ApiResponse INTERNAL_SYSTEM_FAILURE

      • INVALID_PARAMS

        public static final ApiResponse INVALID_PARAMS

      • DEPRECATED

        public static final ApiResponse DEPRECATED

      • UNAUTHENTICATED

        public static final ApiResponse UNAUTHENTICATED

      • UNAUTHORIZED

        public static final ApiResponse UNAUTHORIZED

      • ORG_NOT_FOUND

        public static final ApiResponse ORG_NOT_FOUND

      • ORG_ALREADY_EXISTS

        public static final ApiResponse ORG_ALREADY_EXISTS

      • GROUP_NOT_FOUND

        public static final ApiResponse GROUP_NOT_FOUND

      • GROUP_ALREADY_EXISTS

        public static final ApiResponse GROUP_ALREADY_EXISTS

      • GROUP_EXTERNALLY_MANAGED

        public static final ApiResponse GROUP_EXTERNALLY_MANAGED

      • SITE_NOT_FOUND

        public static final ApiResponse SITE_NOT_FOUND

      • SITE_ALREADY_EXISTS

        public static final ApiResponse SITE_ALREADY_EXISTS

      • USER_NOT_FOUND

        public static final ApiResponse USER_NOT_FOUND

      • USER_ALREADY_EXISTS

        public static final ApiResponse USER_ALREADY_EXISTS

      • USER_EXTERNALLY_MANAGED

        public static final ApiResponse USER_EXTERNALLY_MANAGED

      • USER_PASSWORD_REQUIREMENTS_FAILED

        public static final ApiResponse USER_PASSWORD_REQUIREMENTS_FAILED

      • USER_PASSWORD_DOES_NOT_MATCH

        public static final ApiResponse USER_PASSWORD_DOES_NOT_MATCH

      • CONTENT_NOT_FOUND

        public static final ApiResponse CONTENT_NOT_FOUND

      • CONTENT_ALREADY_EXISTS

        public static final ApiResponse CONTENT_ALREADY_EXISTS

      • CONTENT_ALREADY_LOCKED

        public static final ApiResponse CONTENT_ALREADY_LOCKED

      • CONTENT_ALREADY_UNLOCKED

        public static final ApiResponse CONTENT_ALREADY_UNLOCKED

      • CONTENT_MOVE_INVALID_LOCATION

        public static final ApiResponse CONTENT_MOVE_INVALID_LOCATION

      • BLOB_NOT_FOUND

        public static final ApiResponse BLOB_NOT_FOUND

      • PUBLISHING_DISABLED

        public static final ApiResponse PUBLISHING_DISABLED

      • SEARCH_UNREACHABLE

        public static final ApiResponse SEARCH_UNREACHABLE

      • LOV_NOT_FOUND

        public static final ApiResponse LOV_NOT_FOUND

      • CLUSTER_MEMBER_NOT_FOUND

        public static final ApiResponse CLUSTER_MEMBER_NOT_FOUND

      • CLUSTER_MEMBER_ALREADY_EXISTS

        public static final ApiResponse CLUSTER_MEMBER_ALREADY_EXISTS

      • REMOTE_REPOSITORY_NOT_FOUND

        public static final ApiResponse REMOTE_REPOSITORY_NOT_FOUND

      • REMOTE_REPOSITORY_ALREADY_EXISTS

        public static final ApiResponse REMOTE_REPOSITORY_ALREADY_EXISTS

      • PULL_FROM_REMOTE_REPOSITORY_CONFLICT

        public static final ApiResponse PULL_FROM_REMOTE_REPOSITORY_CONFLICT

      • ADD_REMOTE_INVALID

        public static final ApiResponse ADD_REMOTE_INVALID

      • REMOVE_REMOTE_FAILED

        public static final ApiResponse REMOVE_REMOTE_FAILED

      • PUSH_TO_REMOTE_FAILED

        public static final ApiResponse PUSH_TO_REMOTE_FAILED

      • REMOTE_REPOSITORY_NOT_REMOVABLE

        public static final ApiResponse REMOTE_REPOSITORY_NOT_REMOVABLE

      • REMOTE_REPOSITORY_AUTHENTICATION_FAILED

        public static final ApiResponse REMOTE_REPOSITORY_AUTHENTICATION_FAILED

      • MARKETPLACE_NOT_INITIALIZED

        public static final ApiResponse MARKETPLACE_NOT_INITIALIZED

      • MARKETPLACE_UNREACHABLE

        public static final ApiResponse MARKETPLACE_UNREACHABLE

      • PLUGIN_ALREADY_INSTALLED

        public static final ApiResponse PLUGIN_ALREADY_INSTALLED

      • PLUGIN_INSTALLATION_ERROR

        public static final ApiResponse PLUGIN_INSTALLATION_ERROR

      • BOX_UNREACHABLE

        public static final ApiResponse BOX_UNREACHABLE

      • AWS_UNREACHABLE

        public static final ApiResponse AWS_UNREACHABLE

      • LOGGER_NOT_FOUND

        public static final ApiResponse LOGGER_NOT_FOUND

      • CONFIGURATION_PROFILE_NOT_FOUND

        public static final ApiResponse CONFIGURATION_PROFILE_NOT_FOUND

    • Constructor Detail

      • ApiResponse

        public ApiResponse​(ApiResponse response)

    • Method Detail

      • getCode

        public int getCode()
        Returns the response code.

      • setCode

        public void setCode​(int code)
        Sets the response code.

      • getMessage

        public String getMessage()
        Returns the detailed message of the response.

      • setMessage

        public void setMessage​(String message)
        Sets the detailed message of the response.

      • getRemedialAction

        public String getRemedialAction()
        Returns what the user can do in order to address the issue indicated by the response.

      • setRemedialAction

        public void setRemedialAction​(String remedialAction)
        Sets what the user can do in order to address the issue indicated by the response.

      • getDocumentationUrl

        public String getDocumentationUrl()
        Returns the URL to documentation related to the response.

      • setDocumentationUrl

        public void setDocumentationUrl​(String documentationUrl)
        Sets the URL to documentation related to the response.