Package dev.getelements.elements.sdk.dao

Interface ElementDeploymentDao

All Known Implementing Classes:

MongoElementDeploymentDao

public interface ElementDeploymentDao

Provides access to ElementDeployment instances in the database.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELEMENT_DEPLOYMENT_CREATED
static final String	ELEMENT_DEPLOYMENT_DELETED
static final String	ELEMENT_DEPLOYMENT_UPDATED

Method Summary

Modifier and Type	Method	Description
ElementDeployment	createElementDeployment(ElementDeployment elementDeployment)	Creates a new ElementDeployment.
void	deleteDeployment(String deploymentId)	Deletes the ElementDeployment with the supplied id.
Optional<ElementDeployment>	findElementDeployment(String deploymentId)	Finds the ElementDeployment with the supplied deployment ID.
default ElementDeployment	getElementDeployment(String deploymentId)	Gets the ElementDeployment with the supplied deployment ID.
Pagination<ElementDeployment>	getElementDeployments(int offset, int count, String search)	Gets all deployments with offset, count, and search query.
List<ElementDeployment>	getElementDeploymentsByState(ElementDeploymentState state)	Gets all ElementDeployment instances with the specified state.
ElementDeployment	updateElementDeployment(ElementDeployment elementDeployment)	Updates an ElementDeployment.

Field Details

ELEMENT_DEPLOYMENT_CREATED

static final String ELEMENT_DEPLOYMENT_CREATED

See Also:

• Constant Field Values

ELEMENT_DEPLOYMENT_UPDATED

static final String ELEMENT_DEPLOYMENT_UPDATED

See Also:

• Constant Field Values

ELEMENT_DEPLOYMENT_DELETED

static final String ELEMENT_DEPLOYMENT_DELETED

See Also:

• Constant Field Values

Method Details

createElementDeployment

ElementDeployment createElementDeployment(ElementDeployment elementDeployment)

Creates a new ElementDeployment.

Parameters:

elementDeployment - the ElementDeployment

Returns:

the ElementDeployment as written to the database

getElementDeployments

Pagination<ElementDeployment> getElementDeployments(int offset,
 int count,
 String search)

Gets all deployments with offset, count, and search query.

Parameters:

offset - the offset

count - the count

search - the search

Returns:

the Pagination of ElementDeployment instances

findElementDeployment

Optional<ElementDeployment> findElementDeployment(String deploymentId)

Finds the ElementDeployment with the supplied deployment ID.

Parameters:

deploymentId - the deployment ID

Returns:

an Optional<ElementDeployment>

getElementDeployment

default ElementDeployment getElementDeployment(String deploymentId)

Gets the ElementDeployment with the supplied deployment ID.

Parameters:

deploymentId - the deployment ID

Returns:

the ElementDeployment, never null

Throws:

ElementDeploymentNotFoundException - if not found

updateElementDeployment

ElementDeployment updateElementDeployment(ElementDeployment elementDeployment)

Updates an ElementDeployment. Note this must implicitly update the ElementDeployment.version() value incrementing by one for every successful modification.

Parameters:

elementDeployment - the deployment

Returns:

the updated deployment

deleteDeployment

void deleteDeployment(String deploymentId)

Deletes the ElementDeployment with the supplied id.

Parameters:

deploymentId - the deployment ID

getElementDeploymentsByState

List<ElementDeployment> getElementDeploymentsByState(ElementDeploymentState state)

Gets all ElementDeployment instances with the specified state.

Parameters:

state - the state to filter by

Returns:

list of deployments in that state