|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserDefinedLog
Interface for UserDefinedLog object
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 |
---|
static final java.lang.String copyright
Method Detail |
---|
boolean isRunningLog()
PIMInternalException
- If an internal error occursPIMCollection<UserDefinedLogEntry> getLogEntries()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalStateException
- If the UserDefinedLog has not yet been persistedvoid setName(java.lang.String name)
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 stringvoid setDescription(java.lang.String description)
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid setRunningLog(boolean runningLog)
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid save()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future usevoid delete()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future usevoid deleteAllEntries()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalStateException
- If the UserDefinedLog has not yet been persistedjava.lang.String getDescription()
PIMInternalException
- If an internal error occurs.void accept(UserDefinedLogWriter udlWriter)
udlWriter
- An implementation of the UserDefinedLogWriter.
PIMInternalException
- If an internal error occurs.
java.lang.IllegalArgumentException
- If udlWriter is nulljava.lang.String getName()
PIMInternalException
- If an internal error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |