public interface IVariantManagerContextInfo
Modifier and Type | Method and Description |
---|---|
Map |
getDefaultContext()
Returns a map which contains a default value for each context property. keys:
IPropertyName ,
values: IProperty . |
PropertyType |
getType(IPropertyName name)
Returns the type of the property or
null if the name is unknown. |
Object[] |
getValues(IPropertyName name)
Returns an array of allowed values or
null if the name is unknown. |
Object[] |
getValuesSubSet(IPropertyName name,
Map otherPropertyValues)
Returns an array containing a subset of allowed values.
|
boolean |
hasProperty(IPropertyName name)
Returns true if meta information exists for the given property name.
|
List |
listNames()
Returns an read-only iterator for all known context property names.
|
void |
validateContext(Map properties)
Validates the map of context properties.
|
List listNames() throws RepositoryException
null
or
empty and must contain IPropertyName
objects.null
.RepositoryException
PropertyType getType(IPropertyName name) throws RepositoryException
null
if the name is unknown.name
- A property name (one of the names returned by the listNames()
.null
.RepositoryException
- resource exceptionObject[] getValues(IPropertyName name) throws RepositoryException
null
if the name is unknown. The array must contain at least
one value and he following classes must be used depending on the PropertyType: STRING: String, INT: Integer, LONG:
Long, DATETIME: Date, BOOLEAN: Boolean, XML: String.name
- A property name (one of the names returned by listNames()
.null
.RepositoryException
- resource exceptionObject[] getValuesSubSet(IPropertyName name, Map otherPropertyValues) throws RepositoryException
null
.
see #getValues(IPropertyName)name
- A property name (one of the names returned by listNames()
.otherPropertyValues
- keys: IPropertyName, values: Object representing a value depending on the property type. The value of the
first parameter must not be used in the map. The map must not be null
but may be empty. It
must contain values for all properties with a lower index (in the list returned by listNames()
)
than the name given in the first argument. If the map is empty the method must return all allowed values
(see getValues(IPropertyName)
).null
.RepositoryException
- If the second argument (map) contains invalid entries: invalid values, illegal combinations of values, etc.Map getDefaultContext() throws RepositoryException
IPropertyName
,
values: IProperty
.resource
- exceptionRepositoryException
boolean hasProperty(IPropertyName name) throws RepositoryException
name
- A property name.RepositoryException
- resource exceptionvoid validateContext(Map properties) throws InvalidVariantContextException, RepositoryException
listNames()
method) properties contained in the map.properties
- A map containing context properties.InvalidVariantContextException
- If the some of the context properties are invalid (wrong type, is multi-valued, value not allowed, invalid combination of values).RepositoryException
- exception with repositoryAccess 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