Skip navigation links

oracle.wcps.property
Interface IPropertySetDefinition

All Superinterfaces:

ITimestamped

All Known Implementing Classes:

PropertySetDefinition

public interface IPropertySetDefinition

extends ITimestamped

Represents a schema or a structure for propertysets within a namespace. A propertysetdefinition is a set of property mappings (IPropertyMapping). A property mapping associates a property name to a property definition name that defines its value's features (type, isRestricted, restricted, default values, and validators) and optionally a property locator to manage its value.

Method Summary

java.lang.String	getDescription() Returns a brief description of this.
int	getMappingsCount() Returns the number of property mappings in this.
IPropertySetDefinitionName	getName() Returns the propertysetdefinition name of this.
INamespaceName	getNamespaceName() Returns the associated namespace name.
java.lang.String	getPreferenceLocatorClassName() Returns the preference locator class name that is associated with this.
java.lang.String	getPreferenceLocatorClassName(IPreferenceName preferenceName) Returns the preference locator class name from the preference mapping associated with the given preferenceName.
IPreferenceMapping	getPreferenceMapping(IPreferenceName preferenceName) Returns the preference mapping associated with the given preferenceName.
java.util.Map<IPreferenceName,IPreferenceMapping>	getPreferenceMappings() Returns a map of the preference mappings associated with this.
IPropertyDefinitionName	getPropertyDefinitionName(IName name)
IPropertyDefinitionName	getPropertyDefinitionName(IPreferenceName preferenceName) Returns the propertydefinition name from the property mapping associated with the given propertyName.
IPropertyDefinitionName	getPropertyDefinitionName(IPropertyName propertyName) Returns the propertydefinition name from the property mapping associated with the given propertyName.
java.lang.String	getPropertyLocatorClassName() Returns the property locator class name that is associated with this.
java.lang.String	getPropertyLocatorClassName(IPropertyName propertyName) Returns the property locator class name from the property mapping associated with the given propertyName.
IPropertyMapping	getPropertyMapping(IPropertyName propertyName) Returns the property mapping associated with the given propertyName.
java.util.Map<IPropertyName,IPropertyMapping>	getPropertyMappings() Returns a map of the property mappings associated with this.
java.lang.String	getPropertyPermissionClassName() Returns the property permission class name associated with this.
void	iterate(IPredicate<IPropertyMapping> predicate) Calls the given predicates IPredicate.apply(Object) method for each property mapping found in this.
void	iteratePreferenceMappings(IPredicate<IPreferenceMapping> predicate) Calls the given predicates IPredicate.apply(Object) method for each preference mapping found in this.
java.lang.String	name() Returns the string representation of the composite name of this.
IPreferenceMapping	putPreferenceMapping(IPreferenceName key, IPreferenceMapping value) Associates the given preference name key to the given preference mapping value.
IPropertyMapping	putPropertyMapping(IPropertyName key, IPropertyMapping value) Associates the given property name key to the given property mapping value.
IPreferenceMapping	removePreferenceMapping(IPreferenceName key) Removes the association of the given key to the value a preference mapping.
IPropertyMapping	removePropertyMapping(IPropertyName key) Removes the association of the given key to the value a property mapping.
void	setDescription(java.lang.String desc) Sets the given desc as a brief description for this.
void	setName(IPropertySetDefinitionName name) Sets the given propertysetdefinition name as the name for this.
void	setNamespaceName(INamespaceName namespaceName) Deprecated. it is a no op.
void	setPreferenceLocatorClassName(java.lang.String className) Sets the given className as the preference locator class name at propertysetdefinition level.
void	setPropertyLocatorClassName(java.lang.String className) Sets the given className as the property locator class name at propertysetdefinition level.
void	setPropertyPermissionClassName(java.lang.String className) Sets the given className as the property permission class name.

Methods inherited from interface oracle.wcps.property.ITimestamped

getCreatedOn, getUpdatedOn, setCreatedOn, setUpdatedOn

Method Detail

getNamespaceName

INamespaceName getNamespaceName()

Returns the associated namespace name.

Returns:

the associated namespace name.

setNamespaceName

void setNamespaceName(INamespaceName namespaceName)

Deprecated. it is a no op.

Sets the given namespaceName as the associated namespace name. Note: Calling this has no effect when using methods of IPropertyService, its overwritten with the namespace name in IPropertyService.getNamespaceName()

Parameters:

namespaceName - the namespace name to which this will be associated.

name

java.lang.String name()

Returns the string representation of the composite name of this. It is created by combining [string representation of the namespace name of this]:[string representation of the propertysetdefinition name of this].

Returns:

the string representation of the composite name.

getName

IPropertySetDefinitionName getName()

Returns the propertysetdefinition name of this.

Returns:

the propertysetdefinition name of this.

setName

void setName(IPropertySetDefinitionName name)

Sets the given propertysetdefinition name as the name for this.

Parameters:

name - a propertysetdefinition name.

getDescription

java.lang.String getDescription()

Returns a brief description of this.

Returns:

a brief description.

setDescription

void setDescription(java.lang.String desc)

Sets the given desc as a brief description for this.

Parameters:

desc - a brief description.

getPropertyMapping

IPropertyMapping getPropertyMapping(IPropertyName propertyName)

Returns the property mapping associated with the given propertyName.

