|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.4.0) E15995-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.wcps.property.model.Timestamped
oracle.wcps.property.model.PropertyDefinition
public class PropertyDefinition
An implementation of IPropertyDefinition
. Use the builder builder(oracle.wcps.property.Type, boolean)
to create an instance of this.
Nested Class Summary | |
---|---|
static class |
PropertyDefinition.Builder The builder used for creating a PropertyDefinition . |
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. |
static PropertyDefinition.Builder |
builder(Type dataType, boolean restricted) Returns an instance of Builder to create a PropertyDefinition. |
boolean |
containsValue(java.io.Serializable value) |
boolean |
equals(java.lang.Object o) |
java.io.Serializable |
getDefaultValue() |
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. |
java.lang.Object |
getRPropertyDefinition() |
Type |
getType() Returns the property value's type, one of Type enums. |
IValidator |
getValidator() |
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. |
int |
hashCode() |
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> defaultValues) 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 propertyDefinitionName) Sets the given propertydefinition name as the name for this. |
void |
setNamespaceName(INamespaceName namespaceName) Sets the given namespaceName as the associated namespace name. |
void |
setRestricted(boolean restricted) 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> restrictedValues) Sets the given values as the restricted values set for this. |
void |
setRPropertyDefinition(java.lang.Object rPropertyDefinition) |
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 validatorValue) Sets the given value as the validator value to be passed to an instance of the custom validator class set in this. |
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 |
---|
public INamespaceName getNamespaceName()
IPropertyDefinition
getNamespaceName
in interface IPropertyDefinition
public void setNamespaceName(INamespaceName namespaceName)
IPropertyDefinition
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()
setNamespaceName
in interface IPropertyDefinition
namespaceName
- the namespace name to which this will be associated.public java.lang.String name()
IPropertyDefinition
name
in interface IPropertyDefinition
public IPropertyDefinitionName getName()
IPropertyDefinition
getName
in interface IPropertyDefinition
public void setName(IPropertyDefinitionName propertyDefinitionName)
IPropertyDefinition
name
as the name for this.setName
in interface IPropertyDefinition
propertyDefinitionName
- a propertydefinition name.public java.lang.String getDescription()
IPropertyDefinition
getDescription
in interface IPropertyDefinition
public void setDescription(java.lang.String desc)
IPropertyDefinition
desc
as a brief description for this.setDescription
in interface IPropertyDefinition
desc
- a brief description.public Type getType()
IPropertyDefinition
Type
enums. This enum type used for validating property value for a property referring this.getType
in interface IPropertyDefinition
public void setType(Type type)
IPropertyDefinition
type
as this propertydefinition's type.setType
in interface IPropertyDefinition
type
- the enum type.public boolean isRestricted()
IPropertyDefinition
isRestricted
in interface IPropertyDefinition
public void setRestricted(boolean restricted)
IPropertyDefinition
value
to indicate if a property's values are restricted or not. Make sure to add values to the restricted values set for this.setRestricted
in interface IPropertyDefinition
restricted
- a boolean value.public java.util.List<? extends java.io.Serializable> getRestrictedValues()
IPropertyDefinition
getRestrictedValues
in interface IPropertyDefinition
public void setRestrictedValues(java.util.List<? extends java.io.Serializable> restrictedValues)
IPropertyDefinition
values
as the restricted values set for this. The values type should match the type returned by IPropertyDefinition.getType()
.setRestrictedValues
in interface IPropertyDefinition
restrictedValues
- a restricted values set for this.public boolean addRestrictedValue(java.io.Serializable value)
IPropertyDefinition
value
to the restricted values set.addRestrictedValue
in interface IPropertyDefinition
value
- a restricted value.value
is added successfully.public boolean removeRestrictedValue(java.io.Serializable value)
IPropertyDefinition
value
from the restricted values set.removeRestrictedValue
in interface IPropertyDefinition
value
- a restricted value, a member of the restricted values set.value
is removed successfully.public java.util.List<? extends java.io.Serializable> getDefaultValues()
IPropertyDefinition
getDefaultValues
in interface IPropertyDefinition
public void setDefaultValues(java.util.List<? extends java.io.Serializable> defaultValues)
IPropertyDefinition
values
as the default value(s) set for this. The values
type should match the type returned by IPropertyDefinition.getType()
.setDefaultValues
in interface IPropertyDefinition
defaultValues
- a default values set for this.public boolean addDefaultValue(java.io.Serializable value)
IPropertyDefinition
value
to the default values set for this.addDefaultValue
in interface IPropertyDefinition
value
- a default value.value
is added successfully.public boolean removeDefaultValue(java.io.Serializable value)
IPropertyDefinition
value
from the default values set.removeDefaultValue
in interface IPropertyDefinition
value
- a default value, a member of the default values set.value
is removed successfully.public java.lang.String getValidatorClassName()
IPropertyDefinition
getValidatorClassName
in interface IPropertyDefinition
public void setValidatorClassName(java.lang.String validatorClassName)
IPropertyDefinition
validatorClassName
as the custom validator class used to further validate a property's value. The custom validator class should implement IValidator
interface.setValidatorClassName
in interface IPropertyDefinition
validatorClassName
- a fully qualified custom validate class name.public java.lang.String getValidatorValue()
IPropertyDefinition
getValidatorValue
in interface IPropertyDefinition
public void setValidatorValue(java.lang.String validatorValue)
IPropertyDefinition
setValidatorValue
in interface IPropertyDefinition
validatorValue
- the string representation of the validator value.public java.lang.Object getRPropertyDefinition()
public void setRPropertyDefinition(java.lang.Object rPropertyDefinition)
public boolean equals(java.lang.Object o)
equals
in class Timestamped
public int hashCode()
hashCode
in class Timestamped
public java.lang.String toString()
toString
in class java.lang.Object
public java.io.Serializable getDefaultValue()
public static PropertyDefinition.Builder builder(Type dataType, boolean restricted)
dataType
- the type of property value that this propertydefinition instance will validate.restricted
- indicates if the property value should be treated as restricted or not.public boolean containsValue(java.io.Serializable value)
public IValidator getValidator()
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.4.0) E15995-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |