public class CSState
extends java.lang.Object
implements java.io.Serializable
CSItem
object with which it is
associated. The getStatus
method on CSItem
provides access to the status
value currently held within this object.
For example, the CSState
object associated with a CSArticle
instance holds information about
the state of the article.
CSItem
,
CSItemContent
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
ACCESS_GRANTED
A valid value that can be set by the query methods to indicate the status of retrieved/updated data.
|
static int |
DOES_NOT_EXIST
A valid value that can be set by the query methods to indicate the status of retrieved/updated data.
|
static int |
EMPTY
A valid value that can be set by the query methods to indicate the status of retrieved/updated data.
|
static int |
EXISTS
A valid value that can be set by the query methods to indicate the status of retrieved/updated data.
|
static int |
SECURE_ACCESS_DENIED
A valid value that can be set by the query methods to indicate the status of retrieved/updated data.
|
static int |
SECURE_ACCESS_GRANTED
A valid value that can be set by the query methods to indicate the status of retrieved/updated data.
|
Constructor and Description |
---|
CSState()
Creates an empty
CSState object. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Creates a duplicate of this
CSState object. |
int |
getStatus()
Gets the status of the
CSItem object with which this CSState object is associated. |
void |
setStatus(int status)
Sets the status of the
CSItem object with which this CSState object is associated. |
java.lang.String |
toString()
Provides debug information on the contents of the
CSState object. |
public static final int DOES_NOT_EXIST
DOES_NOT_EXIST
is used by the exist
method to indicate that no item
matching the supplied key information exists on the database.public static final int EXISTS
EXISTS
is used by the exist
method to indicate that an item
matching the supplied key information exists on the database.public static final int ACCESS_GRANTED
ACCESS_GRANTED
is used to indicate that the query was processed successfully.public static final int SECURE_ACCESS_GRANTED
SECURE_ACCESS_GRANTED
is used to indicate that a query on a secure item was processed successfully
i.e. access was given.public static final int SECURE_ACCESS_DENIED
SECURE_ACCESS_DENIED
is used to indicate that a query on a secure item was unsuccessful i.e.
access was not given.public static final int EMPTY
EMPTY
may be used to indicate that this item has been populated with default data.public void setStatus(int status)
CSItem
object with which this CSState
object is associated.status
- the status of the associated CSItem
object.public int getStatus()
CSItem
object with which this CSState
object is associated.
CSItem
object.public java.lang.String toString()
CSState
object.
toString
in class java.lang.Object
String
containing the user-friendly output.public java.lang.Object clone() throws java.lang.OutOfMemoryError
CSState
object.
clone
in class java.lang.Object
CSState
object.java.lang.OutOfMemoryError
- if there are any problems allocating memory.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.