001    /*
002     * The MIT License
003     * Copyright (c) 2012 Microsoft Corporation
004     *
005     * Permission is hereby granted, free of charge, to any person obtaining a copy
006     * of this software and associated documentation files (the "Software"), to deal
007     * in the Software without restriction, including without limitation the rights
008     * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
009     * copies of the Software, and to permit persons to whom the Software is
010     * furnished to do so, subject to the following conditions:
011     *
012     * The above copyright notice and this permission notice shall be included in
013     * all copies or substantial portions of the Software.
014     *
015     * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
016     * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
017     * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
018     * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
019     * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
020     * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
021     * THE SOFTWARE.
022     */
023    
024    package microsoft.exchange.webservices.data.property.complex;
025    
026    import microsoft.exchange.webservices.data.core.EwsServiceXmlWriter;
027    import microsoft.exchange.webservices.data.core.EwsUtilities;
028    import microsoft.exchange.webservices.data.core.XmlElementNames;
029    
030    /**
031     * Represents an operation to create a new rule.
032     */
033    public final class CreateRuleOperation extends RuleOperation {
034    
035    
036      /**
037       * Inbox rule to be created.
038       */
039      private Rule rule;
040    
041      /**
042       * Initializes a new instance of the
043       * <see cref="CreateRuleOperation"/> class.
044       */
045      public CreateRuleOperation() {
046        super();
047      }
048    
049      /**
050       * Initializes a new instance of the
051       * <see cref="CreateRuleOperation"/> class.
052       *
053       * @param rule The inbox rule to create.
054       */
055      public CreateRuleOperation(Rule rule) {
056        super();
057        this.rule = rule;
058      }
059    
060      /**
061       * Gets or sets the rule to be created.
062       */
063      public Rule getRule() {
064    
065        return this.rule;
066      }
067    
068      public void setRule(Rule value) {
069    
070        if (this.canSetFieldValue(this.rule, value)) {
071          this.rule = value;
072          this.changed();
073    
074        }
075      }
076    
077      /**
078       * Writes elements to XML.
079       *
080       * @param writer The writer.
081       * @throws Exception
082       */
083      @Override
084      public void writeElementsToXml(EwsServiceXmlWriter writer)
085          throws Exception {
086        this.getRule().writeToXml(writer, XmlElementNames.Rule);
087      }
088    
089      /**
090       * Validates this instance.
091       *
092       * @throws Exception
093       */
094      @Override
095      protected void internalValidate() throws Exception {
096        EwsUtilities.validateParam(this.rule, "Rule");
097      }
098    
099      /**
100       * Gets the Xml element name of the CreateRuleOperation object.
101       */
102      @Override public String getXmlElementName() {
103    
104        return XmlElementNames.CreateRuleOperation;
105      }
106    
107    }