|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface that manipulates document properties. Note: It is possible to set invalid properties (non-document properties) on objects of this type, however this is not recommended and will result in unexpected behavior when the object is saved.
Method Summary | |
java.util.Date |
getDateValue(int propertyID)
Gets a document property as a date . |
double |
getDoubleValue(int propertyID)
Gets a document property as a double . |
int[] |
getIDs()
Gets the available property IDs. |
int |
getIntegerValue(int propertyID)
Gets a document property as an int . |
java.lang.String |
getStringValue(int propertyID)
Gets a document property as a String . |
java.lang.Object |
getValue(int propertyID)
Gets a document property as an Object . |
boolean |
hasValue(int propertyID)
Determines whether a specific value is present. |
void |
remove(int propertyID)
Removes a document property. |
void |
setDateValue(int propertyID,
java.util.Date value)
Sets a document property as a date . |
void |
setDoubleValue(int propertyID,
double value)
Sets a document property as a double . |
void |
setIntegerValue(int propertyID,
int value)
Sets a document property as an int . |
void |
setStringValue(int propertyID,
java.lang.String value)
Sets a document property as a String . |
Method Detail |
public int[] getIDs()
public java.lang.Object getValue(int propertyID)
Object
.
propertyID
- the ID of the property for which to get a value
public java.lang.String getStringValue(int propertyID)
String
.
propertyID
- the ID of the property for which to get a value
java.lang.ClassCastException
- if the property type is not a String
public void setStringValue(int propertyID, java.lang.String value)
String
.
Note: Type checking for property values does not occur, thus setting a property value using an incorrect object
type can result in an inconsistent state.
propertyID
- the ID of the property to setvalue
- the value to set the property topublic int getIntegerValue(int propertyID)
int
.
propertyID
- the property ID for which to get a value
java.lang.ClassCastException
- if the property type is not an int
public void setIntegerValue(int propertyID, int value)
int
.
Note: Type checking for property values does not occur, thus setting a property value using an incorrect object
type can result in an inconsistent state.
propertyID
- the property ID of the int property to setvalue
- the value to set the property topublic java.util.Date getDateValue(int propertyID)
date
.
propertyID
- the property ID for which to get a value
java.lang.ClassCastException
- if the property type is not a date
public void setDateValue(int propertyID, java.util.Date value)
date
.
Note: Type checking for property values does not occur, thus setting a property value using an incorrect object
type can result in an inconsistent state.
propertyID
- the ID of the date property to setvalue
- the value to set the property topublic double getDoubleValue(int propertyID)
double
.
propertyID
- the ID of the document property for which to get a value
java.lang.ClassCastException
- if the property type is not a double
public void setDoubleValue(int propertyID, double value)
double
.
Note: Type checking for property values does not occur, thus setting a property value using an incorrect object
type can result in an inconsistent state.
propertyID
- the ID of the document property to setvalue
- the value to set the property topublic boolean hasValue(int propertyID)
propertyID
- the ID of the property to check
true
if and only if the value is presentpublic void remove(int propertyID)
propertyID
- the property ID of the property to remove
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.