OlogClient (Olog API 2.2.7-SNAPSHOT API)

All Known Implementing Classes:

OlogClientImpl
```
public interface OlogClient
```
TODO: replace the usage of Xml* types with log,tag,logbooks

Author:

Eric Berryman taken from shroffk

Method Summary

Methods
Modifier and Type	Method and Description
`Attachment`	`add(File local, Long logId)`
`void`	`delete(Collection<Log> logs)` Remove the log collection identified by `log`
`void`	`delete(LogbookBuilder logbook, Collection<Long> logIds)` Remove the logbook `logbook` from the set of logs `logIds`
`void`	`delete(LogbookBuilder logbook, Long logId)` Remove logbook `logbook` from the log with name `logName`
`void`	`delete(LogBuilder log)` Remove the log identified by `log`
`void`	`delete(Long logId)` Remove the log identified by `log`
`void`	`delete(PropertyBuilder property, Collection<Long> logIds)` Remove the property `property` from the set of logs `logIds`
`void`	`delete(PropertyBuilder property, Long logId)` Remove property `property` from the log with id `logId` TODO: Should this be it's own service?
`void`	`delete(String fileName, Long logId)` Remove file attachment from log `logId TODO: sardine delete hangs up, using jersey for delete`
`void`	`delete(TagBuilder tag, Collection<Long> logIds)` Remove the tag `tag` from all the logs `logNames`
`void`	`delete(TagBuilder tag, Long logId)` Remove tag `tag` from the log with the id `logId`
`void`	`deleteLogbook(String logbook)`
`void`	`deleteProperty(String property)` Delete the property with name `property`
`void`	`deleteTag(String tag)` Remove {tag} from all logs
`Log`	`findLogById(Long logId)` Deprecated.
`Collection<Log>`	`findLogs(Map<String,String> map)` Query for logs based on the criteria specified in the map
`Collection<Log>`	`findLogs(javax.ws.rs.core.MultivaluedMap<String,String> map)` Multivalued map used to search for a key with multiple values.
`Collection<Log>`	`findLogsByLogbook(String logbook)` This function is a subset of queryLogs - should it be removed??
`Collection<Log>`	`findLogsByProperty(String propertyName)`
`Collection<Log>`	`findLogsByProperty(String propertyName, String attributeName, String attributeValue)` This function is a subset of queryLogs should it be removed??
`Collection<Log>`	`findLogsBySearch(String pattern)`
`Collection<Log>`	`findLogsByTag(String pattern)`
`InputStream`	`getAttachment(Long logId, Attachment attachment)`
`Log`	`getLog(Long logId)` Returns a log that exactly matches the logId `logId`
`Property`	`getProperty(String property)` return the complete property `property`
`Collection<Attachment>`	`listAttachments(Long logId)` Returns a collection of attachments that matches the logId `logId`
`Collection<String>`	`listAttributes(String propertyName)` List all the active attributes associated with the property `propertyName` property must exist, name != null
`Collection<Level>`	`listLevels()` Get a list of all the levels currently existing
`Collection<Logbook>`	`listLogbooks()` Get a list of all the logbooks currently existings
`Collection<Log>`	`listLogs()` Return all the logs.
`Collection<Property>`	`listProperties()` Get a list of all the Properties currently existing
`Collection<Tag>`	`listTags()` Get a list of all the tags currently existing
`Collection<Log>`	`set(Collection<LogBuilder> logs)` Deprecated.
`Logbook`	`set(LogbookBuilder logbookBuilder)` Set a new logbook `logbook` with no associated logs.
`Logbook`	`set(LogbookBuilder logbook, Collection<Long> logIds)` Set Logbook `logbook` to the logs `logIds` and remove it from all other logs TODO: all logids should exist, no nulls, check transaction
`Log`	`set(LogBuilder log)` Set a single log `log`, if the log already exists it is replaced.
`Property`	`set(PropertyBuilder property)` Create or replace property `property` TODO: test creation of a new property, test changing this property, test old log entries still have old property structure
`Tag`	`set(TagBuilder tag)` Set a Tag `tag` with no associated logs to the database.
`Tag`	`set(TagBuilder tag, Collection<Long> logIds)` Set tag `tag` on the set of logs `logIds` and remove it from all others TODO: all logIds should exist/ service should do proper transactions.
`Collection<Log>`	`update(Collection<LogBuilder> logs)` Update a set of logs
`Logbook`	`update(LogbookBuilder logbook, Collection<Long> logIds)` TODO: transaction check
`Logbook`	`update(LogbookBuilder logbook, Long logId)` Add Logbook `logbook` to the log `logId`
`Log`	`update(LogBuilder log)` Update a log entry `log`
`Property`	`update(PropertyBuilder property)` Update an existing property, TODO: check non destructive nature, old attributes should not be touched.
`Log`	`update(PropertyBuilder property, Long logId)` Update Property `property` by adding it to Log with id `logId` TODO : service invalid payload, need attribute and value
`Tag`	`update(TagBuilder tag, Collection<Long> logIds)` Update the Tag `tag` by adding it to the set of the logs with ids `logIds` TODO: Transactional nature,
`Tag`	`update(TagBuilder tag, Long logId)` Update Tag `tag` by adding it to Log with name `logName` TODO: logid valid.

