Sun Adapter for LDAP API

com.stc.connector.appconn.ldap
Interface STCValue

All Known Implementing Classes:
STCValueImpl

public interface STCValue

STC Value interface used for storing the actual value of an attribute's value.

Version:
$Revision: 1.3 $
Author:

Method Summary
 byte[] getByteValue()
          Retrieves the value from the value Object as a byte array
 java.lang.String getStringValue()
          Retrieves the String value from the value Object
 java.lang.Object getValue()
          Returns the value from the value Object as an Object
 boolean isByteArray()
          Checks whether the value is a byte array
 boolean isString()
          Checks whether the value is a String
 void reset()
          Method to reset the values
 void setByteValue(byte[] byteVal)
          Sets the byte value for the value Object
 void setStringValue(java.lang.String strVal)
          Sets the String value for the value Object
 void setValue(java.lang.Object val)
          Sets the value for the value Object as an Object
 

Method Detail

isByteArray

boolean isByteArray()
                    throws LDAPApplicationException
Checks whether the value is a byte array

Returns:
true if the value is a byte array
Throws:
LDAPApplicationException - if the type of the value cannot be determined

isString

boolean isString()
                 throws LDAPApplicationException
Checks whether the value is a String

Returns:
true if the value is a String
Throws:
LDAPApplicationException - if the type of the value cannot be determined

getStringValue

java.lang.String getStringValue()
                                throws LDAPApplicationException
Retrieves the String value from the value Object

Returns:
the String value of the value Object
Throws:
LDAPApplicationException - if the value is not of type String or if there is no value

setStringValue

void setStringValue(java.lang.String strVal)
Sets the String value for the value Object

Parameters:
strVal - the String value of the value Object

getByteValue

byte[] getByteValue()
                    throws LDAPApplicationException
Retrieves the value from the value Object as a byte array

Returns:
the value of the value Object as a byte array
Throws:
LDAPApplicationException - if the value is not of type byte array or if there is no value

setByteValue

void setByteValue(byte[] byteVal)
Sets the byte value for the value Object

Parameters:
byteVal - the String value of the value Object

setValue

void setValue(java.lang.Object val)
              throws LDAPApplicationException
Sets the value for the value Object as an Object

Parameters:
val - the value of the value Object as an Object
Throws:
LDAPApplicationException - if the value is not of one of the supported types

getValue

java.lang.Object getValue()
                          throws LDAPApplicationException
Returns the value from the value Object as an Object

Returns:
the value of the value Object as an Object
Throws:
LDAPApplicationException - if there is no value

reset

void reset()
Method to reset the values


Sun Adapter for LDAP API