KickJava   Java API By Example, From Geeks To Geeks.

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


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.ConnectionPropertyPageProvider;
27 import org.apache.directory.ldapstudio.browser.core.propertypageproviders.EntryPropertyPageProvider;
28 import org.eclipse.core.runtime.IAdaptable;
29
30
31 public interface ISearchResult extends Serializable JavaDoc, IAdaptable, EntryPropertyPageProvider,
32     ConnectionPropertyPageProvider
33 {
34
35     /**
36      * Returns the DN of the search result entry.
37      *
38      * @return the DN of the search result entry.
39      */
40     public DN getDn();
41
42
43     /**
44      * Returns the attributes of the search result entry.
45      *
46      * @return the attributes of the search result entry.
47      */
48     public IAttribute[] getAttributes();
49
50
51     /**
52      * Returns the attribute of the search result entry.
53      *
54      * @param attributeDescription
55      * the attribute description of the attribute to return
56      * @return the attribute with the given description or null.
57      */
58     public IAttribute getAttribute( String JavaDoc attributeDescription );
59
60
61     /**
62      * Returns the AttributeHierachie of the search result entry.
63      *
64      * @param attributeDescription
65      * the description of the attribute to return
66      * @return the AttributeHierachie with the given description or null.
67      */
68     public AttributeHierarchy getAttributeWithSubtypes( String JavaDoc attributeDescription );
69
70
71     /**
72      * Returns the entry of the search result.
73      *
74      * @return the entry
75      */
76     public IEntry getEntry();
77
78
79     /**
80      * Return the search, the parent of this search result.
81      *
82      * @return the search
83      */
84     public ISearch getSearch();
85
86
87     public void setSearch( ISearch search );
88
89 }
90
Popular Tags