/**
 *
 * Copyright
 * 2009-2015 Jayway Products AB
 * 2016-2017 Föreningen Sambruk
 *
 * Licensed under AGPL, Version 3.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.gnu.org/licenses/agpl.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package se.streamsource.streamflow.web.domain;

import org.qi4j.api.common.Optional;
import org.qi4j.api.common.UseDefaults;
import org.qi4j.api.mixin.Mixins;
import org.qi4j.api.property.Property;

import se.streamsource.streamflow.infrastructure.event.domain.DomainEvent;

/**
 * Role for maintaining descriptions of entities.
 */
@Mixins(Describable.Mixin.class)
public interface Describable
{
   void changeDescription( @Optional String newDescription );

   String getDescription();

   interface Data
   {
      @UseDefaults @Optional
      Property<String> description();

      void changedDescription( @Optional DomainEvent event, @Optional String description );
   }

   public abstract class Mixin
         implements Describable, Data
   {
      public void changeDescription( String newDescription )
      {
         if ( (description().get() != null && !description().get().equals( newDescription ) ) ||
               (description().get() == null && newDescription != null ) )
         {
            changedDescription( null, newDescription );
         }
      }

      public String getDescription()
      {
         return description().get();
      }

      // State

      public void changedDescription( @Optional DomainEvent event, @Optional String description )
      {
         description().set( description );
      }
   }
}