KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > directory > ldapstudio > browser > core > model > IBookmark


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. 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,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  *
19  */
20
21 package org.apache.directory.ldapstudio.browser.core.model;
22
23
24 import java.io.Serializable JavaDoc;
25
26 import org.apache.directory.ldapstudio.browser.core.propertypageproviders.BookmarkPropertyPageProvider;
27 import org.apache.directory.ldapstudio.browser.core.propertypageproviders.ConnectionPropertyPageProvider;
28 import org.apache.directory.ldapstudio.browser.core.propertypageproviders.EntryPropertyPageProvider;
29 import org.eclipse.core.runtime.IAdaptable;
30
31
32 /**
33  * An IBookmark is used as shortcut to an entry in the DIT.
34  * The target entry is defined by a connection a DN.
35  *
36  * @author <a HREF="mailto:dev@directory.apache.org">Apache Directory Project</a>
37  * @version $Rev$, $Date$
38  */
39 public interface IBookmark extends Serializable JavaDoc, IAdaptable, BookmarkPropertyPageProvider, EntryPropertyPageProvider,
40     ConnectionPropertyPageProvider
41 {
42
43     /**
44      * Gets the target DN.
45      *
46      * @return the DN
47      */
48     public DN getDn();
49
50
51     /**
52      * Sets the target DN.
53      *
54      * @param dn the DN
55      */
56     public void setDn( DN dn );
57
58
59     /**
60      * Gets the symbolic name.
61      *
62      * @return the name
63      */
64     public String JavaDoc getName();
65
66
67     /**
68      * Sets the symbolic name.
69      *
70      * @param name the name
71      */
72     public void setName( String JavaDoc name );
73
74
75     /**
76      * Gets the connection.
77      *
78      * @return the connection
79      */
80     public IConnection getConnection();
81
82
83     /**
84      * Gets the entry.
85      *
86      * @return the entry
87      */
88     public IEntry getEntry();
89
90
91     /**
92      * Gets the bookmark parameter.
93      *
94      * @return the bookmark parameter
95      */
96     public BookmarkParameter getBookmarkParameter();
97
98
99     /**
100      * Sets the bookmark parameter.
101      *
102      * @param bookmarkParameter the bookmark parameter
103      */
104     public void setBookmarkParameter( BookmarkParameter bookmarkParameter );
105
106 }
107
Popular Tags