- Method Detail
  - listLogbooks
```
Collection<Logbook> listLogbooks()
                                 throws OlogException
```
    Get a list of all the logbooks currently existings
    
    Returns:
    string collection of logbooks
    
    Throws:
    
    OlogException
  - listTags
```
Collection<Tag> listTags()
                         throws OlogException
```
    Get a list of all the tags currently existing
    
    Returns:
    string collection of tags
    
    Throws:
    
    OlogException
  - listProperties
```
Collection<Property> listProperties()
                                    throws OlogException
```
    Get a list of all the Properties currently existing
    
    Returns:
    
    Throws:
    
    OlogException
  - listAttributes
```
Collection<String> listAttributes(String propertyName)
                                  throws OlogException
```
    List all the active attributes associated with the property propertyName property must exist, name != null
    
    Parameters:
    propertyName -
    
    Returns:
    
    Throws:
    
    OlogException
  - listLevels
```
Collection<Level> listLevels()
                             throws OlogException
```
    Get a list of all the levels currently existing
    
    Returns:
    string collection of levels
    
    Throws:
    
    OlogException
  - listLogs
```
Collection<Log> listLogs()
```
    Return all the logs. ***Warning can return a lot of data***
    
    Returns:
    Collection of all log entires
    
    Throws:
    
    OlogException
  - getLog
```
Log getLog(Long logId)
           throws OlogException
```
    Returns a log that exactly matches the logId logId
    
    Parameters:
    logId - log id
    
    Returns:
    Log object
    
    Throws:
    
    OlogException
  - listAttachments
```
Collection<Attachment> listAttachments(Long logId)
                                       throws OlogException
```
    Returns a collection of attachments that matches the logId logId
    
    Parameters:
    logId - log id
    
    Returns:
    attachments collection object
    
    Throws:
    
    OlogException
  - getAttachment
```
InputStream getAttachment(Long logId,
                        Attachment attachment)
```
  - getProperty
```
Property getProperty(String property)
                     throws OlogException
```
    return the complete property property
    
    Parameters:
    property -
    
    Returns:
    
    Throws:
    
    OlogException
  - set
```
Log set(LogBuilder log)
        throws OlogException
```
    Set a single log log, if the log already exists it is replaced. Destructive operation TODO: check validity of log entry represented by builder TODO: (shroffk) should there be anything returned? XXX: creating logs with same subject allowed?
    
    Parameters:
    log - the log to be added
    
    Throws:
    
    OlogException
  - set
```
@Deprecated
Collection<Log> set(Collection<LogBuilder> logs)
                    throws OlogException
```
    Deprecated.
    
    Set a set of logs Destructive operation. TODO: (shroffk) should anything be returned? and should be returned from the service?
    
    Parameters:
    logs - collection of logs to be added
    
    Throws:
    
    OlogException
  - set
```
Tag set(TagBuilder tag)
        throws OlogException
```
    Set a Tag tag with no associated logs to the database. TODO: validity check,
    
    Parameters:
    tag -
    
    Throws:
    
    OlogException
  - set
```
Tag set(TagBuilder tag,
      Collection<Long> logIds)
        throws OlogException
```
    Set tag tag on the set of logs logIds and remove it from all others TODO: all logIds should exist/ service should do proper transactions.
    
    Parameters:
    tag -
    logIds -
    
    Throws:
    
    OlogException
  - set
