Package com.polarion.platform.persistence.spi

Class RepoBasedEnumeration

java.lang.Object

com.polarion.platform.persistence.spi.AbstractEnumeration

com.polarion.platform.persistence.spi.RepoBasedEnumeration

All Implemented Interfaces:

IConfigurableEnumeration, IEnumeration

Direct Known Subclasses:

TypedEnumeration

public class RepoBasedEnumeration
extends AbstractEnumeration
implements IConfigurableEnumeration

Generic implementation of an enum factory. Works with a default configuration data handler (data handler must return Document), and predefined XML structure. The sample configuration looks like this:

 <?xml version="1.0" encoding="UTF-8"?>
  
      
      
      
      
      
  
 

The attributes id, name, sortOrder and default are processed, all the others are passed as enum option properties.

Author:

POLARION SOFTWARE

Constructor Summary

Constructors

Constructor	Description
RepoBasedEnumeration(IRepositoryConfigService rcs, String cfgPath, String enumerationId, IContextId contextId)

Method Summary

Modifier and Type	Method	Description
String	getConfigurationId()	Configuration id to be used as parameter of methods on IRepositoryConfigService.
IEnumOption	getDefaultOption(String controlValue)
static String	getEnumerationFileName(String enumerationId)
static String	getEnumerationFolder(String enumerationId)

Methods inherited from class com.polarion.platform.persistence.spi.AbstractEnumeration

getAllOptions, getAvailableOptions, getAvailableOptions, getControlKey, getDefaultOption, wrapOption, wrapOption, wrapOption

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.polarion.platform.persistence.IEnumeration

getAllOptions, getAvailableOptions, getAvailableOptions, getControlKey, getDefaultOption, wrapOption, wrapOption, wrapOption

Constructor Details

RepoBasedEnumeration

public RepoBasedEnumeration(@Nullable
 IRepositoryConfigService rcs,
 @NotNull
 String cfgPath,
 @NotNull
 String enumerationId,
 @Nullable
 IContextId contextId)

Method Details

getConfigurationId

@NotNull
public String getConfigurationId()

Description copied from interface: IConfigurableEnumeration

Configuration id to be used as parameter of methods on IRepositoryConfigService.

Specified by:

getConfigurationId in interface IConfigurableEnumeration

Since:

3.8.1

getDefaultOption

@Nullable
public IEnumOption getDefaultOption(@Nullable
 String controlValue)

Specified by:

getDefaultOption in class AbstractEnumeration

getEnumerationFolder

@Nullable
public static String getEnumerationFolder(@Nullable
 String enumerationId)

Since:

3.6.0

getEnumerationFileName

@Nullable
public static String getEnumerationFileName(@Nullable
 String enumerationId)

Since:

3.6.0