com.ibm.pim.interfaces.userdefinedlogs
Interface UserDefinedLog


public interface UserDefinedLog

Read-write interface for UserDefinedLog object


Field Summary
static java.lang.String copyright
          IBM standard copyright
 
Method Summary
 UserDefinedLogEntry createLogEntry(Category category, Item item, java.lang.String entry)
          Creates a UserDefinedLogEntry for a specific category & item
 java.lang.String getDisplayName()
          Returns the display name for this UserDefinedLog
 PIMCollection getLogEntries()
          Retrieves all UserDefinedLogEntrys associated with this UserDefinedLog
 PIMCollection getLogEntry(Item logKey)
          Retrieves all UserDefinedLogEntrys associated with a specific item
 boolean isRunningLog()
          Determine whether this log is currently running
 

Field Detail

copyright

public static final java.lang.String copyright
IBM standard copyright
Method Detail

getDisplayName

public java.lang.String getDisplayName()
                                throws PIMInternalException,
                                       PIMAuthorizationException
Returns the display name for this UserDefinedLog
Returns:
The name of the UserDefinedLog
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation

isRunningLog

public boolean isRunningLog()
                     throws PIMInternalException,
                            PIMAuthorizationException
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
PIMAuthorizationException - If the user is not allowed to perform this operation

getLogEntry

public PIMCollection getLogEntry(Item logKey)
                          throws PIMInternalException,
                                 PIMAuthorizationException
Retrieves all UserDefinedLogEntrys associated with a specific item
Parameters:
logKey - The Item for which to retrieve UserDefinedLogEntrys
Returns:
A PIMCollection of UserDefinedLogEntry objects. Please note this is a lazily instantiated collection
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation
See Also:
for more info, UserDefinedLogEntry

createLogEntry

public UserDefinedLogEntry createLogEntry(Category category,
                                          Item item,
                                          java.lang.String entry)
                                   throws PIMInternalException,
                                          PIMAuthorizationException
Creates a UserDefinedLogEntry for a specific category & item
Parameters:
category - - the Category for which to create a UserDefinedLogEntry
item - - the Item for which to create a UserDefinedLogEntry
entry - - the name for the UserDefinedLogEntry to be created
Returns:
A UserDefinedLogEntry
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation
See Also:
Category, Item

getLogEntries

public PIMCollection getLogEntries()
                            throws PIMInternalException,
                                   PIMAuthorizationException
Retrieves all UserDefinedLogEntrys 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 - If the user is not allowed to perform this operation
See Also:
for more info, UserDefinedLogEntry