com.edorasware.api.workobject

Interface WorkObjectBuilder

All Superinterfaces:

WorkObjectValueSetters<WorkObjectBuilder>

public interface WorkObjectBuilder
extends WorkObjectValueSetters<WorkObjectBuilder>

Defines the functionality of a work object builder.

In addition to the normal value setting methods, a work object builder also provides convenience methods to set fields that will be read-only once the work object instance has been persisted.

Method Summary

Modifier and Type	Method and Description
WorkObject	build() Builds the work object defined by the builder.
WorkObjectBuilder	definitionId(String definitionId) Sets the work object definition ID.
WorkObjectBuilder	externalId(String externalId) Sets the work object external ID.
WorkObjectBuilder	globalId(String globalId) Sets the work object global ID.
WorkObjectBuilder	id(String id) Sets the work object ID.
WorkObjectBuilder	path(List<String> path) Sets the work object path.
WorkObjectBuilder	providerId(String providerId) Sets the work object provider ID.
WorkObjectBuilder	tenantId(String tenantId) Sets the work object ID.
WorkObjectBuilder	type(String type) Sets the work object type.

Methods inherited from interface com.edorasware.api.workobject.WorkObjectValueSetters

assignedGroupId, assigneeId, candidateGroupIds, candidateUserIds, delete, delete, description, dueTime, name, ownerId, priority, resubmissionTime, state, subState, value, value, values

Method Detail

type

WorkObjectBuilder type(String type)

Sets the work object type.

Parameters:

type - the new work object type

Returns:

the builder

Throws:

IllegalStateException - if the work object has already been persisted

id

WorkObjectBuilder id(String id)

Sets the work object ID.

Parameters:

id - the new work object ID

Returns:

the builder

Throws:

IllegalStateException - if the work object has already been persisted

tenantId

WorkObjectBuilder tenantId(String tenantId)

Sets the work object ID.

Parameters:

tenantId - the new work object tenant ID

Returns:

the builder

Throws:

IllegalStateException - if the work object has already been persisted

providerId

WorkObjectBuilder providerId(String providerId)

Sets the work object provider ID.

Parameters:

providerId - the new work object provider ID

Returns:

the builder

Throws:

IllegalStateException - if the work object has already been persisted

externalId

WorkObjectBuilder externalId(String externalId)

Sets the work object external ID.

Parameters:

externalId - the new work object external ID

Returns:

the builder

Throws:

IllegalStateException - if the work object has already been persisted

path

WorkObjectBuilder path(List<String> path)

Sets the work object path.

This method should only be used when creating temporary in-memory work objects. For persisted work objects you should create the work object without a path and specify the parent work object ID when the work object is persisted (which will set the path correctly).

Parameters:

path - the new path

Returns:

the builder

Throws:

IllegalStateException - if the work object has already been persisted

definitionId

WorkObjectBuilder definitionId(String definitionId)

Sets the work object definition ID.

Parameters:

definitionId - the new work object definition ID

Returns:

the builder

Throws:

IllegalStateException - if the work object has already been persisted

globalId

WorkObjectBuilder globalId(String globalId)

Sets the work object global ID.

Parameters:

globalId - the new work object global ID

Returns:

the builder

Throws:

IllegalStateException - if the work object has already been persisted

build

WorkObject build()

Builds the work object defined by the builder.

Returns:

the work object