```
Logbook set(LogbookBuilder logbookBuilder)
            throws OlogException
```
    Set a new logbook logbook with no associated logs.
    
    Parameters:
    logbookBuilder -
    
    Throws:
    
    OlogException
  - set
```
Logbook set(LogbookBuilder logbook,
          Collection<Long> logIds)
            throws OlogException
```
    Set Logbook logbook to the logs logIds and remove it from all other logs TODO: all logids should exist, no nulls, check transaction
    
    Parameters:
    logbook - logbook builder
    logIds - log ids
    
    Throws:
    
    OlogException
  - set
```
Property set(PropertyBuilder property)
             throws OlogException
```
    Create or replace property property TODO: test creation of a new property, test changing this property, test old log entries still have old property structure
    
    Parameters:
    property -
    
    Returns:
    
    Throws:
    
    OlogException
  - update
```
Log update(LogBuilder log)
           throws OlogException
```
    Update a log entry log
    
    Parameters:
    log -
    
    Returns:
    the updated log entry
    
    Throws:
    
    OlogException
  - update
```
Collection<Log> update(Collection<LogBuilder> logs)
                       throws OlogException
```
    Update a set of logs
    
    Parameters:
    logs - set of logs to be added
    
    Throws:
    
    OlogException
  - update
```
Property update(PropertyBuilder property)
```
    Update an existing property, TODO: check non destructive nature, old attributes should not be touched. old entries should have old property.
    
    Parameters:
    property -
    
    Returns:
  - update
```
Tag update(TagBuilder tag,
         Long logId)
           throws OlogException
```
    Update Tag tag by adding it to Log with name logName TODO: logid valid.
    
    Parameters:
    tag - tag builder
    logId - log id the tag to be added
    
    Throws:
    
    OlogException
  - update
```
Tag update(TagBuilder tag,
         Collection<Long> logIds)
           throws OlogException
```
    Update the Tag tag by adding it to the set of the logs with ids logIds TODO: Transactional nature,
    
    Parameters:
    tag - tag builder
    logIds - collection of log ids
    
    Throws:
    
    OlogException
  - update
```
Logbook update(LogbookBuilder logbook,
             Long logId)
               throws OlogException
```
    Add Logbook logbook to the log logId
    
    Parameters:
    logbook - logbook builder
    logId - log id
    
    Throws:
    
    OlogException
  - update
```
Logbook update(LogbookBuilder logbook,
             Collection<Long> logIds)
               throws OlogException
```
    TODO: transaction check
    
    Parameters:
    logIds -
    logbook -
    
    Throws:
    
    OlogException
  - update
```
Log update(PropertyBuilder property,
         Long logId)
           throws OlogException
```
    Update Property property by adding it to Log with id logId TODO : service invalid payload, need attribute and value
    
    Parameters:
    property - property builder
    logId - log id the property to be added
    
    Throws:
    
    OlogException
  - add
```
Attachment add(File local,
             Long logId)
               throws OlogException
```
    Parameters:
    logId -
    local -
    
    Throws:
    
    OlogException
  - findLogById
```
@Deprecated
Log findLogById(Long logId)
                throws OlogException
```
    Deprecated.
    
    Parameters:
    logId -
    
    Returns:
    
    Throws:
    
    OlogException
  - findLogsBySearch
```
Collection<Log> findLogsBySearch(String pattern)
                                 throws OlogException
```
    Parameters:
    pattern -
    
    Returns:
    collection of Log objects
    
    Throws:
    
    OlogException
  - findLogsByTag
```
Collection<Log> findLogsByTag(String pattern)
                              throws OlogException
```
    Parameters:
    pattern -
    
    Returns:
    collection of Log objects
    
    Throws:
    
    OlogException
  - findLogsByLogbook
```
Collection<Log> findLogsByLogbook(String logbook)
                                  throws OlogException
```
    This function is a subset of queryLogs - should it be removed??
    TODO: add the usage of patterns and implement on top of the general query using the map
    
    Parameters:
    logbook - logbook name
    
    Returns:
    collection of Log objects
    
    Throws:
    
    OlogException
  - findLogsByProperty
```
Collection<Log> findLogsByProperty(String propertyName,
                                 String attributeName,
                                 String attributeValue)
                                   throws OlogException
```
    This function is a subset of queryLogs should it be removed??
    search for logs with property property and optionally value matching patternpropertyValue
    
    Parameters:
    property -
    
    Returns:
    
    Throws:
    
    OlogException
  - findLogsByProperty
