1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.office.viewer

File OfficeViewerScriptService.java

 

Code metrics

0
0
0
1
67
13
0
-
-
0
-

Classes

Class Line # Actions
OfficeViewerScriptService 35 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.office.viewer;
21   
22    import java.util.Map;
23   
24    import org.xwiki.component.annotation.Role;
25    import org.xwiki.model.reference.AttachmentReference;
26    import org.xwiki.script.service.ScriptService;
27   
28    /**
29    * Exposes utility methods for viewing office attachments in server-side scripts.
30    *
31    * @since 2.5M2
32    * @version $Id: 6cb3a89c4b38a482a338c7d17324aceda74d6c5c $
33    */
34    @Role
 
35    public interface OfficeViewerScriptService extends ScriptService
36    {
37    /**
38    * Builds a XHTML representation of the specified office attachment.
39    *
40    * @param attachmentReference reference to the office attachment to be viewed
41    * @return a XHTML representation of the specified office attachment or {@code null} if an error occurs
42    */
43    String view(AttachmentReference attachmentReference);
44   
45    /**
46    * Builds a XHTML representation of the specified office attachment.
47    *
48    * @param attachmentReference reference to the office attachment to be viewed
49    * @param parameters view parameters specific to the underlying {@link OfficeViewer} implementation
50    * @return a XHTML representation of the specified office attachment or {@code null} if an error occurs
51    */
52    String view(AttachmentReference attachmentReference, Map<String, String> parameters);
53   
54    /**
55    * @return the exception caught during the last office attachment view on the current execution, or {@code null} if
56    * no exception has been thrown
57    */
58    Exception getCaughtException();
59   
60    /**
61    * Checks if a given mime type is supported for viewing.
62    *
63    * @param mimeType a mime type
64    * @return {@code true} if the specified mime type can be viewed, {@code false} otherwise
65    */
66    boolean isMimeTypeSupported(String mimeType);
67    }