com.ibm.pim.userdefinedlog
Interface UserDefinedLog

All Known Subinterfaces:
CategoryUserDefinedLog, ItemUserDefinedLog

public interface UserDefinedLog

Interface for UserDefinedLog object

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void accept(UserDefinedLogWriter udlWriter)
          Writes the UserDefinedLogEntries.
 void delete()
          Deletes the UserDefinedLog
 void deleteAllEntries()
          Deletes all user defined log entries from this UserDefinedLog.If there are no entries corresponding to the category/item, the method does not delete any entries.
 java.lang.String getDescription()
          Fetches the description of this user defined log.
 PIMCollection<UserDefinedLogEntry> getLogEntries()
          Retrieves all UserDefinedLogEntry objects associated with this UserDefinedLog
 java.lang.String getName()
          Returns the name for this UserDefinedLog
 boolean isRunningLog()
          Determine whether this log is currently running
 void save()
          Saves modifications to the UserDefinedLog object
 void setDescription(java.lang.String description)
          Sets the description of a UserDefinedLog
 void setName(java.lang.String name)
          Sets the name of a UserDefinedLog
 void setRunningLog(boolean runningLog)
          Sets or unsets the running log behavior of a UserDefinedLog
 

Field Detail

copyright

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

isRunningLog

boolean isRunningLog()
Determine whether this log is currently running

Returns:
boolean true if this is a running log, false otherwise
Throws:
PIMInternalException - If an internal error occurs

getLogEntries

PIMCollection<UserDefinedLogEntry> getLogEntries()
Retrieves all UserDefinedLogEntry objects associated with this UserDefinedLog

Returns:
A PIMCollection of UserDefinedLogEntry objects. Please note this is a lazily instantiated collection
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalStateException - If the UserDefinedLog has not yet been persisted

setName

void setName(java.lang.String name)
Sets the name of a UserDefinedLog

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If name is null or if the name is an empty string

setDescription

void setDescription(java.lang.String description)
Sets the description of a UserDefinedLog

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

setRunningLog

void setRunningLog(boolean runningLog)
Sets or unsets the running log behavior of a UserDefinedLog

Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

save

void save()
Saves modifications to the UserDefinedLog object

Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use

delete

void delete()
Deletes the UserDefinedLog

Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use

deleteAllEntries

void deleteAllEntries()
Deletes all user defined log entries from this UserDefinedLog.If there are no entries corresponding to the category/item, the method does not delete any entries.

Throws:
PIMInternalException - If an internal error occurs.
PIMAuthorizationException - Reserved for future use
java.lang.IllegalStateException - If the UserDefinedLog has not yet been persisted

getDescription

java.lang.String getDescription()
Fetches the description of this user defined log.

Returns:
The UserDefinedLog's description as a String.
Throws:
PIMInternalException - If an internal error occurs.

accept

void accept(UserDefinedLogWriter udlWriter)
Writes the UserDefinedLogEntries. The logic for writing the UserDefinedLogEntries has to be present in the visit method of the UserDefinedLogWriter. The format in which the log has to be written can be determined by the user.

Parameters:
udlWriter - An implementation of the UserDefinedLogWriter.
Throws:
PIMInternalException - If an internal error occurs.
java.lang.IllegalArgumentException - If udlWriter is null

getName

java.lang.String getName()
Returns the name for this UserDefinedLog

Returns:
The name of the UserDefinedLog
Throws:
PIMInternalException - If an internal error occurs