001/* 002 * (C) Copyright 2006-2008 Nuxeo SA (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 * 016 * Contributors: 017 * Nuxeo - initial API and implementation 018 * 019 * $Id$ 020 * 021 */ 022 023package org.nuxeo.ecm.platform.commandline.executor.api; 024 025import java.io.Serializable; 026 027/** 028 * Represents the availability status of a command. If command is not available, {@link CommandAvailability} contains 029 * the errorMessage and some installation instructions. 030 * 031 * @author tiry 032 */ 033public class CommandAvailability implements Serializable { 034 035 private static final long serialVersionUID = 1L; 036 037 protected final String installMessage; 038 039 protected final String errorMessage; 040 041 protected final boolean available; 042 043 public CommandAvailability(String installMessage, String errorMessage) { 044 available = false; 045 this.installMessage = installMessage; 046 this.errorMessage = errorMessage; 047 } 048 049 public CommandAvailability(String errorMessage) { 050 this(null, errorMessage); 051 } 052 053 public CommandAvailability() { 054 available = true; 055 installMessage = null; 056 errorMessage = null; 057 } 058 059 public String getInstallMessage() { 060 return installMessage; 061 } 062 063 public String getErrorMessage() { 064 return errorMessage; 065 } 066 067 public boolean isAvailable() { 068 return available; 069 } 070 071}