blob: 9987d678faa9a97be3fc5c24a945afaa9f1f1bab [file] [log] [blame]
Phaneendra Manda1c0061d2015-08-06 12:29:38 +05301package org.onosproject.pcepio.protocol;
2
3import org.jboss.netty.buffer.ChannelBuffer;
4import org.onosproject.pcepio.types.ErrorObjListWithOpen;
5
6/**
7 * Abstraction of an entity providing PCEP Error Message.
8 */
9public interface PcepErrorMsg extends PcepMessage {
10
11 @Override
12 PcepVersion getVersion();
13
14 @Override
15 PcepType getType();
16
17 /**
18 * Returns Object of ErrorObjListWithOpen.
19 *
20 * @return Object of ErrorObjListWithOpen
21 */
22 public ErrorObjListWithOpen getErrorObjListWithOpen();
23
24 /**
25 * Sets errObjListWithOpen object.
26 *
27 * @param errObjListWithOpen error object List with open object
28 */
29 public void setErrorObjListWithOpen(ErrorObjListWithOpen errObjListWithOpen);
30
31 /**
32 * Returns Object of PcepErrorInfo.
33 *
34 * @return Object of PcepErrorInfo
35 */
36 public PcepErrorInfo getPcepErrorInfo();
37
38 /**
39 * Sets errInfo Object.
40 *
41 * @param errInfo error information
42 */
43 public void setPcepErrorInfo(PcepErrorInfo errInfo);
44
45 @Override
46 void writeTo(ChannelBuffer channelBuffer);
47
48 /**
49 * Builder interface with get and set functions to build PCEP Error message.
50 */
51 public interface Builder extends PcepMessage.Builder {
52
53 @Override
54 PcepErrorMsg build();
55
56 @Override
57 PcepVersion getVersion();
58
59 @Override
60 PcepType getType();
61
62 /**
63 * Returns Object of ErrorObjListWithOpen.
64 *
65 * @return Object of ErrorObjListWithOpen
66 */
67 public ErrorObjListWithOpen getErrorObjListWithOpen();
68
69 /**
70 * Sets errObjListWithOpen object.
71 *
72 * @param errObjListWithOpen error object with open object
73 * @return builder by setting Object of ErrorObjListWithOpen
74 */
75 public Builder setErrorObjListWithOpen(ErrorObjListWithOpen errObjListWithOpen);
76
77 /**
78 * Returns Object of PcepErrorInfo.
79 *
80 * @return Object of PcepErrorInfo
81 */
82 public PcepErrorInfo getPcepErrorInfo();
83
84 /**
85 * Sets errInfo Object.
86 *
87 * @param errInfo error information
88 * @return builder by getting Object of PcepErrorInfo
89 */
90 public Builder setPcepErrorInfo(PcepErrorInfo errInfo);
91 }
92}