Class UpdateCondition
- All Implemented Interfaces:
Serializable
,Cloneable
Specifies the conditions under which data should be updated. If an update condition is specified for a request, the data will only be updated if the condition is satisfied. For example, if an attribute with a specific name and value exists, or if a specific attribute doesn't exist.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for UpdateCondition object.UpdateCondition
(String name, String value, Boolean exists) Constructs a new UpdateCondition object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied.getName()
The name of the attribute involved in the condition.getValue()
The value of an attribute.int
hashCode()
isExists()
A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied.void
A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied.void
The name of the attribute involved in the condition.void
The value of an attribute.toString()
Returns a string representation of this object; useful for testing and debugging.withExists
(Boolean exists) A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied.The name of the attribute involved in the condition.The value of an attribute.
-
Constructor Details
-
UpdateCondition
public UpdateCondition()Default constructor for UpdateCondition object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
UpdateCondition
Constructs a new UpdateCondition object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
name
- The name of the attribute involved in the condition.value
- The value of an attribute. This value can only be specified when theExists
parameter is equal totrue
.exists
- A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specifytrue
if the attribute must exist for the update condition to be satisfied. Specifyfalse
if the attribute should not exist in order for the update condition to be satisfied.
-
-
Method Details
-
setName
The name of the attribute involved in the condition.
- Parameters:
name
- The name of the attribute involved in the condition.
-
getName
The name of the attribute involved in the condition.
- Returns:
- The name of the attribute involved in the condition.
-
withName
The name of the attribute involved in the condition.
- Parameters:
name
- The name of the attribute involved in the condition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setValue
The value of an attribute. This value can only be specified when the
Exists
parameter is equal totrue
.- Parameters:
value
- The value of an attribute. This value can only be specified when theExists
parameter is equal totrue
.
-
getValue
The value of an attribute. This value can only be specified when the
Exists
parameter is equal totrue
.- Returns:
- The value of an attribute. This value can only be specified when
the
Exists
parameter is equal totrue
.
-
withValue
The value of an attribute. This value can only be specified when the
Exists
parameter is equal totrue
.- Parameters:
value
- The value of an attribute. This value can only be specified when theExists
parameter is equal totrue
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setExists
A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify
true
if the attribute must exist for the update condition to be satisfied. Specifyfalse
if the attribute should not exist in order for the update condition to be satisfied.- Parameters:
exists
- A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specifytrue
if the attribute must exist for the update condition to be satisfied. Specifyfalse
if the attribute should not exist in order for the update condition to be satisfied.
-
getExists
A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify
true
if the attribute must exist for the update condition to be satisfied. Specifyfalse
if the attribute should not exist in order for the update condition to be satisfied.- Returns:
- A value specifying whether or not the specified attribute must
exist with the specified value in order for the update condition
to be satisfied. Specify
true
if the attribute must exist for the update condition to be satisfied. Specifyfalse
if the attribute should not exist in order for the update condition to be satisfied.
-
withExists
A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify
true
if the attribute must exist for the update condition to be satisfied. Specifyfalse
if the attribute should not exist in order for the update condition to be satisfied.- Parameters:
exists
- A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specifytrue
if the attribute must exist for the update condition to be satisfied. Specifyfalse
if the attribute should not exist in order for the update condition to be satisfied.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isExists
A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify
true
if the attribute must exist for the update condition to be satisfied. Specifyfalse
if the attribute should not exist in order for the update condition to be satisfied.- Returns:
- A value specifying whether or not the specified attribute must
exist with the specified value in order for the update condition
to be satisfied. Specify
true
if the attribute must exist for the update condition to be satisfied. Specifyfalse
if the attribute should not exist in order for the update condition to be satisfied.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-