|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Read-write interface for UserDefinedLog object
Field Summary | |
---|---|
static java.lang.String |
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 |
public static final java.lang.String copyright
Method Detail |
public java.lang.String getDisplayName() throws PIMInternalException, PIMAuthorizationException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationpublic boolean isRunningLog() throws PIMInternalException, PIMAuthorizationException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationpublic PIMCollection getLogEntry(Item logKey) throws PIMInternalException, PIMAuthorizationException
logKey
- The Item for which to retrieve UserDefinedLogEntrys
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationfor more info
,
UserDefinedLogEntry
public UserDefinedLogEntry createLogEntry(Category category, Item item, java.lang.String entry) throws PIMInternalException, PIMAuthorizationException
category
- -
the Category for which to create a UserDefinedLogEntryitem
- -
the Item for which to create a UserDefinedLogEntryentry
- -
the name for the UserDefinedLogEntry to be created
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationCategory
,
Item
public PIMCollection getLogEntries() throws PIMInternalException, PIMAuthorizationException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationfor more info
,
UserDefinedLogEntry
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |