xref: /aoo4110/main/offapi/com/sun/star/ucb/RuleTerm.idl (revision b1cdbd2c)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_RuleTerm_idl__
24#define __com_sun_star_ucb_RuleTerm_idl__
25
26
27//=============================================================================
28
29module com { module sun { module star { module ucb {
30
31//=============================================================================
32/** describes a term.
33
34    <p>A term is used to select objects to which a rule should apply.
35*/
36published struct RuleTerm
37{
38	//-------------------------------------------------------------------------
39	/** the name of the property used to match the term.
40	*/
41	string Property;
42
43	//-------------------------------------------------------------------------
44	/** the value of the property used to compare with the document
45		property.
46	*/
47	any Operand;
48
49	//-------------------------------------------------------------------------
50	/** the operator used to compare the property of the document with
51		the given value (e.g. "contains" or "greater equal").
52
53		<p>The value can be one of the <type>RuleOperator</type> constants.
54	*/
55	short Operator;
56
57	//-------------------------------------------------------------------------
58	/** this flag indicates whether a string "operand" shall be compared
59	    case sensitive.
60	*/
61	boolean CaseSensitive;
62
63	//-------------------------------------------------------------------------
64	/** this flag indicates whether a string "operand" shall be treated
65	    as a regular expression.
66	*/
67	boolean RegularExpression;
68
69};
70
71//=============================================================================
72
73}; }; }; };
74
75#endif
76