Package com.polarion.platform.persistence.model

Interface IStructure

All Superinterfaces:

IChangeGenerator, IChangeListener, IHasCustomValues, IHasValues

All Known Subinterfaces:

IApprovalStruct, IBaselineCollectionElement, IBuildDeploymentArtifact, IBuildEvent, IBuildEvents, IBuildLinkedWorkItemStruct, IBuildTestResults, IExternallyLinkedWorkItemStruct, IFeatureSelection, IFeatureSelectionItem, IHyperlinkStruct, ILinkedOslcResourceStruct, ILinkedRevisionStruct, ILinkedWorkItemStruct, IModule.IOutlineNumberingDef, IModule.IRenderingLayoutStruct, IModule.IStructureNode, IModuleComment.IImportedCommentStruct, IParameterDefinitionStruct, IParametersAndDefinitionsStruct, IParameterStruct<T>, IPlanningConstraintStruct, IPlanRecord, IRow, ISignature, ISignatureData, ITable, ITestRecord, ITestStep, ITestStepResult, ITestSteps

All Known Implementing Classes:

Structure

public interface IStructure
extends IChangeListener, IChangeGenerator, IHasValues, IHasCustomValues

Structure, which wraps underlying Map in from IDataObject to the level of the IPObjects. It has several functions:

• Translates SubterraURIs to IPObjects (in case of reference type keys).
• Propagates the dirty flag to the owner object.
• Checks the type of inserted items against model.
• Protects the read only collections.

Method Summary

Modifier and Type	Method	Description
IEnumeration	getEnumeration(String key)	Returns the IEnumeration if this one was registered for specific key or null.
IEnumOption	getEnumerationOptionForField(String key, String optionId)	Returns wrapped enumeration option for given field.
Optional<IEnumType>	getEnumerationTypeForField(String key)
IStructType	getPrototype()
Object	getValue(String key)	Returns the wrapped value.
boolean	isModified()
boolean	isReadOnly()
boolean	isReadOnly(String key)
void	setValue(String key, Object value)

Methods inherited from interface com.polarion.platform.persistence.model.IChangeGenerator

setChangeOwner

Methods inherited from interface com.polarion.platform.persistence.model.IChangeListener

markChanged

Methods inherited from interface com.polarion.platform.persistence.model.IHasCustomValues

getCustomField, getCustomFieldPrototype, getCustomFieldsList, setCustomField

Method Details

getPrototype

IStructType getPrototype()

getValue

Object getValue(String key)

Returns the wrapped value.

Specified by:

getValue in interface IHasValues

Parameters:

key -

setValue

void setValue(String key,
 Object value)

Specified by:

setValue in interface IHasValues

isReadOnly

boolean isReadOnly()

Returns:

true if the whole structure is read-only, false otherwise.

See Also:

• IPObject.isReadOnly()

isReadOnly

boolean isReadOnly(String key)

Returns:

true if the whole structure is read-only or if the given key is defined and is read-only, false otherwise.

See Also:

• IPObject.isReadOnly()

isModified

boolean isModified()

Returns:

True is this object was modified since it's load, false otherwise.

Since:

3.2.0

getEnumeration

IEnumeration getEnumeration(String key)

Returns the IEnumeration if this one was registered for specific key or null.

This is a convenience method, which calls the appropriate method on the IDataService

Parameters:

key - the key of some field of the structure

Returns:

the enumeration factory or null

getEnumerationTypeForField

@NotNull
Optional<IEnumType> getEnumerationTypeForField(@NotNull
 String key)

Returns:

the Optional of IEnumType for the given field if it is of enum or multi-enum type, otherwise returns Optional.empty().

Since:

3.21.1

getEnumerationOptionForField

@Nullable
IEnumOption getEnumerationOptionForField(@NotNull
 String key,
 @Nullable
 String optionId)

Returns wrapped enumeration option for given field.

Parameters:

key - field name (not null)

optionId - option id

Returns:

wrapped option (null if and only if optionId is null)

Throws:

UnknownKeyException - if the field is not valid or of enumeration type

Since:

3.21.2

See Also:

• IDataService.getEnumerationForKey(String, String, IContextId)
• IDataService.getEnumerationForEnumId(com.polarion.subterra.base.data.model.IEnumType, IContextId)
• ValueHelper.wrap(IPObject, String, com.polarion.subterra.base.data.model.IType, Object)
• getEnumerationTypeForField(String)