element XmlPushDestination
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p65.png
namespace http://orgmodel.api.de.bpm.tibco.com
properties
content complex
children value
used by
complexType XmlPushDestinationList
attributes
Name  Type  Use  Default  Fixed  Annotation
name  xs:string  required      
documentation
Unique name of this 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).
desc-guid  xs:string  optional      
documentation
Unique ID of a prameter descriptor 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 below, the value of this element will be used.
annotation
documentation
Definition of a push destination. When using these XML elements to set a push destination, if both the "desc-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 desc-guid parameter 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:element name="XmlPushDestination">
 
<xs:annotation>
   
<xs:documentation>Definition of a push destination. When using these XML elements to set a push destination, if both the "desc-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 desc-guid parameter 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:complexType>
   
<xs:choice>
     
<xs:element name="value" type="xs:string" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs:documentation>Value to be used for this push destination.

For a:

- setPushDestinations operation, this value is only used if no desc-guid attribute is supplied.

- getPushDestinations operation, this value is the current value of the desc-guid attribute.
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:choice>
   
<xs:attribute name="name" type="xs:string" use="required">
     
<xs:annotation>
       
<xs:documentation>Unique name of this push destination.</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
   
<xs:attribute name="channel-type" type="channel:ChannelType" use="required">
     
<xs:annotation>
       
<xs:documentation>Enumerated type defining the presentation technology used by the channel associated with this push destination.</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
   
<xs:attribute name="channel-id" type="xs:string" use="required">
     
<xs:annotation>
       
<xs:documentation>Unique ID of the channel associated with this push destination.</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
   
<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="desc-guid" type="xs:string" use="optional">
     
<xs:annotation>
       
<xs:documentation>Unique ID of a prameter descriptor 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 below, the value of this element will be used.
</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
 
</xs:complexType>
</xs:element>

attribute XmlPushDestination/@name
type xs:string
properties
use required
annotation
documentation
Unique name of this push destination.
source <xs:attribute name="name" type="xs:string" use="required">
 
<xs:annotation>
   
<xs:documentation>Unique name of this push destination.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute XmlPushDestination/@channel-type
type ChannelType
properties
use required
facets
Kind Value Annotation
enumeration JSPChannel
enumeration GIChannel
enumeration PageflowChannel
enumeration EmailChannel
enumeration RssChannel
enumeration openspaceChannel
enumeration MobileChannel
annotation
documentation
Enumerated type defining the presentation technology used by the channel associated with this push destination.
source <xs:attribute name="channel-type" type="channel:ChannelType" use="required">
 
<xs:annotation>
   
<xs:documentation>Enumerated type defining the presentation technology used by the channel associated with this push destination.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute XmlPushDestination/@channel-id
type xs:string
properties
use required
annotation
documentation
Unique ID of the channel associated with this push destination.
source <xs:attribute name="channel-id" type="xs:string" use="required">
 
<xs:annotation>
   
<xs:documentation>Unique ID of the channel associated with this push destination.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

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/@desc-guid
type xs:string
properties
use optional
annotation
documentation
Unique ID of a prameter descriptor 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 below, the value of this element will be used.
source <xs:attribute name="desc-guid" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>Unique ID of a prameter descriptor 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 below, the value of this element will be used.
</xs:documentation>
 
</xs:annotation>
</xs:attribute>

element XmlPushDestination/value
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p66.png
type xs:string
properties
minOcc 1
maxOcc unbounded
content simple
annotation
documentation
Value to be used for this push destination.

For a:

- setPushDestinations operation, this value is only used if no desc-guid attribute is supplied.

- getPushDestinations operation, this value is the current value of the desc-guid attribute.
source <xs:element name="value" type="xs:string" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs:documentation>Value to be used for this push destination.

For a:

- setPushDestinations operation, this value is only used if no desc-guid attribute is supplied.

- getPushDestinations operation, this value is the current value of the desc-guid attribute.
</xs:documentation>
 
</xs:annotation>
</xs:element>


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