complexType XmlPushDestination

diagram |
namespace | http://base.api.de.bpm.tibco.com
type | extension of XmlPushDestinationId
properties |
base | XmlPushDestinationId
children | value
used by |
elements | XmlResourceDetail/push-destination XmlGroup/push-destination XmlBasePosition/push-destination XmlBaseOrgUnit/push-destination XmlOrganization/push-destination XmlUpdatePushDestinations/set-destination
attributes |
Name | Type | Use | Default | Fixed | Annotation
name | xs:string | required |  |  |
documentation
The name of the push destination.
channel-type | ChannelType | required |  |  |
documentation
Enumerated type defining the presentation technology used by the channel associated with this push destination.
channel-id | xs:string | required |  |  |
documentation
Unique ID of the channel associated with this push destination.
enabled | xs:boolean | required |  |  |
documentation
Boolean value indicating whether this push destination is currently enabled (TRUE) or not (FALSE).
resource-attr-guid | xs:string | optional |  |  |
documentation
Unique ID of a resource attribute whose value should be used for the push destination. The parameter descriptor must be assigned to the organization model entity for whom the push destination is being set. If a value is assigned to both this attribute and the "value" element, the value of this attribute will be used.
annotation |
documentation
Definition of a push destination. When using these XML elements to set a push destination, if both the "resource-attr-guid" attribute and "value" elements are specified, the "value" elements will be ignored. The value elements are used to pass the values of the push destination. If the push destination: - retrieves its value from an LDAP attribute (via a resource-attr-guid arameter descriptor) it can hold multiple values, so the value element can occur several times. - does not take its value from an LDAP attribute, it can hold only one value. If multiple values are given when setting the push destination, only the first value is recorded.
source | <xs:complexType name="XmlPushDestination"> <xs:annotation> <xs:documentation>Definition of a push destination. When using these XML elements to set a push destination, if both the "resource-attr-guid" attribute and "value" elements are specified, the "value" elements will be ignored. The value elements are used to pass the values of the push destination. If the push destination: - retrieves its value from an LDAP attribute (via a resource-attr-guid arameter descriptor) it can hold multiple values, so the value element can occur several times. - does not take its value from an LDAP attribute, it can hold only one value. If multiple values are given when setting the push destination, only the first value is recorded.</xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="XmlPushDestinationId"> <xs:sequence> <xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Value to be used for this push destination. When setting a push destination, this value is only used if no resource-attr-guid attribute is supplied. When reading a push destination, this is the explicit value or the value(s) held by the Resource attribute identified by the resource-attr-guid attribute.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="enabled" type="xs:boolean" use="required"> <xs:annotation> <xs:documentation>Boolean value indicating whether this push destination is currently enabled (TRUE) or not (FALSE).</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="resource-attr-guid" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>Unique ID of a resource attribute whose value should be used for the push destination. The parameter descriptor must be assigned to the organization model entity for whom the push destination is being set. If a value is assigned to both this attribute and the "value" element, the value of this attribute will be used.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType>

attribute XmlPushDestination/@enabled

type | xs:boolean
properties |
use | required
annotation |
documentation
Boolean value indicating whether this push destination is currently enabled (TRUE) or not (FALSE).
source | <xs:attribute name="enabled" type="xs:boolean" use="required"> <xs:annotation> <xs:documentation>Boolean value indicating whether this push destination is currently enabled (TRUE) or not (FALSE).</xs:documentation> </xs:annotation> </xs:attribute>

attribute XmlPushDestination/@resource-attr-guid

type | xs:string
properties |
use | optional
annotation |
documentation
Unique ID of a resource attribute whose value should be used for the push destination. The parameter descriptor must be assigned to the organization model entity for whom the push destination is being set. If a value is assigned to both this attribute and the "value" element, the value of this attribute will be used.
source | <xs:attribute name="resource-attr-guid" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>Unique ID of a resource attribute whose value should be used for the push destination. The parameter descriptor must be assigned to the organization model entity for whom the push destination is being set. If a value is assigned to both this attribute and the "value" element, the value of this attribute will be used.</xs:documentation> </xs:annotation> </xs:attribute>

element XmlPushDestination/value

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | unbounded
content | simple
annotation |
documentation
Value to be used for this push destination. When setting a push destination, this value is only used if no resource-attr-guid attribute is supplied. When reading a push destination, this is the explicit value or the value(s) held by the Resource attribute identified by the resource-attr-guid attribute.
source | <xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Value to be used for this push destination. When setting a push destination, this value is only used if no resource-attr-guid attribute is supplied. When reading a push destination, this is the explicit value or the value(s) held by the Resource attribute identified by the resource-attr-guid attribute.</xs:documentation> </xs:annotation> </xs:element>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy