xref: /trunk/main/officecfg/registry/schema/org/openoffice/Office/Jobs.xcs (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1<?xml version="1.0" encoding="UTF-8"?>
2<!--***********************************************************************
3 *
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 *
8 * OpenOffice.org - a multi-platform office productivity suite
9 *
10 * This file is part of OpenOffice.org.
11 *
12 * OpenOffice.org is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU Lesser General Public License version 3
14 * only, as published by the Free Software Foundation.
15 *
16 * OpenOffice.org is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 * GNU Lesser General Public License version 3 for more details
20 * (a copy is included in the LICENSE file that accompanied this code).
21 *
22 * You should have received a copy of the GNU Lesser General Public License
23 * version 3 along with OpenOffice.org.  If not, see
24 * <http://www.openoffice.org/license.html>
25 * for a copy of the LGPLv3 License.
26 *
27 ************************************************************************ -->
28<!DOCTYPE oor:component-schema SYSTEM "../../../../component-schema.dtd">
29<oor:component-schema xmlns:oor="http://openoffice.org/2001/registry" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" oor:name="Jobs" oor:package="org.openoffice.Office" xml:lang="en-US"> <info>
30        <author>AS</author>
31        <desc >Contains information about registered jobs, bound on events.</desc>
32    </info>
33    <templates>
34        <group oor:name="Job">
35                    <info>
36                <desc>Describes an UNO service, which is registered for a special event.</desc>
37            </info>
38                    <prop oor:name="Service" oor:type="xs:string">
39                        <info>
40                    <desc>Must contain an UNO implementation(!) name of the implemented job component.</desc>
41                </info>
42                    </prop>
43                    <prop oor:name="Context" oor:type="xs:string">
44                        <info>
45                    <desc>An property to define the context this event should be active in. It can be empty or a colon separated list of the supported application modules.</desc>
46                </info>
47                    </prop>
48                    <group oor:name="Arguments" oor:extensible="true">
49                        <info>
50                    <desc>Can be filled with any argument, which is under control of the job component.</desc>
51                </info>
52                    </group>
53            </group>
54            <group oor:name="TimeStamp">
55                    <info>
56                <desc>Is used to enable/disable a job execution related to a triggered event.</desc>
57            </info>
58                    <prop oor:name="AdminTime" oor:type="xs:string">
59                        <info>
60                    <desc>If it's newer then UserTime, the job will be reactivated next time.</desc>
61                </info>
62                        <value>2003-01-01T00:00:00+00:00</value>
63                    </prop>
64                    <prop oor:name="UserTime" oor:type="xs:string">
65                        <info>
66                    <desc>If it's newer then AdminTime, the job is deactivated for execution.</desc>
67                </info>
68                        <value>2003-01-01T00:00:00+00:00</value>
69                    </prop>
70            </group>
71            <group oor:name="Event">
72                    <info>
73                <desc>Describe a state, which can be detected at runtime and will be used to start jobs, which are registered for it.</desc>
74            </info>
75                    <set oor:name="JobList" oor:node-type="TimeStamp">
76                        <info>
77                    <desc>This list contains all registered jobs, which wish to be executed, if the coressponding event was triggered.</desc>
78                </info>
79                    </set>
80            </group>
81    </templates>
82    <component>
83        <set oor:name="Jobs" oor:node-type="Job">
84                    <info>
85                <desc>This list contains all well known job components and it's properties.</desc>
86            </info>
87        </set>
88        <set oor:name="Events" oor:node-type="Event">
89                    <info>
90                <desc>Here jobs can be bound to events and can be enabled/disable by using TimeStamp values.</desc>
91            </info>
92        </set>
93    </component>
94</oor:component-schema>
95