view release on metacpan or  search on metacpan

share/AXLSoap.xsd  view on Meta::CPAN

			<xsd:element name="name" type="axlapi:XKeyString"/>
			<xsd:element name="description" type="xsd:string" minOccurs="0"/>
			<xsd:element name="author" type="xsd:Name" minOccurs="0"/>
			<xsd:element name="rules">
				<xsd:complexType>
					<xsd:sequence>
						<xsd:element name="rule" type="axlapi:XRule" maxOccurs="unbounded"/>
					</xsd:sequence>
				</xsd:complexType>
			</xsd:element>
		</xsd:sequence>
	</xsd:complexType>
	<xsd:complexType name="XRule">
		<xsd:annotation>
			<xsd:documentation>The root of all rules.</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="name" nillable="false">
				<xsd:annotation>
					<xsd:documentation>The URI name of the  rule. For example: xmlrule://cisco.com/public/isAnInteger</xsd:documentation>
				</xsd:annotation>
				<xsd:simpleType>
					<xsd:restriction base="xsd:string">
						<xsd:pattern value="xmlrule://\S+"/>
					</xsd:restriction>
				</xsd:simpleType>
			</xsd:element>
			<xsd:element name="description" type="xsd:string" minOccurs="0"/>
			<xsd:element name="author" type="xsd:string" minOccurs="0"/>
			<xsd:choice>
				<xsd:annotation>
					<xsd:documentation>The "type" choice.</xsd:documentation>
				</xsd:annotation>
				<xsd:element name="boolean" type="axlapi:XBooleanRule">
					<xsd:annotation>
						<xsd:documentation>The input must be a boolean.</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="date" type="axlapi:XDateRule">
					<xsd:annotation>
						<xsd:documentation>The input must conform to a valid date format.</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="float" type="axlapi:XFloatRule">
					<xsd:annotation>
						<xsd:documentation>The input must be a floating-point number.</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="integer" type="axlapi:XIntegerRule">
					<xsd:annotation>
						<xsd:documentation>The input must be an integer.</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="list" type="axlapi:XListRule">
					<xsd:annotation>
						<xsd:documentation>The input is a single key compared to a list.</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="script" type="axlapi:XScriptRule">
					<xsd:annotation>
						<xsd:documentation>Execute a Javascript fragment.</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="string" type="axlapi:XStringRule">
					<xsd:annotation>
						<xsd:documentation>The input must be a string (least restrictive).</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="uri" type="axlapi:XURIRule">
					<xsd:annotation>
						<xsd:documentation>The input must conform to a valid URI format.</xsd:documentation>
					</xsd:annotation>
				</xsd:element>
				<xsd:element name="dynamicList" type="axlapi:XDynamicListRule"/>
			</xsd:choice>
			<xsd:element name="nullable" type="xsd:boolean" nillable="false" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>Is a null value acceptable for this rule?</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="subrule" type="axlapi:XRule" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>It is possible that a rule might require additional steps of validation. To guard against loops, these subrules must be defined within this rule rather than allowing the rule to reference other rules (however, see XDisplayInst...
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="enterpriseDefaultName" type="axlapi:XKeyString" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>The name of the enterprise parameter to lookup in the database and use its value as this rule's default value. Overrides the hard-coded default if defined.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
		</xsd:sequence>
	</xsd:complexType>
	<xsd:complexType name="XIntegerRule">
		<xsd:annotation>
			<xsd:documentation>The integer rule determines if the input is a valid integer.</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="default" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>What is the default value if none is supplied? Can either be a decimal or hexadecimal value.</xsd:documentation>
				</xsd:annotation>
				<xsd:simpleType>
					<xsd:restriction base="xsd:string">
						<xsd:pattern value="((0x[0\-9a\-fA\-F]+)|([\-\d]\d*))*"/>
					</xsd:restriction>
				</xsd:simpleType>
			</xsd:element>
			<xsd:element name="min" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>What is the minimum acceptable value?</xsd:documentation>
				</xsd:annotation>
				<xsd:simpleType>
					<xsd:restriction base="xsd:string">
						<xsd:pattern value="((0x[0\-9a\-fA\-F]+)|([\-\d]\d*))*"/>
					</xsd:restriction>
				</xsd:simpleType>
			</xsd:element>
			<xsd:element name="max" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>What is the maximum acceptable value?</xsd:documentation>
				</xsd:annotation>

share/AXLSoap.xsd  view on Meta::CPAN

		<xsd:sequence>
			<xsd:element name="defaultKey" type="xsd:string" minOccurs="0"/>
			<xsd:element name="tableName" type="axlapi:Name50" nillable="false"/>
			<xsd:element name="keyFieldName">
				<xsd:complexType>
					<xsd:choice>
						<xsd:element name="integerFieldName" type="axlapi:Name50"/>
						<xsd:element name="stringFieldName" type="axlapi:Name50"/>
					</xsd:choice>
				</xsd:complexType>
			</xsd:element>
			<xsd:element name="descFieldName" type="axlapi:Name50"/>
			<xsd:element name="Multikey" type="xsd:boolean"/>
			<xsd:element name="filter" type="xsd:string" minOccurs="0"/>
		</xsd:sequence>
	</xsd:complexType>
	<xsd:complexType name="XDateRule">
		<xsd:annotation>
			<xsd:documentation>Directs the rule processor to validate the input as a date. Valid date formats are Any, Long (March 15, 2001), Short-US (the default, 03/15/01), and Short-EU (15/03/01).</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="dateFormat" default="Short-US" minOccurs="0">
				<xsd:simpleType>
					<xsd:restriction base="xsd:string">
						<xsd:enumeration value="Any"/>
						<xsd:enumeration value="Long"/>
						<xsd:enumeration value="Short-US"/>
						<xsd:enumeration value="Short-EU"/>
					</xsd:restriction>
				</xsd:simpleType>
			</xsd:element>
			<xsd:choice minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>The default is either a specific date (default), or automatically defaulted to today (defaultNow).</xsd:documentation>
				</xsd:annotation>
				<xsd:element name="default" type="xsd:date"/>
				<xsd:element name="defaultNow" type="xsd:boolean"/>
			</xsd:choice>
			<xsd:element name="min" type="xsd:date" minOccurs="0"/>
			<xsd:element name="max" type="xsd:date" minOccurs="0"/>
			<xsd:element name="restrictTo" minOccurs="0">
				<xsd:annotation>
					<xsd:documentation>Should the rule make sure that the date is not in the future?</xsd:documentation>
				</xsd:annotation>
				<xsd:simpleType>
					<xsd:restriction base="xsd:string">
						<xsd:enumeration value="Past"/>
						<xsd:enumeration value="Future"/>
					</xsd:restriction>
				</xsd:simpleType>
			</xsd:element>
		</xsd:sequence>
	</xsd:complexType>
	<xsd:complexType name="XBooleanRule">
		<xsd:sequence>
			<xsd:element name="default" type="xsd:boolean"/>
		</xsd:sequence>
	</xsd:complexType>
	<xsd:complexType name="XScriptRule">
		<xsd:annotation>
			<xsd:documentation>The input is evaluated by a fragment of JavaScript.</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="comment" type="xsd:string"/>
			<xsd:element name="script">
				<xsd:annotation>
					<xsd:documentation>The JavaScript fragment used to evaluate the input. The fragment should be cordoned off by CDATA tags. The fragment must contain a entry-point function with the following prototype:

Array AXLScriptRuleEntryPoint(String inputString)

The output is an Array of two values. Array[0] is a boolean value and indicates success (true) or failure (false). Array[1] contains the result of the script. If successful, it should contain a copy of the inputString or other valid return value. If ...
</xsd:documentation>
				</xsd:annotation>
				<xsd:simpleType>
					<xsd:restriction base="xsd:string">
						<xsd:whiteSpace value="preserve"/>
					</xsd:restriction>
				</xsd:simpleType>
			</xsd:element>
		</xsd:sequence>
	</xsd:complexType>
	<xsd:complexType name="XURIRule">
		<xsd:annotation>
			<xsd:documentation>The URI rule determines if a value is a valid URI.</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="default" type="xsd:anyURI" minOccurs="0"/>
		</xsd:sequence>
	</xsd:complexType>
	<xsd:complexType name="XRuleError">
		<xsd:annotation>
			<xsd:documentation>The XML format for a rule error that might be thrown by a rule processor.</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="invalidValue" type="xsd:string">
				<xsd:annotation>
					<xsd:documentation>Contains the value of the original input.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="ruleBroken" type="xsd:Name">
				<xsd:annotation>
					<xsd:documentation>The name of the rule broken.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="errorCode" type="xsd:integer" default="0">
				<xsd:annotation>
					<xsd:documentation>An integer error code.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
			<xsd:element name="errorText" type="xsd:string">
				<xsd:annotation>
					<xsd:documentation>Error message generated by rule.</xsd:documentation>
				</xsd:annotation>
			</xsd:element>
		</xsd:sequence>
	</xsd:complexType>
	<!-- *********************************************************** -->
	<!-- Service Dependency objects                                 -->
	<!-- *********************************************************** -->
	<xsd:complexType name="XServiceDependency">
		<xsd:annotation>
			<xsd:documentation>This lists what services that the specified service is dependent on.</xsd:documentation>
		</xsd:annotation>
		<xsd:sequence>
			<xsd:element name="name" type="xsd:anyURI">
				<xsd:annotation>
					<xsd:documentation>The URI of this service dependency. For example: xmldi://cisco.com/serviceDependency/0.  The last part of the URI is the enum value of this service.</xsd:documentation>