com.ibm.optim.oaas.client.job.model

Interface JobCreationData

public interface JobCreationData

Job creation data used to initialize a new job associated with an application.

Method Summary

Methods

Modifier and Type	Method and Description
JobAttachmentCreationData	addJobAttachment(String name) Adds an input job attachment with a given name.
String	getApplicationId() Gets the ID of the application.
String	getApplicationVersion() Gets version of the application.
JobAttachment	getAttachment(String name) Gets an attachment to the job.
List<JobAttachmentCreationData>	getAttachments() Gets the attachments associated with creating the job.
String	getClientEmail() Returns the client email used to for notification.
String	getClientName() Returns the client name used to identify the client submitting this job.
JobParameters	getParameters() Gets the parameters associated with the job.
void	setApplicationId(String applicationId) Sets the application ID.
void	setApplicationVersion(String applicationVersion) Sets the version of the application.
void	setClientEmail(String email) Sets the client email address used for notification.
void	setClientName(String name) Sets the client name used to identify the client submitting this job.

Method Detail

getApplicationId

String getApplicationId()

Gets the ID of the application.

Returns:

The application ID.

setApplicationId

void setApplicationId(String applicationId)

Sets the application ID.

Parameters:

applicationId - The application ID.

getApplicationVersion

String getApplicationVersion()

Gets version of the application. Reserved for future use.

Returns:

The version of the application.

setApplicationVersion

void setApplicationVersion(String applicationVersion)

Sets the version of the application. Reserved for future use.

Parameters:

applicationVersion - Version of the application.

getParameters

JobParameters getParameters()

Gets the parameters associated with the job. A list of parameters can be specified, and the system parameters have a prefix of 'oaas', but any custom parameters or attributes can be specified so that the client can store and track custom context of the job.

Returns:

A map of parameters and values.

getAttachments

List<JobAttachmentCreationData> getAttachments()

Gets the attachments associated with creating the job.

Returns:

A list of job attachments.

See Also:

addJobAttachment(String)

setClientName

void setClientName(String name)

Sets the client name used to identify the client submitting this job. The client name may be used to distinguish between different clients using the same subscription.

Parameters:

name - The client name.

getClientName

String getClientName()

Returns the client name used to identify the client submitting this job.

Returns:

the client name

setClientEmail

void setClientEmail(String email)

Sets the client email address used for notification.

Parameters:

email - The client email.

getClientEmail

String getClientEmail()

Returns the client email used to for notification.

Returns:

the client email

addJobAttachment

JobAttachmentCreationData addJobAttachment(String name)

Adds an input job attachment with a given name.

Parameters:

name - The attachment name.

Returns:

The created attachment.

getAttachment

JobAttachment getAttachment(String name)

Gets an attachment to the job.

Parameters:

name - Name of attachment.

Returns:

The job attachment with the given name.