View Javadoc

1   /**
2    * Copyright (C) 2005-2009 Alfresco Software Limited.
3    *
4    * This file is part of the Spring Surf Extension project.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *  http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.springframework.roo.addon.surf.report;
19  
20  import org.springframework.roo.shell.CliAvailabilityIndicator;
21  import org.springframework.roo.shell.CliCommand;
22  import org.springframework.roo.shell.CliOption;
23  import org.springframework.roo.shell.CommandMarker;
24  import org.springframework.roo.support.lifecycle.ScopeDevelopmentShell;
25  import org.springframework.roo.support.util.Assert;
26  
27  /**
28   * Commands for managing Surf reports.
29   * @author Yong Qu
30   * @since 1.0
31   *
32   */
33  @ScopeDevelopmentShell
34  public class ReportCommands implements CommandMarker{
35  
36  	private ReportOperations reportOperations;
37  
38  	/**
39  	 * @param reportOperations
40  	 */
41  	public ReportCommands(ReportOperations reportOperations) {
42  		Assert.notNull(reportOperations, "ReportOperations instance required");
43  		this.reportOperations = reportOperations;
44  	}
45  
46  	/**
47  	 * Check availability of the "surf report page" command.
48  	 * @return true if the "surf report page" command is available at this moment.
49  	 */
50  	@CliAvailabilityIndicator({"surf report page"})
51  	public boolean isPageReportAvailable() {
52  		return reportOperations.isReportOperationAvailable();
53  	}
54  
55  	/**
56  	 * Lists detailed configurations of a Surf page.
57  	 * @param pageId Page Id.
58  	 * @return Detailed configurations of the Surf page.
59  	 */
60  	@CliCommand(value="surf report page", help="Lists detailed configurations of a Surf page.")
61  	public String showSurfPageConfig(
62  			@CliOption(key={"id",""}, mandatory=true, help="Specifies id of the Surf page.") String pageId
63  		) {
64  		return reportOperations.showSurfPageConfig(pageId);
65  	}	
66  	
67  }