lumis.portal.deployment.process

Interface IDeployObject

All Superinterfaces:

Serializable

All Known Implementing Classes:

BusinessContextObject, ComponentObject, EntityObject, ModuleObject, ServiceObject

public interface IDeployObject
extends Serializable

Represents a deployment object.

Since:

8.1.0

Version:

$Revision: 21076 $ $Date: 2018-03-27 17:34:24 +0000 (Tue, 27 Mar 2018) $

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDeployObject.ObjectType Object type.

Method Summary

Modifier and Type	Method and Description
boolean	accumulateChecksum() Indicates whether the checksum of this object should accumulate the subtree.
Collection<IDeployObject>	find(IDeployObject.ObjectType type, EnumSet<IDeployObject.ObjectType> allowedInnerObjects) Find all objects of the given type in subtree, but discards subtrees when their root type is not contained in the given set.
IDeployObject	find(String id, IDeployObject.ObjectType objectType, EnumSet<IDeployObject.ObjectType> allowedInnerObjects) Finds the object with the given identifier of the given type in subtree.
String	getChecksum() Returns the checksum of this object.
<T extends lumis.portal.deployment.process.IChecksumListener> T	getChecksumListener() Returns the checksum listener of this object.
String	getId() Returns the identifier of this object.
Collection<IDeployObject>	getInnerObjects() Returns a collection with the inner objects.
IDeployObject.ObjectType	getType() Returns the type of this object.
boolean	isStoreChecksum() Indicates whether the checksum of this object should be stored.
IDeployObject	setChecksum(String checksum) Sets the checksum of this object.
<T extends lumis.portal.deployment.process.IChecksumListener> IDeployObject	setChecksumListener(T listener) Sets the checksum listener of this object.
IDeployObject	setId(String id) Sets the identifier of this object.
IDeployObject	setStoreChecksum(boolean isStoreChecksum) Sets whether the checksum of this object should be stored.

Method Detail

getId

String getId()

Returns the identifier of this object.

Returns:

the identifier of this object.

Since:

8.1.0

setId

IDeployObject setId(String id)

Sets the identifier of this object.

Parameters:

id - the identifier of this object.

Returns:

this object.

Since:

8.1.0

getInnerObjects

Collection<IDeployObject> getInnerObjects()

Returns a collection with the inner objects.

Returns:

a collection with the inner objects.

Since:

8.1.0

getType

IDeployObject.ObjectType getType()

Returns the type of this object.

Returns:

the type of this object.

Since:

8.1.0

getChecksum

String getChecksum()

Returns the checksum of this object.

Returns:

the checksum of this object.

Since:

8.1.0

setChecksum

IDeployObject setChecksum(String checksum)

Sets the checksum of this object.

Parameters:

checksum - the checksum of this object.

Returns:

this object.

Since:

8.1.0

setChecksumListener

<T extends lumis.portal.deployment.process.IChecksumListener> IDeployObject setChecksumListener(T listener)

Sets the checksum listener of this object.

Parameters:

listener - the checksum listener of this object.

Returns:

this object.

Since:

8.1.0

getChecksumListener

<T extends lumis.portal.deployment.process.IChecksumListener> T getChecksumListener()

Returns the checksum listener of this object.

Returns:

the checksum listener of this object.

Since:

8.1.0

accumulateChecksum

boolean accumulateChecksum()

Indicates whether the checksum of this object should accumulate the subtree.

Returns:

whether the checksum of this object should accumulate the subtree.

Since:

8.1.0

isStoreChecksum

boolean isStoreChecksum()

Indicates whether the checksum of this object should be stored.

Returns:

whether the checksum of this object should be stored.

Since:

8.1.0

setStoreChecksum

IDeployObject setStoreChecksum(boolean isStoreChecksum)

Sets whether the checksum of this object should be stored.

Parameters:

isStoreChecksum - whether the checksum of this object should be stored.

Returns:

this object.

Since:

8.1.0

find

Collection<IDeployObject> find(IDeployObject.ObjectType type,
                               EnumSet<IDeployObject.ObjectType> allowedInnerObjects)

Find all objects of the given type in subtree, but discards subtrees when their root type is not contained in the given set.

Parameters:

type - the type to be search.

allowedInnerObjects - the allowed inner objects types.

Returns:

all objects of the given type in subtree, but discards subtrees when their root type is not contained in the given set.

Since:

8.1.0

find

IDeployObject find(String id,
                   IDeployObject.ObjectType objectType,
                   EnumSet<IDeployObject.ObjectType> allowedInnerObjects)

Finds the object with the given identifier of the given type in subtree. Don't search subtrees of objects of types not contained in the given set.

Parameters:

id - the object identifier.

objectType - the object type.

allowedInnerObjects - the allowed inner objects types.

Since:

8.1.0