Merge remote-tracking branch 'upstream/4.3' into 4.3-4.4-2013-11-03-17-29-16
[civicrm-core.git] / xml / schema / Member / MembershipStatus.xml
1 <?xml version="1.0" encoding="iso-8859-1" ?>
2
3 <table>
4 <base>CRM/Member</base>
5 <class>MembershipStatus</class>
6 <name>civicrm_membership_status</name>
7 <comment>Membership Status stores admin configurable rules for assigning status to memberships.</comment>
8 <add>1.5</add>
9 <log>true</log>
10 <field>
11 <name>id</name>
12 <type>int unsigned</type>
13 <required>true</required>
14 <comment>Membership Id</comment>
15 <add>1.5</add>
16 </field>
17 <primaryKey>
18 <name>id</name>
19 <autoincrement>true</autoincrement>
20 </primaryKey>
21 <field>
22 <name>name</name>
23 <uniqueName>membership_status</uniqueName>
24 <title>Membership Status</title>
25 <type>varchar</type>
26 <import>true</import>
27 <length>128</length>
28 <comment>Name for Membership Status</comment>
29 <add>1.5</add>
30 </field>
31 <field>
32 <name>label</name>
33 <type>varchar</type>
34 <length>128</length>
35 <localizable>true</localizable>
36 <comment>Label for Membership Status</comment>
37 <add>3.2</add>
38 </field>
39 <field>
40 <name>start_event</name>
41 <type>enum</type>
42 <values>start_date, end_date, join_date</values>
43 <comment>Event when this status starts.</comment>
44 <add>1.5</add>
45 </field>
46 <field>
47 <name>start_event_adjust_unit</name>
48 <type>enum</type>
49 <values>day, month, year</values>
50 <comment>Unit used for adjusting from start_event.</comment>
51 <add>1.5</add>
52 </field>
53 <field>
54 <name>start_event_adjust_interval</name>
55 <type>int</type>
56 <comment>Status range begins this many units from start_event.</comment>
57 <add>1.5</add>
58 </field>
59 <field>
60 <name>end_event</name>
61 <type>enum</type>
62 <values>start_date, end_date, join_date</values>
63 <comment>Event after which this status ends.</comment>
64 <add>1.5</add>
65 </field>
66 <field>
67 <name>end_event_adjust_unit</name>
68 <type>enum</type>
69 <values>day, month, year</values>
70 <comment>Unit used for adjusting from the ending event.</comment>
71 <add>1.5</add>
72 </field>
73 <field>
74 <name>end_event_adjust_interval</name>
75 <type>int</type>
76 <comment>Status range ends this many units from end_event.</comment>
77 <add>1.5</add>
78 </field>
79 <field>
80 <name>is_current_member</name>
81 <title>Current Membership?</title>
82 <type>boolean</type>
83 <comment>Does this status aggregate to current members (e.g. New, Renewed, Grace might all be TRUE... while Unrenewed, Lapsed, Inactive would be FALSE).</comment>
84 <add>1.5</add>
85 </field>
86 <field>
87 <name>is_admin</name>
88 <title>Admin Assigned Only?</title>
89 <type>boolean</type>
90 <comment>Is this status for admin/manual assignment only.</comment>
91 <add>1.5</add>
92 </field>
93 <field>
94 <name>weight</name>
95 <title>Weight</title>
96 <type>int</type>
97 <add>1.5</add>
98 </field>
99 <field>
100 <name>is_default</name>
101 <title>Default Status?</title>
102 <type>boolean</type>
103 <comment>Assign this status to a membership record if no other status match is found.</comment>
104 <add>1.5</add>
105 </field>
106 <field>
107 <name>is_active</name>
108 <title>Is Active</title>
109 <type>boolean</type>
110 <default>1</default>
111 <comment>Is this membership_status enabled.</comment>
112 <add>1.5</add>
113 </field>
114 <field>
115 <name>is_reserved</name>
116 <title>Is Reserved</title>
117 <type>boolean</type>
118 <default>0</default>
119 <comment>Is this membership_status reserved.</comment>
120 <add>2.1</add>
121 </field>
122 </table>