|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPropertyDefinition
Represents a namespace scoped definition for a property's value. This defines following features for a property's value.
Type
for a property value.isRestricted()
returns to true, the restricted values set shouldn't be empty. The value of a property referring this should be the member of the restricted values set.IValidator
interface that is used for further validation of the value of a property referring this.This is used by creating a property mapping IPropertyMapping
of a property name IAbstractProperty.getName()
and name of this getName()
in a propertysetdefinition IPropertySetDefinition
. The value of a property will be validated for the above features by the property service and ValidationFailedException
is thrown if validation fails.
IPropertySetDefinition
, IPropertyMapping
, IValidator
Method Summary | |
---|---|
boolean |
addDefaultValue(java.io.Serializable value) Adds the given value to the default values set for this. |
boolean |
addRestrictedValue(java.io.Serializable value) Adds the given value to the restricted values set. |
java.util.List<? extends java.io.Serializable> |
getDefaultValues() Returns the set of default value(s). |
java.lang.String |
getDescription() Returns a brief description of this. |
IPropertyDefinitionName |
getName() Returns the propertydefinition name of this. |
INamespaceName |
getNamespaceName() Returns the associated namespace name. |
java.util.List<? extends java.io.Serializable> |
getRestrictedValues() Returns the set of restricted values. |
Type |
getType() Returns the property value's type, one of Type enums. |
java.lang.String |
getValidatorClassName() Returns the custom validator class name associated with this. |
java.lang.String |
getValidatorValue() Returns the validator value to be passed to the custom validator class associated with this. |
boolean |
isRestricted() Indicates if a property's value(s) is/are restricted or not. |
java.lang.String |
name() Returns the string representation of the composite name of this. |
boolean |
removeDefaultValue(java.io.Serializable value) Removes the given value from the default values set. |
boolean |
removeRestrictedValue(java.io.Serializable value) Removes the given value from the restricted values set. |
void |
setDefaultValues(java.util.List<? extends java.io.Serializable> values) Sets the given values as the default value(s) set for this. |
void |
setDescription(java.lang.String desc) Sets the given desc as a brief description for this. |
void |
setName(IPropertyDefinitionName name) Sets the given propertydefinition name as the name for this. |
void |
setNamespaceName(INamespaceName namespaceName) Deprecated. it is a no op. |
void |
setRestricted(boolean value) Sets the given boolean value to indicate if a property's values are restricted or not. |
void |
setRestrictedValues(java.util.List<? extends java.io.Serializable> values) Sets the given values as the restricted values set for this. |
void |
setType(Type type) Sets the given enum type as this propertydefinition's type. |
void |
setValidatorClassName(java.lang.String validatorClassName) Sets the given validatorClassName as the custom validator class used to further validate a property's value. |
void |
setValidatorValue(java.lang.String value) Sets the given value as the validator value to be passed to an instance of the custom validator class set in this. |
Methods inherited from interface oracle.wcps.property.ITimestamped |
---|
getCreatedOn, getUpdatedOn, setCreatedOn, setUpdatedOn |
Method Detail |
---|
INamespaceName getNamespaceName()
void setNamespaceName(INamespaceName namespaceName)
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()
namespaceName
- the namespace name to which this will be associated.java.lang.String name()
IPropertyDefinitionName getName()
void setName(IPropertyDefinitionName name)
name
as the name for this.name
- a propertydefinition name.java.lang.String getDescription()
void setDescription(java.lang.String desc)
desc
as a brief description for this.desc
- a brief description.Type getType()
Type
enums. This enum type used for validating property value for a property referring this.void setType(Type type)
type
as this propertydefinition's type.type
- the enum type.boolean isRestricted()
void setRestricted(boolean value)
value
to indicate if a property's values are restricted or not. Make sure to add values to the restricted values set for this.value
- a boolean value.java.util.List<? extends java.io.Serializable> getRestrictedValues()
void setRestrictedValues(java.util.List<? extends java.io.Serializable> values)
values
as the restricted values set for this. The values type should match the type returned by getType()
.values
- a restricted values set for this.java.lang.IllegalStateException
- if isRestricted()
returns false. Call setRestricted(boolean)
with the true value before calling this method to avoid getting this exception.boolean addRestrictedValue(java.io.Serializable value)
value
to the restricted values set.value
- a restricted value.value
is added successfully.java.lang.IllegalStateException
- if isRestricted()
returns false. Call setRestricted(boolean)
with the true value before calling this method to avoid getting this exception.boolean removeRestrictedValue(java.io.Serializable value)
value
from the restricted values set.value
- a restricted value, a member of the restricted values set.value
is removed successfully.java.lang.IllegalStateException
- if isRestricted()
returns false. Call setRestricted(boolean)
with true value before calling this method to avoid getting this exception.java.util.List<? extends java.io.Serializable> getDefaultValues()
void setDefaultValues(java.util.List<? extends java.io.Serializable> values)
values
as the default value(s) set for this. The values
type should match the type returned by getType()
.values
- a default values set for this.boolean addDefaultValue(java.io.Serializable value)
value
to the default values set for this.value
- a default value.value
is added successfully.boolean removeDefaultValue(java.io.Serializable value)
value
from the default values set.value
- a default value, a member of the default values set.value
is removed successfully.java.lang.String getValidatorClassName()
void setValidatorClassName(java.lang.String validatorClassName)
validatorClassName
as the custom validator class used to further validate a property's value. The custom validator class should implement IValidator
interface.validatorClassName
- a fully qualified custom validate class name.java.lang.String getValidatorValue()
void setValidatorValue(java.lang.String value)
value
- the string representation of the validator value.
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.9.0) E15995-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |