426 Getting Started with Tivoli Dynamic Workload Broker Version 1.1
DeleteJobDefinition
Example 9-20 contains the type definitions for the deleteJobDefinition operation.
This operation deletes existing job definitions.
Example 9-20 Type definitions for deleteJobDefinition operation
<xsd:element name="deleteJobDefinition">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Name" type="xsd:QName" minOccurs="1" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="deleteJobDefinitionResponse">
<xsd:complexType>
<xsd:sequence />
</xsd:complexType>
</xsd:element>
The DeleteJobDefinition type consists of Name, the name of the JobDefinition
(for instance, the job name) to be deleted. It is a QName, then it is of the form
"namespace:jobname". Nevertheless, namespaces different from the empty
strings are not supported, so it should be the job name only.
Querying the job definitions
In this section we describe the operations for querying the job definitions.
The queryJobDefinitions operation queries the job definitions stored in the server
job repository.
QueryJobDefinitions
This type describes all parameters passed to the queryJobDefinition operation.
This operation queries existing job definitions.
Chapter 9. Interacting with Tivoli Dynamic Workload Broker using the Web services interface 427
Example 9-21 contains the type definitions for the queryJobDefinitions operation.
Example 9-21 Type definitions for queryJobDefinitions operation
<xsd:element name="queryJobDefinitions">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="NameFilter" type="xsd:string" minOccurs="0"
maxOccurs="1" />
<xsd:element name="TargetNamespaceFilter" type="xsd:string" minOccurs="0"
maxOccurs="1" />
<xsd:element name="DescriptionFilter" type="xsd:string" minOccurs="0"
maxOccurs="1" />
<xsd:element name="UserFilter" type="xsd:string" minOccurs="0"
maxOccurs="1" />
<xsd:element name="HowMany" type="xsd:int" minOccurs="0" maxOccurs="1" />
<xsd:element name="Iterator" type="xsd:string" minOccurs="0"
maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
The QueryJobDefinition type consists of:
򐂰 Name Filter - the filter on job names. This filter supports wildcards.
򐂰 Target Namespace Filter - the filter on job target namespaces. This filter
supports wildcards. This is
not Supported for NOW™.
򐂰 Description Filter - the filter on job descriptions. This filter supports wildcards.
򐂰 User Filter - This filter matches all job created by the specified user. This filter
supports wildcards.
򐂰 HowMany - the number of maximum job definitions that the query should
return in one invocation. Note that if the number of job definitions matching
the filter criteria is greater than this number then an iterator is returned and it
can be used to retrieve all other jobs not returned back.
򐂰 Iterator - an identifier used by the Tivoli Dynamic Workload Broker server to
query the remaining job definitions matching the criteria and exceeding the
HowMany parameter.
428 Getting Started with Tivoli Dynamic Workload Broker Version 1.1
QueryJobDefinitionProperties
Example 9-22 contains the type definitions describing all job definition attributes
returned by the query operation.
Example 9-22 Type definitions for QueryJobDefinitionPropertiesType
<xsd:complexType name="QueryJobDefinitionPropertiesType">
<xsd:sequence>
<xsd:element name="Name" type="xsd:QName" minOccurs="1" maxOccurs="1" />
<xsd:element name="Description" type="xsd:string" minOccurs="1" maxOccurs="1" />
<xsd:element name="Owner" nillable="true" type="xsd:string" minOccurs="1"
maxOccurs="1" />
<xsd:element name="CreationTime" type="xsd:dateTime" minOccurs="1"
maxOccurs="1" />
<xsd:element name="ModificationTime" type="xsd:dateTime" minOccurs="1"
maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
The QueryJobDefinitionProperties consists of:
򐂰 Name - the job definition name.
򐂰 Description - the job definition description.
򐂰 Owner - the job definition creator.
򐂰 Creation Time - the job definition creation time.
򐂰 Modification Time - the job definition modification time.
QueryJobDefinitionsResponse
Example 9-23 contains the type definitions describing all parameters returned by
the query operation.
Example 9-23 Type definitions for response to query operation
<xsd:element name="queryJobDefinitionsResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="JobDefinitionProperties"
type="jdm:QueryJobDefinitionPropertiesType" minOccurs="0"
maxOccurs="unbounded" />
<xsd:element name="Iterator" type="xsd:string" minOccurs="0"
maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Chapter 9. Interacting with Tivoli Dynamic Workload Broker using the Web services interface 429
The QueryJobDefinitionsResponse consists of:
򐂰 Job Properties - the set of job definitions matching the filter criteria
򐂰 Iterator - the iterator to be used in case there are more job definitions
matching the requirements than requested with HowMany
Getting the job definition
In this section we describe the operations for getting the job definition.
The getJobDefinition interface gets the job definition in the server job repository.
GetJobDefinition
Example 9-24 contains the type definitions for the getJobDefinition operation.
This operation gets an existing job definition.
Example 9-24 Type definitions for getJobDefinition operation
<xsd:element name="getJobDefinition">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Name" type="xsd:QName" minOccurs="1" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
The GetJobDefinition type consists of Name, the name of the requested job
definition.
GetJobDefinitionResponse
Example 9-25 contains the type definitions for the response to the
getJobDefinitionResponse operation.
Example 9-25 Type definitions for response to getJobDefinition operation
<xsd:element name="getJobDefinitionResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="JobDefinition" type="jsdl:JobDefinitionType"
minOccurs="1" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
The GetJobDefinitionResponse type consists of Job Definition, the requested job
definition.

Get Getting Started with Tivoli Dynamic Workload Broker Version 1.1 now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.