Parameters:

propertyName - A property's name.

Returns:

the associated property mapping if found, otherwise null.

putPropertyMapping

IPropertyMapping putPropertyMapping(IPropertyName key,
                                    IPropertyMapping value)

Associates the given property name key to the given property mapping value.

Parameters:

key - a property name

value - a property mapping

Returns:

the previously associated mapping if found, otherwise null.

removePropertyMapping

IPropertyMapping removePropertyMapping(IPropertyName key)

Removes the association of the given key to the value a property mapping.

Parameters:

key - a property name

Returns:

the value associated with the given key if present, otherwise null.

getPropertyDefinitionName

IPropertyDefinitionName getPropertyDefinitionName(IPropertyName propertyName)

Returns the propertydefinition name from the property mapping associated with the given propertyName.

Parameters:

propertyName - a property name.

Returns:

the propertydefinition name from the property mapping associated with the given propertyName, otherwise null.

getPropertyLocatorClassName

java.lang.String getPropertyLocatorClassName(IPropertyName propertyName)

Returns the property locator class name from the property mapping associated with the given propertyName.

Parameters:

propertyName - a property name.

Returns:

the property locator class name from the property mapping associated with the given propertyName, otherwise null.

getPropertyMappings

java.util.Map<IPropertyName,IPropertyMapping> getPropertyMappings()

Returns a map of the property mappings associated with this.

Returns:

a map of the property mappings.

getPropertyLocatorClassName

java.lang.String getPropertyLocatorClassName()

Returns the property locator class name that is associated with this. This property locator class is used for managing all the properties of the propertysets within this propertysetdefinition. The property locator class in a property mapping will override this.

Returns:

the property locator class name associated with this.

setPropertyLocatorClassName

void setPropertyLocatorClassName(java.lang.String className)

Sets the given className as the property locator class name at propertysetdefinition level.

Parameters:

className - a fully qualified class name that implements IPropertyLocator.

getPropertyPermissionClassName

java.lang.String getPropertyPermissionClassName()

Returns the property permission class name associated with this. If present this class is called to check further authorization on propertysets and properties within this.

Returns:

the property permission class name associated with this.

See Also:

IPropertyPermission

setPropertyPermissionClassName

void setPropertyPermissionClassName(java.lang.String className)

Sets the given className as the property permission class name.

Parameters:

className - a fully qualified class name that implements IPropertyPermission.

iterate

void iterate(IPredicate<IPropertyMapping> predicate)

Calls the given predicates IPredicate.apply(Object) method for each property mapping found in this.

Parameters:

predicate - a predicate object.

getMappingsCount

int getMappingsCount()

Returns the number of property mappings in this.

Returns:

the number of property mappings in this.

getPreferenceMapping

IPreferenceMapping getPreferenceMapping(IPreferenceName preferenceName)

Returns the preference mapping associated with the given preferenceName.

Parameters:

preferenceName - A preference's name.

Returns:

the associated preference mapping if found, otherwise null.

putPreferenceMapping

IPreferenceMapping putPreferenceMapping(IPreferenceName key,
                                        IPreferenceMapping value)

Associates the given preference name key to the given preference mapping value.

Parameters:

key - a preference name

value - a preference mapping

Returns:

the previously associated mapping if found, otherwise null.

removePreferenceMapping

IPreferenceMapping removePreferenceMapping(IPreferenceName key)

Removes the association of the given key to the value a preference mapping.

Parameters:

key - a preference name

Returns:

the value associated with the given key if present, otherwise null.

getPropertyDefinitionName

IPropertyDefinitionName getPropertyDefinitionName(IPreferenceName preferenceName)

Returns the propertydefinition name from the property mapping associated with the given propertyName.

Parameters:

preferenceName - a preference name.

Returns:

the propertydefinition name from the property mapping associated with the given preferenceName, otherwise null.

getPropertyDefinitionName

IPropertyDefinitionName getPropertyDefinitionName(IName name)

getPreferenceLocatorClassName

java.lang.String getPreferenceLocatorClassName(IPreferenceName preferenceName)

Returns the preference locator class name from the preference mapping associated with the given preferenceName.

Parameters:

preferenceName - a preference name.

Returns:

the preference locator class name from the preference mapping associated with the given preferenceName, otherwise null.

getPreferenceMappings

java.util.Map<IPreferenceName,IPreferenceMapping> getPreferenceMappings()

Returns a map of the preference mappings associated with this.

Returns:

a map of the preference mappings.

getPreferenceLocatorClassName

java.lang.String getPreferenceLocatorClassName()

Returns the preference locator class name that is associated with this. This preference locator class is used for managing all the preferences of a propertyset within this propertysetdefinition. The preference locator class in a preference mapping will override this.

Returns:

the preference locator class name associated with this.

setPreferenceLocatorClassName

void setPreferenceLocatorClassName(java.lang.String className)

Sets the given className as the preference locator class name at propertysetdefinition level.

Parameters:

className - a fully qualified class name that implements IPreferenceLocator.

iteratePreferenceMappings

void iteratePreferenceMappings(IPredicate<IPreferenceMapping> predicate)

Calls the given predicates IPredicate.apply(Object) method for each preference mapping found in this.

Parameters:

predicate - a predicate object.

Skip navigation links