Package com.broadleafcommerce.common.messaging.domain

Class ScheduledJobRef

java.lang.Object

com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

public class ScheduledJobRef
extends Object

A reference to a ScheduledJob of the scheduled job microservice.

Author:

Chad Harchar (charchar)

Constructor Summary

Constructors

Constructor	Description
ScheduledJobRef()
ScheduledJobRef(String type, List<ScheduledJobDetailRef> detailRefs)
ScheduledJobRef(String type, List<ScheduledJobDetailRef> detailRefs, String tenantId)
ScheduledJobRef(String type, List<ScheduledJobDetailRef> detailRefs, String tenantId, Instant lastExecuted)
ScheduledJobRef(String type, List<ScheduledJobDetailRef> details, String tenantId, Instant lastExecuted, Map<String,Object> additionalParameters)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Object>	getAdditionalParameters()	Additional information that can be used to add parameters for the scheduled job listeners.
List<ScheduledJobDetailRef>	getDetails()
Instant	getLastExecuted()	The date on which the job last executed.
String	getTenantId()	The ID of the associated tenant.
String	getType()
int	hashCode()
void	setAdditionalParameters(Map<String,Object> additionalParameters)	Additional information that can be used to add parameters for the scheduled job listeners.
void	setDetails(List<ScheduledJobDetailRef> details)
void	setLastExecuted(Instant lastExecuted)	The date on which the job last executed.
void	setTenantId(String tenantId)	The ID of the associated tenant.
void	setType(String type)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScheduledJobRef

public ScheduledJobRef(String type,
                       List<ScheduledJobDetailRef> detailRefs)

ScheduledJobRef

public ScheduledJobRef(String type,
                       List<ScheduledJobDetailRef> detailRefs,
                       String tenantId)

ScheduledJobRef

public ScheduledJobRef(String type,
                       List<ScheduledJobDetailRef> detailRefs,
                       String tenantId,
                       Instant lastExecuted)

ScheduledJobRef

public ScheduledJobRef()

ScheduledJobRef

public ScheduledJobRef(String type,
                       List<ScheduledJobDetailRef> details,
                       String tenantId,
                       Instant lastExecuted,
                       Map<String,Object> additionalParameters)

Method Detail

getType

public String getType()

getDetails

public List<ScheduledJobDetailRef> getDetails()

getTenantId

public String getTenantId()

The ID of the associated tenant.

Returns:

ID of the associated tenant

getLastExecuted

public Instant getLastExecuted()

The date on which the job last executed.

Returns:

The date on which the job last executed.

getAdditionalParameters

public Map<String,Object> getAdditionalParameters()

Additional information that can be used to add parameters for the scheduled job listeners.

Returns:

the additional parameters for this job

setType

public void setType(String type)

setDetails

public void setDetails(List<ScheduledJobDetailRef> details)

setTenantId

public void setTenantId(String tenantId)

The ID of the associated tenant.

Parameters:

tenant - ID of the associated tenant

setLastExecuted

public void setLastExecuted(Instant lastExecuted)

The date on which the job last executed.

Parameters:

lastExecuted - The date on which the job last executed.

setAdditionalParameters

public void setAdditionalParameters(Map<String,Object> additionalParameters)

Additional information that can be used to add parameters for the scheduled job listeners.

Parameters:

additionalParameters - the additional parameters for this job

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object