atg.rest.filtering

Class PropertyConfiguration

java.lang.Object

atg.rest.filtering.PropertyConfiguration

public class PropertyConfiguration
extends java.lang.Object

This class represents customization information for a single component or item descriptor property. It is used internally by the REST subsystem.

See Also:

FilteringManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComponent() Specifies the nucleus path of a component from which to retrieve the value of the target property.
java.lang.String	getName() Returns the property name for the filtered property
java.lang.String	getPropertyCustomizer() The fully qualified name of a class which implements the RestPropertyCustomizer interface.
RestPropertyCustomizer	getPropertyCustomizerInstance(NameResolver pNameResolver) Returns the instance of the class which implements the RestPropertyCustomizer interface
java.lang.String	getTarget() The name of a property to return for the value of the property specified by the name property
boolean	isExpand() Flag indicating whether or not the property is expandable
boolean	isHidden() Flag indicating whether or not the property is hidden from a REST GET request
boolean	isWritable() Flag indicating whether or not the property is writable from a REST request
void	setComponent(java.lang.String pComponent) Sets the nucleus path of a component.
void	setExpand(boolean pExpand) Sets the flag indicating whether or not the property is expandable
void	setHidden(boolean pHidden) Sets the flag indicating whether or not the property is hidden from a REST GET request
void	setName(java.lang.String pName) Sets the name of the filtered property
void	setPropertyCustomizer(java.lang.String pPropertyCustomizer) Sets the fully qualified name of a class which implements the RestPropertyCustomizer interface.
void	setTarget(java.lang.String pTarget) Sets the target property
void	setWritable(boolean pWritable) Set the flag indicating whether or not the property is writable from a REST request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Method Detail

getName

public java.lang.String getName()

Returns the property name for the filtered property

Returns:

the name of the filtered property

setName

public void setName(java.lang.String pName)

Sets the name of the filtered property

Parameters:

pName - the property name to set

isExpand

public boolean isExpand()

Flag indicating whether or not the property is expandable

Returns:

the value of expand property

setExpand

public void setExpand(boolean pExpand)

Sets the flag indicating whether or not the property is expandable

Parameters:

pExpand - the value to set for the expand property

isHidden

public boolean isHidden()

Flag indicating whether or not the property is hidden from a REST GET request

Returns:

the value of hidden

setHidden

public void setHidden(boolean pHidden)

Sets the flag indicating whether or not the property is hidden from a REST GET request

Parameters:

pHidden - the value to set for the hidden property

isWritable

public boolean isWritable()

Flag indicating whether or not the property is writable from a REST request

Returns:

the value of writable

setWritable

public void setWritable(boolean pWritable)

Set the flag indicating whether or not the property is writable from a REST request

Parameters:

pWritable - the value to set for the writable property

getTarget

public java.lang.String getTarget()

The name of a property to return for the value of the property specified by the name property

Returns:

the value of target

setTarget

public void setTarget(java.lang.String pTarget)

Sets the target property

Parameters:

pTarget - the value to set for the target property

getComponent

public java.lang.String getComponent()

Specifies the nucleus path of a component from which to retrieve the value of the target property. This property is used in conjunction with the target property

Returns:

the value of component

setComponent

public void setComponent(java.lang.String pComponent)

Sets the nucleus path of a component. This property is used in conjunction with the target property

Parameters:

pComponent - the value to set for the component property

getPropertyCustomizer

public java.lang.String getPropertyCustomizer()

The fully qualified name of a class which implements the RestPropertyCustomizer interface. This interface is used to retrieve the value for this property.

Returns:

the value of propertyCustomizer

See Also:

RestPropertyCustomizer

setPropertyCustomizer

public void setPropertyCustomizer(java.lang.String pPropertyCustomizer)
                           throws RestInitializationException

Sets the fully qualified name of a class which implements the RestPropertyCustomizer interface. This interface is used to retrieve the value for this property.

Parameters:

pPropertyCustomizer - the propertyCustomizer to set

Throws:

RestInitializationException - if the class specified does not implement the RestPropertyCustomizer interface

See Also:

RestPropertyCustomizer

getPropertyCustomizerInstance

public RestPropertyCustomizer getPropertyCustomizerInstance(NameResolver pNameResolver)

Returns the instance of the class which implements the RestPropertyCustomizer interface

Returns:

the value of propertyCustomizerInstance