com.sapportals.wcm.service.propertyconfig
Interface IMetaName

[contained in: com.sap.km.cm.service.base.par - km.shared.service.propertyconfig_api.jar]

public interface IMetaName

Name part of name - value pairs. Meta name value pairs can be configured to use them i.e. in UI to select property name and values.

Field Summary

static java.lang.String	DEFAULT_NAMESPACE_ALIAS
static java.lang.String	NS_SEPARATOR
static java.lang.String	PROPERTY_TYPE_BOOLEAN
static java.lang.String	PROPERTY_TYPE_DATE
static java.lang.String	PROPERTY_TYPE_HTML
static java.lang.String	PROPERTY_TYPE_INTEGER
static java.lang.String	PROPERTY_TYPE_RID
static java.lang.String	PROPERTY_TYPE_STRING
static java.lang.String	PROPERTY_TYPE_TEXT
static java.lang.String	PROPERTY_TYPE_TIME
static java.lang.String	PROPERTY_TYPE_TIMESTAMP
static java.lang.String	PROPERTY_TYPE_URL
static java.lang.String	PROPERTY_TYPE_USER
static java.lang.String	PROPERTY_TYPE_XML
static int	SORTMODE_ASCENDING
static int	SORTMODE_DESCENDING

Method Summary

IMetaValueListIterator	allowedValueIterator() Returns a iterator to get a ordered value list.
IMetaValueListIterator	allowedValueIterator(IMetaContext metaContext) Returns a iterator to get a ordered value list.
java.lang.String[]	getAdditionalMetaTags()
IMetaNameList	getComposedOfMetaNames()
int	getDefaultSortmode() returns the default sort mode (ascending/descending)
IMetaValue	getDefaultValue() Delivers the default value
java.lang.String	getDescription(java.util.Locale locale) Get description (internationalized)
java.lang.String[]	getDocumentPatterns()
java.lang.String[]	getFolderPatterns()
java.lang.String	getFullId() Complete ID ({namespace}name)
IMetaGroup	getGroup() Each meta property name belongs to a group like system, custom, default, etc.
java.lang.String	getId() shortest complete ID (name, alias:name or namespace:name, depending on alias availability or alias being "default"
java.lang.String	getLabel(java.util.Locale locale) Get label (internationalized)
IUriReference	getLabelIcon() Get the label icon alternative (mainly used for column headers)
java.lang.String[]	getMimeTypes()
java.lang.String	getName() property name without namespace or alias
java.lang.String	getNamespace() namespace
IMetaPropertyRenderer	getPropertyRenderer(PropertyDisplayMode displayMode) Returns the property renderer for this meta name.
IResourcePropertyComparator	getResourcePropertyComparator() Returns the comparator class for this meta name.
java.lang.String[]	getResourceTypes()
java.lang.String	getSelectionCommandAlias() Alias of the command that is used to navigate to the property selector
java.lang.String	getType() Returns the PropertyType attribute of the MetaName object.
boolean	hasAdditionalMetaTag(java.lang.String metaTag) Returns true if the requested meta tag exists for this meta name.
boolean	hasAllowedValues() Ask for if the list of values is not empty.
boolean	hasAllowedValues(IMetaContext metaContext) Ask for if the list of values is not empty.
boolean	hasDependencies() Flag that indicates that the property value affects the value or state of other properties or other objects in the current context.
boolean	isHidden()
boolean	isIndexable() Delivers a flag which is used by TREX and Indexmanagement.
boolean	isMaintainable()
boolean	isMandatory() Delivers a flag which marks this property as being mandatory
boolean	isModelled() Delivers a flag which marks this property as being explicitly modelled (not on-the-fly)
boolean	isMultiValued() get multi-value attribute
boolean	isReadonly()
boolean	isVirtual()
IMetaValue	searchByProperty(IProperty property) Search for the meta value that was used to create the passed property.
IMetaValue	searchMetaValue(java.lang.String value) Returns a meta value by its id.

Field Detail

SORTMODE_ASCENDING

public static final int SORTMODE_ASCENDING

SORTMODE_DESCENDING

public static final int SORTMODE_DESCENDING

PROPERTY_TYPE_BOOLEAN

public static final java.lang.String PROPERTY_TYPE_BOOLEAN

PROPERTY_TYPE_DATE

public static final java.lang.String PROPERTY_TYPE_DATE

PROPERTY_TYPE_INTEGER

public static final java.lang.String PROPERTY_TYPE_INTEGER

PROPERTY_TYPE_RID

public static final java.lang.String PROPERTY_TYPE_RID

PROPERTY_TYPE_STRING

public static final java.lang.String PROPERTY_TYPE_STRING

PROPERTY_TYPE_TEXT

public static final java.lang.String PROPERTY_TYPE_TEXT

PROPERTY_TYPE_TIMESTAMP

public static final java.lang.String PROPERTY_TYPE_TIMESTAMP

PROPERTY_TYPE_TIME

public static final java.lang.String PROPERTY_TYPE_TIME

PROPERTY_TYPE_USER

public static final java.lang.String PROPERTY_TYPE_USER

PROPERTY_TYPE_URL

public static final java.lang.String PROPERTY_TYPE_URL

PROPERTY_TYPE_XML

public static final java.lang.String PROPERTY_TYPE_XML

PROPERTY_TYPE_HTML

public static final java.lang.String PROPERTY_TYPE_HTML

NS_SEPARATOR

public static final java.lang.String NS_SEPARATOR

DEFAULT_NAMESPACE_ALIAS

public static final java.lang.String DEFAULT_NAMESPACE_ALIAS

Method Detail

getId

public java.lang.String getId()

shortest complete ID (name, alias:name or namespace:name, depending on alias availability or alias being "default"

Returns:

The Id value

getFullId

public java.lang.String getFullId()

Complete ID ({namespace}name)

Returns:

The Id value

getName

public java.lang.String getName()

property name without namespace or alias

Returns:

The Name value

getNamespace

public java.lang.String getNamespace()

namespace

Returns:

Property namespace

getGroup

public IMetaGroup getGroup()

Each meta property name belongs to a group like system, custom, default, etc. NOTE: Can be null if no group info is available!

Returns:

Meta group info

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Get description (internationalized)

Parameters:

locale - Description of the param

Returns:

The description value or null, if not available

getLabel

public java.lang.String getLabel(java.util.Locale locale)

Get label (internationalized)

Parameters:

locale - Description of the param

Returns:

The label value or the result of getName(), if not available

getLabelIcon

public IUriReference getLabelIcon()

Get the label icon alternative (mainly used for column headers)

Returns:

The label icon URI

searchByProperty

public IMetaValue searchByProperty(IProperty property)
                            throws PropertyConfigurationServiceException

Search for the meta value that was used to create the passed property.

Parameters:

property - Search argument.

Returns:

IMetaValue

Throws:

PropertyConfigurationServiceException -

allowedValueIterator

public IMetaValueListIterator allowedValueIterator()
                                            throws PropertyConfigurationServiceException

Returns a iterator to get a ordered value list.

Returns:

<{Iterator}>

Throws:

PropertyConfigurationServiceException - Exception raised in failure situation

<{PropertyConfigurationServiceException}> -

allowedValueIterator

public IMetaValueListIterator allowedValueIterator(IMetaContext metaContext)
                                            throws PropertyConfigurationServiceException

Returns a iterator to get a ordered value list.

Parameters:

metaContext - context information for determining the returned values

Returns:

<{Iterator}>

Throws:

PropertyConfigurationServiceException - Exception raised in failure situation

<{PropertyConfigurationServiceException}> -

searchMetaValue

public IMetaValue searchMetaValue(java.lang.String value)
                           throws PropertyConfigurationServiceException

Returns a meta value by its id.

Parameters:

value - Description of the param

Returns:

<{IMetaValue}> (0, 1)

Throws:

PropertyConfigurationServiceException - Exception raised in failure situation

<{PropertyConfigurationServiceException}> -

hasAllowedValues

public boolean hasAllowedValues()

Ask for if the list of values is not empty.

Returns:

Returns true, if list of values is not empty.

hasAllowedValues

public boolean hasAllowedValues(IMetaContext metaContext)

Ask for if the list of values is not empty.

Parameters:

metaContext - context information for determining the returned values

Returns:

Returns true, if list of values is not empty.

getType

public java.lang.String getType()

Returns the PropertyType attribute of the MetaName object.

Returns:

propertyType

isMandatory

public boolean isMandatory()

Delivers a flag which marks this property as being mandatory

Returns:

mandatory flag

isIndexable

public boolean isIndexable()

Delivers a flag which is used by TREX and Indexmanagement.

Returns:

indexable Flag

isHidden

public boolean isHidden()

Returns:

true if property should be hidden, false else

isMaintainable

public boolean isMaintainable()

Returns:

true if property can be maintained, false else

isVirtual

public boolean isVirtual()

Returns:

true if property is a virtual property (maintainable only when the resource has this property), false else

isReadonly

public boolean isReadonly()

Returns:

true if property is read-only, false else

getResourceTypes

public java.lang.String[] getResourceTypes()

Returns:

the allowed resource types

getMimeTypes

public java.lang.String[] getMimeTypes()

Returns:

the allowed mime types

getFolderPatterns

public java.lang.String[] getFolderPatterns()

Returns:

the validity patterns for folders

getDocumentPatterns

public java.lang.String[] getDocumentPatterns()

Returns:

the validity patterns for documents

getAdditionalMetaTags

public java.lang.String[] getAdditionalMetaTags()

Returns:

an array of additional meta tags

hasAdditionalMetaTag

public boolean hasAdditionalMetaTag(java.lang.String metaTag)

Returns true if the requested meta tag exists for this meta name. The method loops over all meta tags that are returned by getAdditionalMetaTags and checks if the string equals the input string. If it matches, true is returned.

Returns:

boolean true if the requested meta tag exists for this meta name

getDefaultValue

public IMetaValue getDefaultValue()

Delivers the default value

Returns:

value or null, if unset

isMultiValued

public boolean isMultiValued()

get multi-value attribute

Returns:

boolean flag

isModelled

public boolean isModelled()

Delivers a flag which marks this property as being explicitly modelled (not on-the-fly)

Returns:

modelled flag

getDefaultSortmode

public int getDefaultSortmode()

returns the default sort mode (ascending/descending)

Returns:

IMetaName.SORTMODE_ASCENDING/IMetaName.SORTMODE_DESCENDING

getComposedOfMetaNames

public IMetaNameList getComposedOfMetaNames()

Returns:

all meta names which composed this meta name

hasDependencies

public boolean hasDependencies()

Flag that indicates that the property value affects the value or state of other properties or other objects in the current context.

Returns:

true if the property has dependencies

getSelectionCommandAlias

public java.lang.String getSelectionCommandAlias()

Alias of the command that is used to navigate to the property selector

Returns:

alias of the command

getPropertyRenderer

public IMetaPropertyRenderer getPropertyRenderer(PropertyDisplayMode displayMode)

Returns the property renderer for this meta name.

Parameters:

displayMode - display mode that must be supported by the property renderer. If displayMode is PropertyDisplayMode.UNDEFINED the renderer don't has to support any display mode to be returned.

Returns:

property renderer meta information or null if no renderer information is configured/renderer doesn't support the display mode

getResourcePropertyComparator

public IResourcePropertyComparator getResourcePropertyComparator()
                                                          throws PropertyConfigurationServiceException

Returns the comparator class for this meta name. If no special comparator is configured for this property the default resource property comparator is returned.

Returns:

comparator for comparing two resources on the basis of this property