Skip navigation links

oracle.wcps.property.model
Class PropertySetDefinition

java.lang.Object
oracle.wcps.property.model.Timestamped
oracle.wcps.property.model.PropertySetDefinition

All Implemented Interfaces:

java.io.Serializable, IPropertySetDefinition, ITimestamped

public class PropertySetDefinition

extends Timestamped

implements IPropertySetDefinition, java.io.Serializable

An implementation of IPropertySetDefinition. Use the builder builder() to create an instance of this.

See Also:

Serialized Form

Nested Class Summary

static class

PropertySetDefinition.Builder The builder used for creating a PropertySetDefinition.

Method Summary

static PropertySetDefinition.Builder	builder() Returns an instance of Builder to create a PropertySetDefinition.
boolean	equals(java.lang.Object o)
IPagedList<IPropertySet>	filterViaPermission(IContext context, IPagedList<IPropertySet> unfiltered)
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.
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.
java.lang.Object	getRPropertySetDefinition()
int	hashCode()
boolean	isAllowed(IContext context, Capability capability, IPropertySetName setName)
boolean	isAllowed(IContext context, Capability capability, IPropertySetName setName, IPropertyName propertyName)
void	iterate(IPredicate<IPropertyMapping> predicate) Calls the given predicates IPredicate.apply(Object) method for each property mapping found in this.
java.lang.String	name() Returns the string representation of the composite name of this.
IPropertyMapping	putPropertyMapping(IPropertyName key, IPropertyMapping value) Associates the given property name key to the given property mapping value.
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 propertySetDefinitionName) Sets the given propertysetdefinition name as the name for this.
void	setNamespaceName(INamespaceName namespaceName) Sets the given namespaceName as the associated namespace name.
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.
void	setRPropertySetDefinition(java.lang.Object rPropertySetDefinition)
java.lang.String	toString()

Methods inherited from class oracle.wcps.property.model.Timestamped

getCreatedOn, getUpdatedOn, setCreatedOn, setUpdatedOn

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.wcps.property.ITimestamped

getCreatedOn, getUpdatedOn, setCreatedOn, setUpdatedOn

Method Detail

name

public java.lang.String name()

Description copied from interface: IPropertySetDefinition

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].

Specified by:

name in interface IPropertySetDefinition

Returns:

the string representation of the composite name.

getNamespaceName

public INamespaceName getNamespaceName()

Description copied from interface: IPropertySetDefinition

Returns the associated namespace name.

Specified by:

getNamespaceName in interface IPropertySetDefinition

Returns:

the associated namespace name.

setNamespaceName

public void setNamespaceName(INamespaceName namespaceName)

Description copied from interface: IPropertySetDefinition

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()

Specified by:

setNamespaceName in interface IPropertySetDefinition

Parameters:

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

getName

public IPropertySetDefinitionName getName()

Description copied from interface: IPropertySetDefinition

Returns the propertysetdefinition name of this.

Specified by:

getName in interface IPropertySetDefinition

Returns:

the propertysetdefinition name of this.

getDescription

public java.lang.String getDescription()

Description copied from interface: IPropertySetDefinition

Returns a brief description of this.

Specified by:

getDescription in interface IPropertySetDefinition

Returns:

a brief description.

setDescription

public void setDescription(java.lang.String desc)

Description copied from interface: IPropertySetDefinition

Sets the given desc as a brief description for this.

Specified by:

setDescription in interface IPropertySetDefinition

Parameters:

desc - a brief description.

getPropertyMapping

public IPropertyMapping getPropertyMapping(IPropertyName propertyName)

Description copied from interface: IPropertySetDefinition

Returns the property mapping associated with the given propertyName.

Specified by:

getPropertyMapping in interface IPropertySetDefinition

Parameters:

propertyName - A property's name.

Returns:

the associated property mapping if found, otherwise null.

putPropertyMapping

public IPropertyMapping putPropertyMapping(IPropertyName key,
                                           IPropertyMapping value)

Description copied from interface: IPropertySetDefinition

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

Specified by:

putPropertyMapping in interface IPropertySetDefinition

Parameters:

key - a property name

value - a property mapping

Returns:

the previously associated mapping if found, otherwise null.

removePropertyMapping

public IPropertyMapping removePropertyMapping(IPropertyName key)

Description copied from interface: IPropertySetDefinition

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

Specified by:

removePropertyMapping in interface IPropertySetDefinition

Parameters:

key - a property name

Returns:

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

getPropertyMappings

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

Description copied from interface: IPropertySetDefinition

Returns a map of the property mappings associated with this.

Specified by:

getPropertyMappings in interface IPropertySetDefinition

Returns:

a map of the property mappings.

getPropertyLocatorClassName

public java.lang.String getPropertyLocatorClassName()

Description copied from interface: IPropertySetDefinition

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.

Specified by:

getPropertyLocatorClassName in interface IPropertySetDefinition

Returns:

the property locator class name associated with this.

setPropertyLocatorClassName

public void setPropertyLocatorClassName(java.lang.String className)

Description copied from interface: IPropertySetDefinition

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

Specified by:

setPropertyLocatorClassName in interface IPropertySetDefinition

Parameters:

className - a fully qualified class name that implements IPropertyLocator.

getPropertyPermissionClassName

public java.lang.String getPropertyPermissionClassName()

Description copied from interface: IPropertySetDefinition

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.

Specified by:

getPropertyPermissionClassName in interface IPropertySetDefinition

Returns:

the property permission class name associated with this.

See Also:

IPropertyPermission

setPropertyPermissionClassName

public void setPropertyPermissionClassName(java.lang.String className)

Description copied from interface: IPropertySetDefinition

Sets the given className as the property permission class name.

Specified by:

setPropertyPermissionClassName in interface IPropertySetDefinition

Parameters:

className - a fully qualified class name that implements IPropertyPermission.

setName

public void setName(IPropertySetDefinitionName propertySetDefinitionName)

Description copied from interface: IPropertySetDefinition

Sets the given propertysetdefinition name as the name for this.

Specified by:

setName in interface IPropertySetDefinition

Parameters:

propertySetDefinitionName - a propertysetdefinition name.

getPropertyDefinitionName

public IPropertyDefinitionName getPropertyDefinitionName(IPropertyName propertyName)

Description copied from interface: IPropertySetDefinition

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

Specified by:

getPropertyDefinitionName in interface IPropertySetDefinition

Parameters:

propertyName - a property name.

Returns:

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

getPropertyLocatorClassName

public java.lang.String getPropertyLocatorClassName(IPropertyName propertyName)

Description copied from interface: IPropertySetDefinition

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

Specified by:

getPropertyLocatorClassName in interface IPropertySetDefinition

Parameters:

propertyName - a property name.

Returns:

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

iterate

public void iterate(IPredicate<IPropertyMapping> predicate)

Description copied from interface: IPropertySetDefinition

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

Specified by:

iterate in interface IPropertySetDefinition

Parameters:

predicate - a predicate object.

isAllowed

public boolean isAllowed(IContext context,
                         Capability capability,
                         IPropertySetName setName,
                         IPropertyName propertyName)

isAllowed

public boolean isAllowed(IContext context,
                         Capability capability,
                         IPropertySetName setName)

filterViaPermission

public IPagedList<IPropertySet> filterViaPermission(IContext context,
                                                    IPagedList<IPropertySet> unfiltered)

getRPropertySetDefinition

public java.lang.Object getRPropertySetDefinition()

setRPropertySetDefinition

public void setRPropertySetDefinition(java.lang.Object rPropertySetDefinition)

getMappingsCount

public int getMappingsCount()

Description copied from interface: IPropertySetDefinition

Returns the number of property mappings in this.

Specified by:

getMappingsCount in interface IPropertySetDefinition

Returns:

the number of property mappings in this.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Timestamped

hashCode

public int hashCode()

Overrides:

hashCode in class Timestamped

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static PropertySetDefinition.Builder builder()

Returns an instance of Builder to create a PropertySetDefinition.

Returns:

an instance of Builder

Skip navigation links