Provides methods to manage dynamic resource variables, allowing resources for an activity to be updated when executing a job. More...
Public Member Functions | |
string | AddResource (string sessionId, ResourceIdentity resourceIdentity, string existingDynamicResourceXml) |
Adds the specified resource to existing dynamic resource variable XML (existing variable could be empty indicating we are adding the first resource to the variable XML). More... | |
string | AddResources (string sessionId, ResourceIdentityCollection resourceIdentityCollection, string existingDynamicResourceXml) |
Adds the specified resources to existing dynamic resource variable XML (existing variable could be empty indicating we are adding the first resources to the variable XML). More... | |
string | AddResourcesUsingJobRole (string sessionId, RoleIdentity roleIdentity, JobIdentity jobIdentity, string existingDynamicXml) |
Adds the specified role to existing dynamic resource variable XML (existing variable could be empty indicating we are adding the first role to the variable XML). More... | |
DynamicResourceInfo | DeleteResource (string sessionId, ResourceIdentity resourceIdentity, string existingDynamicResourceXml) |
Removes the specified resource from existing dynamic resource variable XML. More... | |
DynamicResourceInfo | DeleteResources (string sessionId, ResourceIdentityCollection resourceIdentityCollection, string existingDynamicXml) |
Removes the specified resources from existing dynamic resource variable XML. More... | |
int | GetNumberOfResources (string sessionId, string dynamicXml) |
Retrieves the number of resources present in the specified XML. More... | |
Provides methods to manage dynamic resource variables, allowing resources for an activity to be updated when executing a job.
string AddResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
string | existingDynamicResourceXml | ||
) |
Adds the specified resource to existing dynamic resource variable XML (existing variable could be empty indicating we are adding the first resource to the variable XML).
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity identity object indicates the resource we are adding to the dynamic resource variable XML. Cannot be null
| ||||||||||||||||
existingDynamicResourceXml | The existing dynamic resource XML. Could be empty if adding first resource |
string AddResources | ( | string | sessionId, |
ResourceIdentityCollection | resourceIdentityCollection, | ||
string | existingDynamicResourceXml | ||
) |
Adds the specified resources to existing dynamic resource variable XML (existing variable could be empty indicating we are adding the first resources to the variable XML).
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentityCollection | A collection of ResourceIdentity object that identify resources that are to be added to the dynamic resource variable XML. Cannot be null ResourceIdentity members.
| ||||||||||||||||
existingDynamicResourceXml | The existing dynamic resource in XML format. |
string AddResourcesUsingJobRole | ( | string | sessionId, |
RoleIdentity | roleIdentity, | ||
JobIdentity | jobIdentity, | ||
string | existingDynamicXml | ||
) |
Adds the specified role to existing dynamic resource variable XML (existing variable could be empty indicating we are adding the first role to the variable XML).
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
roleIdentity | A RoleIdentity identity object that is used to identify the role to add. Cannot be null
| ||||||||||||
jobIdentity | A JobIdentity identity object that is used to identify the job containing the role to be added. Cannot be null
| ||||||||||||
existingDynamicXml | The existing dynamic resource XML containing the resources/roles. |
DynamicResourceInfo DeleteResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
string | existingDynamicResourceXml | ||
) |
Removes the specified resource from existing dynamic resource variable XML.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity identity object indicates the resource we are removing from the dynamic resource variable XML. Cannot be null
| ||||||||||||||||
existingDynamicResourceXml | The existing dynamic resource XML. |
DynamicResourceInfo DeleteResources | ( | string | sessionId, |
ResourceIdentityCollection | resourceIdentityCollection, | ||
string | existingDynamicXml | ||
) |
Removes the specified resources from existing dynamic resource variable XML.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentityCollection | A collection of ResourceIdentity object that identify the resources that are to be removed from the dynamic resource variable XML. Cannot be null ResourceIdentity members.
| ||||||||||||||||
existingDynamicXml | The existing dynamic resources in XML format. |
int GetNumberOfResources | ( | string | sessionId, |
string | dynamicXml | ||
) |
Retrieves the number of resources present in the specified XML.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
dynamicXml | The dynamic resource XML containing the resources. |