com.ibm.pim.interfaces.userdefinedlogs
Interface UserDefinedLogEntry


public interface UserDefinedLogEntry

Read-write interface for a user-defined log entry


Field Summary
static java.lang.String copyright
           
 
Method Summary
 void delete()
          Delete this log entry
 java.lang.String getValue()
          Returns the string description stored in this log entry
 void save()
          Save this log entry.
 void setValue(java.lang.String logValue)
          Store a string with this log entry, overwriting any previous string.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

save

void save()
          throws PIMInternalException,
                 PIMAuthorizationException
Save this log entry. This must be done after creation or set value.

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

delete

void delete()
            throws PIMInternalException,
                   PIMAuthorizationException
Delete this log entry

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

setValue

void setValue(java.lang.String logValue)
              throws PIMInternalException,
                     PIMAuthorizationException
Store a string with this log entry, overwriting any previous string.

Parameters:
logValue - - The string value to be recorded in this log entry
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation *

getValue

java.lang.String getValue()
                          throws PIMInternalException,
                                 PIMAuthorizationException
Returns the string description stored in this log entry

Returns:
String - the log entry
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation