|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A Value
object is a value associated with a
Property
object. A property's value
is either a simple Java type (such as int) or an object. If the value is an
object, that object can either be a scalar object (such as a Document
,
Folder
, etc.), or a collection of values held in a Values
collection.
If a property's value is a Values
collection, the property is
termed a multi-valued property. Each Value
object in the
collection is of the same type (you cannot have a multi-valued property
consisting of heterogeneous data types).
To instantiate a Value
object, call the
getValueObject
method
on a Property
object. If
you are working with a multi-valued property, you can create empty
Value
objects to use in a Values
collection. For
more information, see the Values
interface.
Method Summary | |
boolean |
equals(java.lang.Object o)
Not Implemented in CS Java Connector v3.0. |
byte[] |
getBinaryValue()
For convenience, returns this Value object cast or converted to a byte array.
|
boolean |
getBooleanValue()
For convenience, returns this Value object cast or converted to a boolean.
|
java.util.Date |
getDateValue()
For convenience, returns this Value object cast or converted to a Date.
|
double |
getDoubleValue()
For convenience, returns this Value object cast or converted to a double.
|
int |
getIntValue()
For convenience, returns this Value object cast or converted to an
int .
|
java.lang.String |
getStringValue()
For convenience, returns this Value object cast or converted to a String.
|
int |
getType()
Returns the data type for this Value object.
|
java.lang.Object |
getValue()
Returns the value associated with this Value object.
|
Values |
getValuesValue()
For convenience, returns this Value object cast or converted to a
Values collection.
|
int |
hashCode()
Not Implemented in CS Java Connector v3.0. |
boolean |
hasNullValue()
Reports whether the value of this Value object is null or not. |
void |
setValue(boolean boolValue)
Sets the value of this Value object to the specified
boolean value.
|
void |
setValue(java.lang.Boolean boolValue)
Sets the value of this Value object to the specified
Boolean value.
|
void |
setValue(byte[] byteArrayValue)
Sets the value of this Value object to the specified
byte array value.
|
void |
setValue(java.util.Date dateTimeValue)
Sets the value of this Value object to the specified
Date value. |
void |
setValue(double float64Value)
Sets the value of this Value object to the specified
double value.
|
void |
setValue(java.lang.Double float64Value)
Sets the value of this Value object to the specified
Double value.
|
void |
setValue(int intValue)
Sets the value of this Value object to the specified
integer value.
|
void |
setValue(java.lang.Integer intValue)
Sets the value of this Value object to the specified
Integer value.
|
void |
setValue(java.lang.String stringValue)
Sets the value of this Value object to the specified
String value.
|
void |
setValue(ValueObject objectValue)
Sets the value of this Value object to the specified
ValueObject object.
|
Method Detail |
public java.lang.Object getValue()
Value
object.
Value
object. For multi-valued properties, the returned object is a
Values
collection.public boolean hasNullValue()
Value
object is null or not. A value
is typically null when a property's value has not been set in the Content
Services server. For values that represent Java objects, you can simply get
the value and test against null
. For primitive types, where
null cannot be returned, the get[type]Value
methods return a
default value. Use the hasNullValue
method to distinguish
between the two cases.
true
if the value of this Value
object is null (or an empty
string, if this Value
object is a String); otherwise returns
false
.public byte[] getBinaryValue()
Value
object cast or converted to a byte array.
byte
array that is the value associated with this
Value
object.public boolean getBooleanValue()
Value
object cast or converted to a boolean.
boolean
that is the value associated with this
Value
object. Returns false
in the case
of a null value.public java.util.Date getDateValue()
Value
object cast or converted to a Date.
Value
object.public double getDoubleValue()
Value
object cast or converted to a double.
Value
object. Returns Double.NaN
in the case of a null value.public int getIntValue()
Value
object cast or converted to an
int
.
int
that is the value associated with this
Value
object. Returns Integer.MIN_VALUE
in the case of a null value.public java.lang.String getStringValue()
Value
object cast or converted to a String.
Value
object.public Values getValuesValue()
Value
object cast or converted to a
Values
collection.
Values
collection that is the value associated with
this Value
object.public int getType()
Value
object.
Value
object.
See the Property
interface's
TYPE_
constants for the possible returned values.
java.lang.NullPointerException
- Thrown if Value
is null or TYPE_UNSPECIFIED
.public void setValue(byte[] byteArrayValue)
Value
object to the specified
byte
array value.
byteArrayValue
- Specifies the value to set for this Value
object.public void setValue(java.lang.Integer intValue)
Value
object to the specified
Integer
value.
intValue
- Specifies the value to set for this Value
object.public void setValue(int intValue)
Value
object to the specified
integer
value.
intValue
- Specifies the value to set for this Value
object.public void setValue(java.lang.String stringValue)
Value
object to the specified
String
value.
stringValue
- Specifies the value to set for this Value
object.public void setValue(java.lang.Double float64Value)
Value
object to the specified
Double
value.
float64Value
- Specifies the value to set for this Value
object. If Double.NaN, sets the value to null
; if Double.POSITIVE_INFINITY,
sets the value to Double.MAX_VALUE; if Double.NEGATIVE_INFINITY,
sets the value to -Double.MAX_VALUE (i.e., negative Double.MAX_VALUE).public void setValue(double float64Value)
Value
object to the specified
double
value.
float64Value
- Specifies the value to set for this Value
object. If Double.NaN, sets the value to null
; if Double.POSITIVE_INFINITY,
sets the value to Double.MAX_VALUE; if Double.NEGATIVE_INFINITY,
sets the value to -Double.MAX_VALUE (i.e., negative Double.MAX_VALUE).public void setValue(ValueObject objectValue)
Value
object to the specified
ValueObject
object.
objectValue
- Specifies the value to set for this Value
object.public void setValue(java.util.Date dateTimeValue)
Value
object to the specified
Date
value. Date values for properties are limited to the
range 1 January 1753 and 31 December 2078, inclusive.
dateTimeValue
- Specifies the value to set for this Value
object.public void setValue(java.lang.Boolean boolValue)
Value
object to the specified
Boolean
value.
boolValue
- Specifies the value to set for this Value
object.public void setValue(boolean boolValue)
Value
object to the specified
boolean
value.
boolValue
- Specifies the value to set for this Value
object.public boolean equals(java.lang.Object o)
Not Implemented in CS Java Connector v3.0.
Indicates whether some otherValue
object is logically equal
to this Value
object, meaning that the two Value
objects have the same data type and contain the same value. For example,
use this method to discover whether a value is already contained in a
Values
collection. This method returns true if both of the
following conditions are met:
Value
objects have the same type (as reported by
Value.getType()
).Value
objects (as reported by
Value.getValue()
) are equal.
o
- The Value
object with which to compare.
true
if this Value
object is logically
equal to the Value
object specified in the o
argument; otherwise false
.public int hashCode()
Not Implemented in CS Java Connector v3.0.
Returns an integer for the hash code for thisValue
object.
The hash code is used for storing and retrieving a reference to this object
in a Hashtable data structure.
Value
object.
|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |