001 /*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License"). You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2006-2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.types.operation;
028
029
030
031 import java.util.LinkedHashSet;
032
033 import org.opends.server.types.ByteString;
034 import org.opends.server.types.DereferencePolicy;
035 import org.opends.server.types.DN;
036 import org.opends.server.types.RawFilter;
037 import org.opends.server.types.SearchScope;
038 import org.opends.server.types.SearchFilter;
039
040
041
042 /**
043 * This class defines a set of methods that are available for use by
044 * search result entry plugins. Note that this interface is intended
045 * only to define an API for use by plugins and is not intended to be
046 * implemented by any custom classes.
047 */
048 @org.opends.server.types.PublicAPI(
049 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
050 mayInstantiate=false,
051 mayExtend=false,
052 mayInvoke=true)
053 public interface SearchEntrySearchOperation
054 extends InProgressOperation
055 {
056 /**
057 * Retrieves the raw, unprocessed base DN as included in the request
058 * from the client. This may or may not contain a valid DN, as no
059 * validation will have been performed.
060 *
061 * @return The raw, unprocessed base DN as included in the request
062 * from the client.
063 */
064 public ByteString getRawBaseDN();
065
066
067
068 /**
069 * Retrieves the base DN for this search operation.
070 *
071 * @return The base DN for this search operation.
072 */
073 public DN getBaseDN();
074
075
076
077 /**
078 * Retrieves the scope for this search operation.
079 *
080 * @return The scope for this search operation.
081 */
082 public SearchScope getScope();
083
084
085
086 /**
087 * Retrieves the alias dereferencing policy for this search
088 * operation.
089 *
090 * @return The alias dereferencing policy for this search
091 * operation.
092 */
093 public DereferencePolicy getDerefPolicy();
094
095
096
097 /**
098 * Retrieves the size limit for this search operation.
099 *
100 * @return The size limit for this search operation.
101 */
102 public int getSizeLimit();
103
104
105
106 /**
107 * Retrieves the time limit for this search operation.
108 *
109 * @return The time limit for this search operation.
110 */
111 public int getTimeLimit();
112
113
114
115 /**
116 * Retrieves the typesOnly flag for this search operation.
117 *
118 * @return The typesOnly flag for this search operation.
119 */
120 public boolean getTypesOnly();
121
122
123
124 /**
125 * Retrieves the raw, unprocessed search filter as included in the
126 * request from the client. It may or may not contain a valid
127 * filter (e.g., unsupported attribute types or values with an
128 * invalid syntax) because no validation will have been performed on
129 * it.
130 *
131 * @return The raw, unprocessed search filter as included in the
132 * request from the client.
133 */
134 public RawFilter getRawFilter();
135
136
137
138 /**
139 * Retrieves the filter for this search operation.
140 *
141 * @return The filter for this search operation.
142 */
143 public SearchFilter getFilter();
144
145
146
147 /**
148 * Retrieves the set of requested attributes for this search
149 * operation. Its contents should not be be altered.
150 *
151 * @return The set of requested attributes for this search
152 * operation.
153 */
154 public LinkedHashSet<String> getAttributes();
155 }
156