public interface IMetaName
getDefaultValue(com.sapportals.wcm.service.propertyconfig.IMetaContext)
,
getDescription(java.util.Locale, com.sapportals.wcm.service.propertyconfig.IMetaContext)
,
getLabel(java.util.Locale, com.sapportals.wcm.service.propertyconfig.IMetaContext)
,
searchMetaValue(java.lang.String, com.sapportals.wcm.service.propertyconfig.IMetaContext)
.Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_NAMESPACE_ALIAS |
static String |
NS_SEPARATOR |
static String |
PROPERTY_TYPE_BOOLEAN |
static String |
PROPERTY_TYPE_DATE |
static String |
PROPERTY_TYPE_HTML |
static String |
PROPERTY_TYPE_INTEGER |
static String |
PROPERTY_TYPE_RID |
static String |
PROPERTY_TYPE_STRING |
static String |
PROPERTY_TYPE_TEXT |
static String |
PROPERTY_TYPE_TIME |
static String |
PROPERTY_TYPE_TIMESTAMP |
static String |
PROPERTY_TYPE_URL |
static String |
PROPERTY_TYPE_USER |
static String |
PROPERTY_TYPE_XML |
static int |
SORTMODE_ASCENDING |
static int |
SORTMODE_DESCENDING |
Modifier and Type | Method and Description |
---|---|
IMetaValueListIterator |
allowedValueIterator()
Returns a iterator to get a ordered value list.
|
IMetaValueListIterator |
allowedValueIterator(IMetaContext metaContext)
Returns a iterator to get a ordered value list.
|
String[] |
getAdditionalMetaTags() |
IMetaNameList |
getComposedOfMetaNames() |
int |
getDefaultSortmode()
returns the default sort mode (ascending/descending)
|
IMetaValue |
getDefaultValue()
Delivers the default value.
|
IMetaValue |
getDefaultValue(IMetaContext metaContext)
Delivers the default value
|
String |
getDescription(Locale locale)
Get description (internationalized)
|
String |
getDescription(Locale locale,
IMetaContext metaContext)
Get description (internationalized)
|
String[] |
getDocumentPatterns() |
String[] |
getFolderPatterns() |
String |
getFullId()
Complete ID ({namespace}name)
|
IMetaGroup |
getGroup()
Each meta property name belongs to a group like system, custom, default, etc.
|
String |
getId()
shortest complete ID (name, alias:name or namespace:name, depending on alias
availability or alias being "default"
|
String |
getLabel(Locale locale)
Get label (internationalized)
|
String |
getLabel(Locale locale,
IMetaContext metaContext)
Get label (internationalized)
|
IUriReference |
getLabelIcon()
Get the label icon alternative (mainly used for column headers)
|
String[] |
getMimeTypes() |
String |
getName()
property name without namespace or alias
|
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.
|
String[] |
getResourceTypes() |
String |
getSelectionCommandAlias()
Alias of the command that is used to navigate to the property selector
|
String |
getType()
Returns the PropertyType attribute of the MetaName object.
|
boolean |
hasAdditionalMetaTag(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(String value)
Returns a meta value by its id.
|
IMetaValue |
searchMetaValue(String value,
IMetaContext metaContext)
Returns a meta value by its id.
|
static final int SORTMODE_ASCENDING
static final int SORTMODE_DESCENDING
static final String PROPERTY_TYPE_BOOLEAN
static final String PROPERTY_TYPE_DATE
static final String PROPERTY_TYPE_INTEGER
static final String PROPERTY_TYPE_RID
static final String PROPERTY_TYPE_STRING
static final String PROPERTY_TYPE_TEXT
static final String PROPERTY_TYPE_TIMESTAMP
static final String PROPERTY_TYPE_TIME
static final String PROPERTY_TYPE_USER
static final String PROPERTY_TYPE_URL
static final String PROPERTY_TYPE_XML
static final String PROPERTY_TYPE_HTML
static final String NS_SEPARATOR
static final String DEFAULT_NAMESPACE_ALIAS
String getId()
String getFullId()
String getName()
String getNamespace()
IMetaGroup getGroup()
String getDescription(Locale locale)
locale
- Description of the paramString getDescription(Locale locale, IMetaContext metaContext)
locale
- Description of the parammetaContext
- context information for determining the returned valueString getLabel(Locale locale)
locale
- Description of the paramString getLabel(Locale locale, IMetaContext metaContext)
locale
- Description of the parammetaContext
- context information for determining the returned valueIUriReference getLabelIcon()
IMetaValue searchByProperty(IProperty property) throws PropertyConfigurationServiceException
property
- Search argument.PropertyConfigurationServiceException
IMetaValueListIterator allowedValueIterator() throws PropertyConfigurationServiceException
PropertyConfigurationServiceException
- if an error occurredIMetaValueListIterator allowedValueIterator(IMetaContext metaContext) throws PropertyConfigurationServiceException
metaContext
- context information for determining the returned valuesPropertyConfigurationServiceException
- if an error occurredIMetaValue searchMetaValue(String value) throws PropertyConfigurationServiceException
value
- Description of the paramPropertyConfigurationServiceException
- if an error occurredIMetaValue searchMetaValue(String value, IMetaContext metaContext) throws PropertyConfigurationServiceException
value
- Description of the parammetaContext
- context information for determining the returned valuePropertyConfigurationServiceException
- if an error occurredboolean hasAllowedValues()
boolean hasAllowedValues(IMetaContext metaContext)
metaContext
- context information for determining the returned valuesString getType()
boolean isMandatory()
boolean isIndexable()
boolean isHidden()
boolean isMaintainable()
true
if property can be maintained, false
otherwiseboolean isVirtual()
true
if property is a virtual property (maintainable only when the
resource has this property), false
otherwiseboolean isReadonly()
true
if property is read-only, false
otherwiseString[] getResourceTypes()
String[] getMimeTypes()
String[] getFolderPatterns()
String[] getDocumentPatterns()
String[] getAdditionalMetaTags()
boolean hasAdditionalMetaTag(String metaTag)
getAdditionalMetaTags
and checks if the string equals the input string. If it matches, true is returned.true
if the requested meta tag exists for this meta name, false
otherwiseIMetaValue getDefaultValue()
IMetaValue getDefaultValue(IMetaContext metaContext)
metaContext
- context information for determining the returned valueboolean isMultiValued()
boolean isModelled()
int getDefaultSortmode()
IMetaNameList getComposedOfMetaNames()
boolean hasDependencies()
String getSelectionCommandAlias()
IMetaPropertyRenderer getPropertyRenderer(PropertyDisplayMode displayMode)
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.null
if no renderer information is configured/renderer doesn't support the display modeIResourcePropertyComparator getResourcePropertyComparator() throws PropertyConfigurationServiceException
PropertyConfigurationServiceException
- if an error occurredAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice