Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.9.0)
E15995-08


oracle.wcps.property.model
Class PropertySetDefinition

java.lang.Object
  extended by oracle.wcps.property.model.Timestamped
      extended by 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.

 

Field Summary
protected  java.lang.String locatorClassName
           
protected static PropertiesLogger LOGGER
           
protected  INamespaceName namespaceName
           
protected  java.lang.String permissionClassName
           
protected  java.lang.String preferenceLocatorClassName
           
protected  java.util.Map<IPreferenceName,IPreferenceMapping> preferenceMappings
           
protected  IPropertyPermission propertyPermission
           
protected  IPropertySetDefinitionName propertySetDefinitionName
           

 

Method Summary
static PropertySetDefinition.Builder builder()
          Returns an instance of Builder to create a PropertySetDefinition.
protected  IPropertyPermission createPropertyPermission()
           
 boolean equals(java.lang.Object o)
           
 IPagedList<IPreferenceSet> filterPreferenceSetsViaPermission(IContext context, IPagedList<IPreferenceSet> unfiltered)
           
 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()
           
 INamespaceName getNamespaceName()
           
 java.lang.String getPreferenceLocatorClassName()
           
 java.lang.String getPreferenceLocatorClassName(IPreferenceName preferenceName)
           
 IPreferenceMapping getPreferenceMapping(IPreferenceName preferenceName)
           
 java.util.Map<IPreferenceName,IPreferenceMapping> getPreferenceMappings()
           
 IPropertyDefinitionName getPropertyDefinitionName(IName name)
           
 IPropertyDefinitionName getPropertyDefinitionName(IPreferenceName preferenceName)
           
 IPropertyDefinitionName getPropertyDefinitionName(IPropertyName propertyName)
          Returns the propertydefinition name from the property mapping associated with the given propertyName.
 java.lang.String getPropertyLocatorClassName()
           
 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.
protected  IPropertyPermission getPropertyPermission()
           
 java.lang.String getPropertyPermissionClassName()
           
 java.lang.Object getRPropertySetDefinition()
           
 int hashCode()
           
 boolean isAllowedOnPreference(IContext context, Capability capability, IPropertySetName setName, IPreferenceSetName preferenceSetName, IPreferenceName preferenceName)
           
 boolean isAllowedOnPreferenceSet(IContext context, Capability capability, IPropertySetName setName, IPreferenceSetName preferenceSetName)
           
 boolean isAllowedOnProperty(IContext context, Capability capability, IPropertySetName setName, IPropertyName propertyName)
           
 boolean isAllowedOnPropertySet(IContext context, Capability capability, IPropertySetName setName)
           
 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)
           
 java.lang.String name()
           
 IPreferenceMapping putPreferenceMapping(IPreferenceName key, IPreferenceMapping value)
           
 IPropertyMapping putPropertyMapping(IPropertyName key, IPropertyMapping value)
          Associates the given property name key to the given property mapping value.
 IPreferenceMapping removePreferenceMapping(IPreferenceName key)
           
 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)
           
 void setNamespaceName(INamespaceName namespaceName)
           
 void setPreferenceLocatorClassName(java.lang.String className)
           
 void setPropertyLocatorClassName(java.lang.String className)
           
 void setPropertyPermissionClassName(java.lang.String className)
           
 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.IPropertySetDefinition
getName, getNamespaceName, getPreferenceLocatorClassName, getPreferenceLocatorClassName, getPreferenceMapping, getPreferenceMappings, getPropertyDefinitionName, getPropertyLocatorClassName, getPropertyPermissionClassName, iteratePreferenceMappings, name, putPreferenceMapping, removePreferenceMapping, setName, setNamespaceName, setPreferenceLocatorClassName, setPropertyLocatorClassName, setPropertyPermissionClassName

 

Methods inherited from interface oracle.wcps.property.ITimestamped
getCreatedOn, getUpdatedOn, setCreatedOn, setUpdatedOn

 

Field Detail

LOGGER

protected static final PropertiesLogger LOGGER

namespaceName

protected INamespaceName namespaceName

propertySetDefinitionName

protected IPropertySetDefinitionName propertySetDefinitionName

locatorClassName

protected java.lang.String locatorClassName

permissionClassName

protected java.lang.String permissionClassName

propertyPermission

protected IPropertyPermission propertyPermission

preferenceMappings

protected java.util.Map<IPreferenceName,IPreferenceMapping> preferenceMappings

preferenceLocatorClassName

protected java.lang.String preferenceLocatorClassName

Method Detail

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.

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.

getPropertyDefinitionName

public IPropertyDefinitionName getPropertyDefinitionName(IName name)
Specified by:
getPropertyDefinitionName in interface IPropertySetDefinition

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.

isAllowedOnProperty

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

isAllowedOnPropertySet

public boolean isAllowedOnPropertySet(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)

hashCode

public int hashCode()

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

name

public java.lang.String name()

getNamespaceName

public INamespaceName getNamespaceName()

setNamespaceName

public void setNamespaceName(INamespaceName namespaceName)

getName

public IPropertySetDefinitionName getName()

setName

public void setName(IPropertySetDefinitionName propertySetDefinitionName)

getPropertyLocatorClassName

public java.lang.String getPropertyLocatorClassName()

setPropertyLocatorClassName

public void setPropertyLocatorClassName(java.lang.String className)

getPropertyPermissionClassName

public java.lang.String getPropertyPermissionClassName()

setPropertyPermissionClassName

public void setPropertyPermissionClassName(java.lang.String className)

getPreferenceMapping

public IPreferenceMapping getPreferenceMapping(IPreferenceName preferenceName)

putPreferenceMapping

public IPreferenceMapping putPreferenceMapping(IPreferenceName key,
                                               IPreferenceMapping value)

removePreferenceMapping

public IPreferenceMapping removePreferenceMapping(IPreferenceName key)

getPropertyDefinitionName

public IPropertyDefinitionName getPropertyDefinitionName(IPreferenceName preferenceName)

getPreferenceLocatorClassName

public java.lang.String getPreferenceLocatorClassName(IPreferenceName preferenceName)

getPreferenceMappings

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

getPreferenceLocatorClassName

public java.lang.String getPreferenceLocatorClassName()

setPreferenceLocatorClassName

public void setPreferenceLocatorClassName(java.lang.String className)

iteratePreferenceMappings

public void iteratePreferenceMappings(IPredicate<IPreferenceMapping> predicate)

isAllowedOnPreferenceSet

public boolean isAllowedOnPreferenceSet(IContext context,
                                        Capability capability,
                                        IPropertySetName setName,
                                        IPreferenceSetName preferenceSetName)

isAllowedOnPreference

public boolean isAllowedOnPreference(IContext context,
                                     Capability capability,
                                     IPropertySetName setName,
                                     IPreferenceSetName preferenceSetName,
                                     IPreferenceName preferenceName)

filterPreferenceSetsViaPermission

public IPagedList<IPreferenceSet> filterPreferenceSetsViaPermission(IContext context,
                                                                    IPagedList<IPreferenceSet> unfiltered)

getPropertyPermission

protected IPropertyPermission getPropertyPermission()

createPropertyPermission

protected IPropertyPermission createPropertyPermission()

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.9.0)
E15995-08


Copyright © 2009, 2014, Oracle and/or its affiliates. All rights reserved.