001: /*
002: * File: roMetadataReplace.java
003: * Project: jMOS, com.aranova.java.jmos.messages.profile2
004: * Revision: 0.9.1
005: * Date: 18-ene-2006 10:15:40
006: *
007: * Copyright (C) Aragón Innovación Tecnológica S.L.L.
008: * All rights reserved.
009: *
010: * This software is distributed under the terms of the Aranova License version 1.0.
011: * See the terms of the Aranova License in the documentation provided with this software.
012: */
013:
014: package com.aranova.java.jmos.messages.profile2;
015:
016: import java.sql.Time;
017: import java.util.Date;
018: import java.util.LinkedHashSet;
019: import java.util.Set;
020:
021: import com.aranova.java.jmos.annotations.MOSAttribute;
022: import com.aranova.java.jmos.annotations.MOSMessage;
023: import com.aranova.java.jmos.enums.TypeModifier;
024: import com.aranova.java.jmos.enums.TypePort;
025: import com.aranova.java.jmos.messages.Message;
026: import com.aranova.java.jmos.messages.profile.mosExternalMetadata;
027:
028: /**
029: * Profile 2 - Replace RO metadata without deleting the RO structure.<BR>
030: * <b>Purpose</b><BR>
031: * This message allows metadata associated with a running order to be replaced without deleting the running order and sending the entire running order again..<BR>
032: * <b>Behavior</b><BR>
033: * This message must reference an existing running order<BR>
034: * If metadata tags in the roMetadataReplace message already exist in the target RO, values within the RO will be replaced by the values in the roMetadataReplace message.<BR>
035: * If the metadata tags do not already exist in the target RO they will be added.<BR>
036: * If a mosExternalMetadata block is included in the roMetadataReplace message, it will replace an existing mosExternalMetadata block only if the values of mosSchema in the two blocks match. Otherwise the mosExternalMetadata block will be added to the target RO.<BR>
037: * If the ROID in the roMetadataReplace message does not match an existing ROID then no action will be taken and the roMetadataReplace message will be replied to with an roAck message which carrying a status value of “NACK.�<BR>
038: * <b>Response</b><BR>
039: * {@link roAck roAck}<BR>
040: * <b>Port</b><BR>
041: * MOS Upper Port (10541) - Running Order<BR>
042: *
043: * @author <a href="http://www.aranova.net/contactar/">Daniel Sánchez</a>
044: * @version 0.9.1
045: * @since 0.9.1
046: */
047: @MOSMessage(name="roMetadataReplace",profile=2,port=TypePort.UpperPort,response=roAck.class)
048: public class roMetadataReplace extends Message {
049: @MOSAttribute(name="roID",maxLength=128)
050: private String _roID;
051: @MOSAttribute(name="roSlug",maxLength=128)
052: private String _roSlug;
053: @MOSAttribute(name="roChannel",maxLength=128,modifier=TypeModifier.Optional)
054: private String _roChannel;
055: @MOSAttribute(name="roEdStart",modifier=TypeModifier.Optional)
056: private Date _roEdStart;
057: @MOSAttribute(name="roEdDur",modifier=TypeModifier.Optional)
058: private Time _roEdDur;
059: @MOSAttribute(name="roTrigger",maxLength=128,modifier=TypeModifier.Optional)
060: private String _roTrigger;
061: @MOSAttribute(name="macroIn",maxLength=128,modifier=TypeModifier.Optional)
062: private String _macroIn;
063: @MOSAttribute(name="macroOut",maxLength=128,modifier=TypeModifier.Optional)
064: private String _macroOut;
065: @MOSAttribute(name="mosExternalMetadata",modifier=TypeModifier.ZeroOrMore,writeTag=false)
066: private Set<mosExternalMetadata> _mosExternalMetadata = new LinkedHashSet<mosExternalMetadata>();
067:
068: /**
069: * @return Returns the macroIn.
070: */
071: public String getMacroIn() {
072: return _macroIn;
073: }
074:
075: /**
076: * @param macroIn The macroIn to set.
077: */
078: public void setMacroIn(final String macroIn) {
079: _macroIn = macroIn;
080: }
081:
082: /**
083: * @return Returns the macroOut.
084: */
085: public String getMacroOut() {
086: return _macroOut;
087: }
088:
089: /**
090: * @param macroOut The macroOut to set.
091: */
092: public void setMacroOut(final String macroOut) {
093: _macroOut = macroOut;
094: }
095:
096: /**
097: * @return Returns the roChannel.
098: */
099: public String getRoChannel() {
100: return _roChannel;
101: }
102:
103: /**
104: * @param roChannel The roChannel to set.
105: */
106: public void setRoChannel(final String roChannel) {
107: _roChannel = roChannel;
108: }
109:
110: /**
111: * @return Returns the roEdDur.
112: */
113: public Time getRoEdDur() {
114: return _roEdDur;
115: }
116:
117: /**
118: * @param roEdDur The roEdDur to set.
119: */
120: public void setRoEdDur(final Time roEdDur) {
121: _roEdDur = roEdDur;
122: }
123:
124: /**
125: * @return Returns the roEdStart.
126: */
127: public Date getRoEdStart() {
128: return _roEdStart;
129: }
130:
131: /**
132: * @param roEdStart The roEdStart to set.
133: */
134: public void setRoEdStart(final Date roEdStart) {
135: _roEdStart = roEdStart;
136: }
137:
138: /**
139: * @return Returns the roID.
140: */
141: public String getRoID() {
142: return _roID;
143: }
144:
145: /**
146: * @param roID The roID to set.
147: */
148: public void setRoID(final String roID) {
149: _roID = roID;
150: }
151:
152: /**
153: * @return Returns the roSlug.
154: */
155: public String getRoSlug() {
156: return _roSlug;
157: }
158:
159: /**
160: * @param roSlug The roSlug to set.
161: */
162: public void setRoSlug(final String roSlug) {
163: _roSlug = roSlug;
164: }
165:
166: /**
167: * @return Returns the roTrigger.
168: */
169: public String getRoTrigger() {
170: return _roTrigger;
171: }
172:
173: /**
174: * @param roTrigger The roTrigger to set.
175: */
176: public void setRoTrigger(final String roTrigger) {
177: _roTrigger = roTrigger;
178: }
179:
180: /**
181: * @return Returns the mosExternalMetadata.
182: */
183: public Set<mosExternalMetadata> getMosExternalMetadata() {
184: return _mosExternalMetadata;
185: }
186: }
|