1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.notifications.notifiers.internal

File ModelBridge.java

 

Code metrics

0
0
0
1
57
12
0
-
-
0
-

Classes

Class Line # Actions
ModelBridge 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.notifications.notifiers.internal;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.model.reference.DocumentReference;
24    import org.xwiki.notifications.NotificationException;
25   
26    import com.xpn.xwiki.objects.BaseObjectReference;
27   
28    /**
29    * Internal role that make requests to the model and avoid a direct dependency to oldcore.
30    *
31    * @version $Id: 92bea6abfb375eed5881455f80c8ac3c18468b3f $
32    * @since 9.7RC1
33    */
34    @Role
 
35    public interface ModelBridge
36    {
37    /**
38    * Save an object's property in an hidden document.
39    *
40    * @param objectReference reference of the object to save
41    * @param property the name of the property to set
42    * @param value the value of the property to set
43    * @throws NotificationException if error happens
44    */
45    void savePropertyInHiddenDocument(BaseObjectReference objectReference, String property, Object value)
46    throws NotificationException;
47   
48    /**
49    * Return the URL of the given {@link DocumentReference} for the given action.
50    *
51    * @param documentReference the reference
52    * @param action the request action
53    * @param parameters the request parameters
54    * @return the URL of the given reference
55    */
56    String getDocumentURL(DocumentReference documentReference, String action, String parameters);
57    }