01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: */
18: package org.apache.lenya.inbox;
19:
20: import org.apache.lenya.notification.Message;
21:
22: /**
23: * A message entry in an inbox.
24: */
25: public interface InboxMessage {
26:
27: /**
28: * Marks this message as read.
29: * @param marked A boolean value.
30: */
31: void markAsRead(boolean marked);
32:
33: /**
34: * @return if this message is marked as read.
35: */
36: boolean isMarkedAsRead();
37:
38: /**
39: * @return The message which is wrapped by this inbox message.
40: */
41: Message getMessage();
42:
43: /**
44: * @return The ID of this message.
45: */
46: String getId();
47:
48: }
|