1 mike  1.1 //%/////////////////////////////////////////////////////////////////////////////
 2           //
 3           // Copyright (c) 2000 The Open Group, BMC Software, Tivoli Systems, IBM
 4           //
 5           // Permission is hereby granted, free of charge, to any person obtaining a
 6           // copy of this software and associated documentation files (the "Software"),
 7           // to deal in the Software without restriction, including without limitation
 8           // the rights to use, copy, modify, merge, publish, distribute, sublicense,
 9           // and/or sell copies of the Software, and to permit persons to whom the
10           // Software is furnished to do so, subject to the following conditions:
11           //
12           // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
13           // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
14           // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
15           // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
16           // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
17           // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
18           // DEALINGS IN THE SOFTWARE.
19           //
20           //==============================================================================
21           //
22 mike  1.1 // Author: Mike Brasher (mbrasher@bmc.com)
23           //
24           // Modified By:
25           //
26           //%/////////////////////////////////////////////////////////////////////////////
27           
28           #ifndef Pegasus_AssociatorsFile_h
29           #define Pegasus_AssociatorsFile_h
30           
31           #include <Pegasus/Common/Config.h>
32           
33           PEGASUS_NAMESPACE_BEGIN
34           
35           /** The AssociatorsFile class keeps track of associators of a particular 
36               instance. This class supports the implementation of the associators
37               and associatorNames CIM operations. For details, see the documentation
38               for CIMOperations::associators() and CIMOperations::associatorNames().
39           
40               If an instance (or class) is involed in any associations, then an 
41               associator file must exist which contains those associators. For example, 
42               if the instance contained in the file "MyClass.451" has associators,
43 mike  1.1     they will be kept in the file named "MyClass.451.associators". Similarly,
44               if the class contained in "MyClass.YourClass" has assocaitors, they
45               are kept in "MyClass.YourClass.associators".
46           
47               Associator files have at least one line for each association in which the
48               particular instance (or class) is involved (if an association ties
49               an instance to N other instances, then there will be N lines in the
50               association file for that association). Lines of the files are broken 
51               into fields as shown below (for a thorough explanation of the first four 
52               fields, see the documentation for CIMOperations::instanceNames()).
53           
54           	<ul>
55           	<li>association-class</li>
56           	<li>result-class</li>
57           	<li>role</li>
58           	<li>result-role</li>
59           	<li>object-name - name of instance (or class) with which the instance 
60           	    (or class) has an association.</li>
61           	</ul>
62           
63               This class provides methods for inserting, modifying, finding, and deleting
64 mike  1.1     entries from the associators files.
65           */
66           class AssociatorsFile
67           {
68           public:
69           
70               /** Insert an entry into the given association file.
71               */
72               static Boolean insert(
73           	const String& path, 
74                   const String& assocClass,
75                   const String& resultClass,
76                   const String& role,
77                   const String& resultRole,
78           	const CIMReference& objectName);
79           
80           private:
81           
82               AssociatorsFile() { }
83           };
84           
85 mike  1.1 PEGASUS_NAMESPACE_END
86           
87           #endif /* Pegasus_AssociatorsFile_h */