Interface to the ELisA logbook database.
Retrieves the attachment with the given ID for the given message ID.
This method interacts with the ELisA logbook to retrieve the attachment with the given ID for the given message ID.
The validity of this criteria is realized at the server side.
Users are encourage to use getAttachments() since it does not imply knowing IDs.
msgId: message ID of the attachment to retrieve. attachmentId: the attachment ID Returns: the attachment. Throws: ElisaError if accessing the logbook fails.
Retrieves all the attachments for a logbook message.
This method interacts with the ELisA logbook to retrieve all the attachments for the message in the arguments. The validity of this criteria is realized at the server side.
message: object of type MessageRead with the attachment to retrieve. Returns: a list of tuples with the id, name and content of the attachments. Throws: ElisaError if accessing the logbook fails.
Retrieves the logbook message with the given ID.
This method interacts with the ELisA logbook to retrieve the message with the associated ID given in the argument. The validity of this criteria is realized at the server side.
msgId: the message ID. Returns: an object of type MessageRead encapsulating the message
with the given ID.
Throws: ElisaError if accessing the logbook fails.
Retrieves the possible message types or the options for a message type is specified in the argument.
msgType: a message type. Returns: a list of message types or a dictionary with the options
associated to a specific type.
Throws: ElisaError if accessing the logbook fails.
Retrieves the possible systems affected or the predefined systems affected for a given message type if that type is specified in the argument.
msgType: a message type. Returns: a list of possible systems affected or a list of
predefined systems affected for a given message type.
Throws: ElisaError if accessing the logbook fails.
Inserts a logbook message into the ELisA back-end database.
Inserts in the ELisA logbook back-end database the message encapsulated in the ‘message’ argument. The type of this argument must be MessageWrite. The message consistency check is realized at the server side. The expected message type
message: object of type MessageWrite to be inserted into the database. Returns: an object of type MessageRead encapsulating the message
inserted into the database.
Throws: ElisaError if accessing the logbook fails.
Replies to a logbook message.
Inserts the reply message encapsulated in the ‘message’ argument. The type of this argument must be MessageReply. The message consistency check is realized at the server side.
Throws: ElisaError if the reply message could not be inserted.
Retrieves the logbook messages that match the given search criteria.
This method interacts with the ELisA logbook to retrieve those messages that match the search criteria defined in the ‘criteria’ argument. The validity of this criteria is realized at the server side.
Throws: ElisaError if accessing the logbook fails.
Updates a logbook message.
Inserts the updated message encapsulated in the ‘message’ argument. The type of this argument must be MessageUpdate. The message consistency check is realized at the server side.
message: object of type MessageUpdate to be inserted into the database. Returns: an object of type MessageRead encapsulating the message
updated into the database.
Throws: ElisaError if updating the message fails.
Bases: src.core.message.Message
Class providing accessors for the read operation.
Message ID field.
Message logbook field.
Message user name field.
Message author field.
Message date field.
Message subject field.
Message type field.
Message options field.
Message systems affected field.
Message body field.
Message host field.
Message has replies field.
Message reply to field.
Message has attachments field.
Message attachments field.
Message status field.
Message thread head field.
Message valid field.
Message encoding field.
Bases: src.messageReply.MessageReply
Class providing accessors for the insert operation.
Message author field.
Message subject field.
Message type field.
Message options field.
Message systems affected field.
Message body field.
Message attachments field.
Message status field.
Bases: src.messageUpdate.MessageUpdate
Class providing accessors for the reply operation.
Message author field.
Message subject field.
Message options field.
Message systems affected field.
Message body field.
Message attachments field.
Message status field.
Bases: src.messageRead.MessageRead
Class providing accessors for the update operation.
Message body field.
Message attachments field.
Bases: object
Class providing functionality to build the options fields.
Creates an option, adds it to this option’s level and returns it.
name: name of this option. value: value of this option. Returns: an object of type Option.
Returns a list of options that can be used to insert a message.
Returns: a list with the options encapsulated as dictionaries.
Bases: object
Class representing a search criteria.
This class provides all the fields required to form a search criteria to retrieve logbook messages from the ELisA database.
Filter results per author.
Filter results per body.
Returns a dictionary of fieldName:fieldValue
Month interval.
Number of entries returned (100 by default).
Filter results per options.
Page number for results pagination.
Initial search date.
Filter results per status.
Filter results per subject.
Filter results per systems affected.
Filter results per type.
End search date.
Filter results per user name.
Bases: src.exception.ElisaError
Exception thrown when an argument is wrongly passed to the API
Bases: exceptions.Exception
Base exception.
Bases: src.exception.ElisaError
Elisa exception thrown when an argument is wrongly passed to the API
Bases: src.exception.ElisaError
Exception thrown when an error occurs whilst accessing the rest server.
Bases: src.exception.RestServerError
Exception thrown when the SSO authentications fails.