|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.rest.filtering.ComponentConfiguration
public class ComponentConfiguration
This class represents the configuration for a customized component. It is used internally by the REST subsystem.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Constructor Summary | |
---|---|
protected |
ComponentConfiguration(java.lang.String pName,
boolean pDefaultIncludes)
Constructor |
protected |
ComponentConfiguration(java.lang.String pName,
java.lang.String pItemDescriptorName,
boolean pDefaultIncludes)
Constructor |
Method Summary | |
---|---|
void |
addFilteredProperty(java.lang.String pName,
boolean pHidden,
boolean pWritable,
boolean pExpand,
java.lang.String pTarget,
java.lang.String pComponentName,
java.lang.String pPropertyCustomizer)
Adds property information for a single property to this ComponentFilteringConfiguration |
void |
addFilteredProperty(java.lang.String pName,
boolean pHidden,
boolean pWritable,
java.lang.String pTarget,
java.lang.String pComponentName,
java.lang.String pPropertyCustomizer)
Adds property information for a single property to this ComponentFilteringConfiguration |
static ComponentConfiguration |
create(java.lang.String pName,
boolean pDefaultIncludes)
Factory method for creating ComponentFilteringConfiguration objects |
static ComponentConfiguration |
create(java.lang.String pName,
java.lang.String pItemDescriptorName,
boolean pDefaultIncludes)
Factory method for creating ComponentFilteringConfiguration objects |
int |
getDepth()
get Depth |
java.util.Map<java.lang.String,PropertyConfiguration> |
getFilteredProperties()
A Map of filtered properties. |
PropertyConfiguration |
getFilteredProperty(java.lang.String pName)
Returns the property configuration for the given property name. |
java.lang.String |
getItemDescriptorName()
Returns the item descriptor this component filtering is for. |
java.lang.String |
getName()
The name of the filtered property |
boolean |
isDefaultIncludes()
A flag indicating whether or not to include all the "standard" properties when returning values for this component. |
boolean |
isDepthSet()
get DepthSet |
boolean |
isRepository()
Returns the nucleus path of the repository this component filtering is for. |
void |
setDefaultIncludes(boolean pDefaultIncludes)
Sets the flag indicating whether or not to include all the "standard" properties when returning values for this component. |
void |
setDepth(int pDepth)
set Depth |
void |
setDepthSet(boolean pDepthSet)
set DepthSet |
void |
setItemDescriptorName(java.lang.String pItemDescriptorName)
Sets the item descriptor this component filtering is for. |
void |
setName(java.lang.String pName)
Sets the name of the filtered property |
void |
setRepository(boolean pRepository)
Sets the nucleus path of the repository this component filtering is for. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
protected ComponentConfiguration(java.lang.String pName, boolean pDefaultIncludes)
pName
- the component namepDefaultIncludes
- the defaultIncludes settingprotected ComponentConfiguration(java.lang.String pName, java.lang.String pItemDescriptorName, boolean pDefaultIncludes)
pName
- the component namepItemDescriptorName
- the item descriptor namepDefaultIncludes
- the defaultIncludes settingMethod Detail |
---|
public java.util.Map<java.lang.String,PropertyConfiguration> getFilteredProperties()
public java.lang.String getName()
public void setName(java.lang.String pName)
pName
- the name to setpublic boolean isDefaultIncludes()
public void setDefaultIncludes(boolean pDefaultIncludes)
pDefaultIncludes
- the defaultIncludes to setpublic boolean isRepository()
public void setRepository(boolean pRepository)
pRepository
- the repository to setpublic java.lang.String getItemDescriptorName()
public void setItemDescriptorName(java.lang.String pItemDescriptorName)
pItemDescriptorName
- the item descriptor name to setpublic void setDepth(int pDepth)
pDepth
- the Depthpublic int getDepth()
public void setDepthSet(boolean pDepthSet)
pDepthSet
- the DepthSetpublic boolean isDepthSet()
public static ComponentConfiguration create(java.lang.String pName, boolean pDefaultIncludes)
pName
- the component namepDefaultIncludes
- the defaultIncludes setting
public static ComponentConfiguration create(java.lang.String pName, java.lang.String pItemDescriptorName, boolean pDefaultIncludes)
pName
- the repository component namepItemDescriptorName
- the item descriptor namepDefaultIncludes
- the defaultIncludes setting
public void addFilteredProperty(java.lang.String pName, boolean pHidden, boolean pWritable, java.lang.String pTarget, java.lang.String pComponentName, java.lang.String pPropertyCustomizer) throws RestInitializationException
pName
- the name of the property to filterpHidden
- flag indicating whether the property is hidden from REST GET requestspWritable
- flag indicating whether the property is writable for REST POST or PUT requestspTarget
- the name of a property to return the value for this propertypComponentName
- the nucleus path of a component to retrieve the value frompPropertyCustomizer
- the name of a class which implements RestPropertyCustomizer from which to retrieve the value
RestInitializationException
- if the filtered property cannot be configured because of a misconfigurationpublic void addFilteredProperty(java.lang.String pName, boolean pHidden, boolean pWritable, boolean pExpand, java.lang.String pTarget, java.lang.String pComponentName, java.lang.String pPropertyCustomizer) throws RestInitializationException
pName
- the name of the property to filterpHidden
- flag indicating whether the property is hidden from REST GET requestspWritable
- flag indicating whether the property is writable for REST POST or PUT requestspExpand
- flag indicating whether the property is expandablepTarget
- the name of a property to return the value for this propertypComponentName
- the nucleus path of a component to retrieve the value frompPropertyCustomizer
- the name of a class which implements RestPropertyCustomizer from which to retrieve the value
RestInitializationException
- if the filtered property cannot be configured because of a misconfigurationpublic PropertyConfiguration getFilteredProperty(java.lang.String pName)
pName
- the property name for which to retrieve the property configuration
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |