# Uses of Interface
com.documentum.fc.client.mq.IDfMessage

Packages that use IDfMessage
Package
Description
com.documentum.fc.client.mq

- ## Uses of IDfMessage in com.documentum.fc.client.mq

  Methods in com.documentum.fc.client.mq that return IDfMessage
  Modifier and Type
  Method
  Description
  `IDfMessage`
  IDfMessageQueue.`acquireNext()`
  Returns the next ready message with the highest priority and the earliest creation_time, sets the message to 'acquired' state.
  `IDfMessage`
  IDfMessageQueue.`acquireNext(String recipient)`
  Returns the next available ready message with the highest priority and earliest creation time that is addressed the specified recipient.
  `IDfMessage`
  IDfMessageQueue.`createMessage()`
  Creates a message object that implements IDfMessage.
  `IDfMessage`
  IDfMessageQueue.`get(IDfId msgId)`
  Returns the message for the given message id.
  Methods in com.documentum.fc.client.mq that return types with arguments of type IDfMessage
  Modifier and Type
  Method
  Description
  `Collection<IDfMessage>`
  IDfMessageQueue.`acquireNextBatch(int batchSize)`
  Returns as a collection the next upto `count` ready messages with the highest priority and earliest creation_time, sets their state to 'acquired'.
  `Collection<IDfMessage>`
  IDfMessageQueue.`acquireNextBatch(int batchSize, String recipient)`
  Returns as a collection the next upto `count` ready message whose recipient matches the specified message recipient, sets their state to 'acquired'.
  `Collection<IDfMessage>`
  IDfMessageQueue.`get(int state)`
  Returns as a collection all the messages in the given state. if any, `null` otherwise
  `Collection<IDfMessage>`
  IDfMessageQueue.`get(String predicate)`
  Returns as a collection all the messages that satisfy the specified predicates.
  Methods in com.documentum.fc.client.mq with parameters of type IDfMessage
  Modifier and Type
  Method
  Description
  `void`
  IDfMessageQueue.`acknowledge(IDfMessage message, boolean success, String description)`
  Acknoeledges to message queue the delivery status of the specified message.
  `void`
  IDfMessageQueue.`save(IDfMessage msg)`
  Adds a message to the queue.
  Method parameters in com.documentum.fc.client.mq with type arguments of type IDfMessage
  Modifier and Type
  Method
  Description
  `void`
  IDfMessageQueue.`acknowledge(Collection<IDfMessage> messages, boolean success, String description)`
  Acknowledges to message server the delivery status of the specified message.