public class BrowseKey
extends java.lang.Object
implements java.io.Externalizable
null
then this key references to all browses.Modifier and Type | Field and Description |
---|---|
static BrowseKey |
ALL_BROWSES_KEY
The key which matches "all browses" case.
|
java.lang.String |
ehKeyBrowseName
Browse name.
|
java.lang.String |
ehKeyProcName
The name of the parent external procedure which contains the browse.
|
java.lang.String |
ehStartColumnKeys
String representing the set of the keys of the columns which the browse has at the enhanced
initialization time.
|
java.lang.String |
ehUniqueKey
Part of the key: an unique string, which, along with procedure name and browse name, uniquely identifies
the browse in an application.
|
Constructor and Description |
---|
BrowseKey()
Default constructor.
|
BrowseKey(BrowseKey key)
Copy constructor.
|
BrowseKey(java.lang.String ehKeyProcName,
java.lang.String ehKeyBrowseName,
java.lang.String ehUniqueKey,
java.lang.String ehStartColumnKeys)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compare two instances.
|
int |
hashCode()
Return a hash code for this object.
|
boolean |
isValid()
Checks that the key is valid.
|
void |
readExternal(java.io.ObjectInput in)
Replacement for the default object reading method.
|
java.lang.String |
toString()
Create a string representation of this key, primarily for debug purposes.
|
void |
writeExternal(java.io.ObjectOutput out)
Replacement for the default object writing method.
|
public static final BrowseKey ALL_BROWSES_KEY
public java.lang.String ehKeyProcName
null
if the key is applied to all browses.public java.lang.String ehKeyBrowseName
public java.lang.String ehUniqueKey
public java.lang.String ehStartColumnKeys
buffer_alias.field_name
. For calculated and computed columns it is an expression containing
column parameters like column data type, format, initial value and label. Keys are separated with ";"
and lexicographically sorted within the string (for easy comparison). The string cannot contain empty
keys.public BrowseKey()
public BrowseKey(java.lang.String ehKeyProcName, java.lang.String ehKeyBrowseName, java.lang.String ehUniqueKey, java.lang.String ehStartColumnKeys)
ehKeyProcName
- The name of the parent external procedure which contains the browse.
null
if the key is applied to all browses.ehKeyBrowseName
- Browse name.ehUniqueKey
- An arbitrary key, which along with the browse name and the name of the currently executing
procedure, should uniquely identify the browse in an application.ehStartColumnKeys
- String representing the set of the keys of the columns which the browse has at the enhanced
initialization time. See ehStartColumnKeys
.public BrowseKey(BrowseKey key)
key
- Key to copy.public boolean isValid()
false
if this key
is a key that references ALL browses.true
if the key is valid. false
if the key is invalid
OR if it is a key that references ALL browses.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- An object to compare with.true
if the two keys are identical.public int hashCode()
hashCode
in class java.lang.Object
public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
out
- The output destination to which fields will be saved.java.io.IOException
- In case of I/O errors.public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
in
- The input source from which fields will be restored.java.io.IOException
- In case of I/O errors.java.lang.ClassNotFoundException
- If payload can't be instantiated.public java.lang.String toString()
toString
in class java.lang.Object