```
Collection<Log> findLogsByProperty(String propertyName)
                                   throws OlogException
```
    Throws:
    
    OlogException
  - findLogs
```
Collection<Log> findLogs(Map<String,String> map)
                         throws OlogException
```
    Query for logs based on the criteria specified in the map
    
    Parameters:
    map -
    
    Returns:
    collection of Log objects
    
    Throws:
    
    OlogException
  - findLogs
```
Collection<Log> findLogs(javax.ws.rs.core.MultivaluedMap<String,String> map)
                         throws OlogException
```
    Multivalued map used to search for a key with multiple values. e.g. logbook a=1 or logbook a=2
    
    Parameters:
    map - Multivalue map for searching a key with multiple values
    
    Returns:
    collection of Log objects
    
    Throws:
    
    OlogException
  - deleteTag
```
void deleteTag(String tag)
               throws OlogException
```
    Remove {tag} from all logs
    
    Parameters:
    tag -
    
    Throws:
    
    OlogException
  - deleteLogbook
```
void deleteLogbook(String logbook)
                   throws OlogException
```
    Parameters:
    logbook -
    
    Throws:
    
    LogFinderException
    
    OlogException
  - deleteProperty
```
void deleteProperty(String property)
                    throws OlogException
```
    Delete the property with name property
    
    Parameters:
    property -
    
    Throws:
    
    OlogException
  - delete
```
void delete(LogBuilder log)
            throws OlogException
```
    Remove the log identified by log
    
    Parameters:
    log - log to be removed
    
    Throws:
    
    OlogException
  - delete
```
void delete(Long logId)
            throws OlogException
```
    Remove the log identified by log
    
    Parameters:
    logId - log id log id to be removed
    
    Throws:
    
    OlogException
  - delete
```
void delete(Collection<Log> logs)
            throws OlogException
```
    Remove the log collection identified by log
    
    Parameters:
    logs - logs to be removed
    
    Throws:
    
    OlogException
  - delete
```
void delete(TagBuilder tag,
          Long logId)
            throws OlogException
```
    Remove tag tag from the log with the id logId
    
    Parameters:
    tag -
    logId -
    
    Throws:
    
    OlogException
  - delete
```
void delete(TagBuilder tag,
          Collection<Long> logIds)
            throws OlogException
```
    Remove the tag tag from all the logs logNames
    
    Parameters:
    tag -
    logIds -
    
    Throws:
    
    OlogException
  - delete
```
void delete(LogbookBuilder logbook,
          Long logId)
            throws OlogException
```
    Remove logbook logbook from the log with name logName
    
    Parameters:
    logbook - logbook builder
    logId - log id
    
    Throws:
    
    OlogException
  - delete
```
void delete(LogbookBuilder logbook,
          Collection<Long> logIds)
            throws OlogException
```
    Remove the logbook logbook from the set of logs logIds
    
    Parameters:
    logbook -
    logIds -
    
    Throws:
    
    OlogException
  - delete
```
void delete(PropertyBuilder property,
          Long logId)
            throws OlogException
```
    Remove property property from the log with id logId TODO: Should this be it's own service?
    
    Parameters:
    property - property builder
    logId - log id
    
    Throws:
    
    OlogException
  - delete
```
void delete(PropertyBuilder property,
          Collection<Long> logIds)
            throws OlogException
```
    Remove the property property from the set of logs logIds
    
    Parameters:
    property -
    logIds -
    
    Throws:
    
    OlogException
  - delete
```
void delete(String fileName,
          Long logId)
            throws OlogException
```
    Remove file attachment from log logId TODO: sardine delete hangs up, using jersey for delete
    Parameters: String - fileName Long - logId Throws: OlogException

Interface OlogClient

Method Summary

Method Detail

listLogbooks

listTags

listProperties

listAttributes

listLevels

listLogs

getLog

listAttachments

getAttachment

getProperty

set

set

set

set

set

set

set

update

update

update

update

update

update

update

update

add

findLogById

findLogsBySearch

findLogsByTag

findLogsByLogbook

findLogsByProperty

findLogsByProperty

findLogs

findLogs

deleteTag

deleteLogbook

deleteProperty

delete

delete

delete

delete

delete

delete

delete

delete

delete

delete